@connectedxm/admin-sdk 11.9.1 → 11.10.0

package/dist/esm/api.js

@@ -4,7 +4,7 @@
  * Connected Admin API
  * The Admin API allows you to manage your Connected community programmatically.
  *
- * The version of the OpenAPI document: 11.9.1
+ * The version of the OpenAPI document: 11.10.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2047,6 +2047,10 @@ export var ImageType;
     ImageType["Event"] = "event";
     ImageType["Activation"] = "activation";
 })(ImageType || (ImageType = {}));
+export var ImportEventPassAttributes200ResponseStatusEnum;
+(function (ImportEventPassAttributes200ResponseStatusEnum) {
+    ImportEventPassAttributes200ResponseStatusEnum["Ok"] = "ok";
+})(ImportEventPassAttributes200ResponseStatusEnum || (ImportEventPassAttributes200ResponseStatusEnum = {}));
 export var ImportItemStatus;
 (function (ImportItemStatus) {
     ImportItemStatus["Pending"] = "pending";
@@ -2338,6 +2342,11 @@ export var PageType;
     PageType["Terms"] = "terms";
     PageType["Team"] = "team";
 })(PageType || (PageType = {}));
+export var PassAttributeImportResultStatusEnum;
+(function (PassAttributeImportResultStatusEnum) {
+    PassAttributeImportResultStatusEnum["Resolved"] = "resolved";
+    PassAttributeImportResultStatusEnum["Invalid"] = "invalid";
+})(PassAttributeImportResultStatusEnum || (PassAttributeImportResultStatusEnum = {}));
 export var PassChangeLogType;
 (function (PassChangeLogType) {
     PassChangeLogType["Status"] = "status";
@@ -42529,6 +42538,45 @@ export const EventsPassesAttributesApiAxiosParamCreator = function (configuratio
                 options: localVarRequestOptions,
             };
         }),
+        /**
+         * 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.
+         * @summary Bulk set custom attribute values across many passes
+         * @param {string} eventId The event identifier
+         * @param {PassAttributesImportInputs} passAttributesImportInputs
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        importEventPassAttributes: (eventId_1, passAttributesImportInputs_1, ...args_1) => __awaiter(this, [eventId_1, passAttributesImportInputs_1, ...args_1], void 0, function* (eventId, passAttributesImportInputs, options = {}) {
+            // verify required parameter 'eventId' is not null or undefined
+            assertParamExists('importEventPassAttributes', 'eventId', eventId);
+            // verify required parameter 'passAttributesImportInputs' is not null or undefined
+            assertParamExists('importEventPassAttributes', 'passAttributesImportInputs', passAttributesImportInputs);
+            const localVarPath = `/events/{eventId}/passes/attributes/import`
+                .replace('{eventId}', encodeURIComponent(String(eventId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication ApiKeyAuth required
+            yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
+            // authentication OrganizationId required
+            yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            localVarHeaderParameter['Accept'] = 'application/json';
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            localVarRequestOptions.data = serializeDataIfNeeded(passAttributesImportInputs, localVarRequestOptions, configuration);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
         /**
          * 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.
          * @summary Remove a custom attribute from a pass
@@ -42643,6 +42691,23 @@ export const EventsPassesAttributesApiFp = function (configuration) {
                 return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
             });
         },
+        /**
+         * 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.
+         * @summary Bulk set custom attribute values across many passes
+         * @param {string} eventId The event identifier
+         * @param {PassAttributesImportInputs} passAttributesImportInputs
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        importEventPassAttributes(eventId, passAttributesImportInputs, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.importEventPassAttributes(eventId, passAttributesImportInputs, options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = operationServerMap['EventsPassesAttributesApi.importEventPassAttributes']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
         /**
          * 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.
          * @summary Remove a custom attribute from a pass
@@ -42697,6 +42762,16 @@ export const EventsPassesAttributesApiFactory = function (configuration, basePat
         getEventPassAttributes(requestParameters, options) {
             return localVarFp.getEventPassAttributes(requestParameters.eventId, requestParameters.passId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
         },
+        /**
+         * 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.
+         * @summary Bulk set custom attribute values across many passes
+         * @param {EventsPassesAttributesApiImportEventPassAttributesRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        importEventPassAttributes(requestParameters, options) {
+            return localVarFp.importEventPassAttributes(requestParameters.eventId, requestParameters.passAttributesImportInputs, options).then((request) => request(axios, basePath));
+        },
         /**
          * 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.
          * @summary Remove a custom attribute from a pass
@@ -42733,6 +42808,16 @@ export class EventsPassesAttributesApi extends BaseAPI {
     getEventPassAttributes(requestParameters, options) {
         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));
     }
+    /**
+     * 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.
+     * @summary Bulk set custom attribute values across many passes
+     * @param {EventsPassesAttributesApiImportEventPassAttributesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    importEventPassAttributes(requestParameters, options) {
+        return EventsPassesAttributesApiFp(this.configuration).importEventPassAttributes(requestParameters.eventId, requestParameters.passAttributesImportInputs, options).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * 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.
      * @summary Remove a custom attribute from a pass

package/dist/esm/base.d.ts

@@ -2,7 +2,7 @@
  * Connected Admin API
  * The Admin API allows you to manage your Connected community programmatically.
  *
- * The version of the OpenAPI document: 11.9.1
+ * The version of the OpenAPI document: 11.10.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/base.js

@@ -4,7 +4,7 @@
  * Connected Admin API
  * The Admin API allows you to manage your Connected community programmatically.
  *
- * The version of the OpenAPI document: 11.9.1
+ * The version of the OpenAPI document: 11.10.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/common.d.ts

@@ -2,7 +2,7 @@
  * Connected Admin API
  * The Admin API allows you to manage your Connected community programmatically.
  *
- * The version of the OpenAPI document: 11.9.1
+ * The version of the OpenAPI document: 11.10.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/common.js

@@ -4,7 +4,7 @@
  * Connected Admin API
  * The Admin API allows you to manage your Connected community programmatically.
  *
- * The version of the OpenAPI document: 11.9.1
+ * The version of the OpenAPI document: 11.10.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/configuration.d.ts

@@ -2,7 +2,7 @@
  * Connected Admin API
  * The Admin API allows you to manage your Connected community programmatically.
  *
- * The version of the OpenAPI document: 11.9.1
+ * The version of the OpenAPI document: 11.10.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/configuration.js

@@ -3,7 +3,7 @@
  * Connected Admin API
  * The Admin API allows you to manage your Connected community programmatically.
  *
- * The version of the OpenAPI document: 11.9.1
+ * The version of the OpenAPI document: 11.10.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/docs/EventsPassesAttributesApi.md

@@ -5,6 +5,7 @@ All URIs are relative to *https://admin-api.connected.dev*
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
 |[**getEventPassAttributes**](#geteventpassattributes) | **GET** /events/{eventId}/passes/{passId}/attributes | List an event pass\'s attributes|
+|[**importEventPassAttributes**](#importeventpassattributes) | **POST** /events/{eventId}/passes/attributes/import | Bulk set custom attribute values across many passes|
 |[**removeEventPassAttribute**](#removeeventpassattribute) | **DELETE** /events/{eventId}/passes/{passId}/attributes/{attributeId} | Remove a custom attribute from a pass|
 |[**updateEventPassAttributes**](#updateeventpassattributes) | **PUT** /events/{eventId}/passes/{passId}/attributes | Set custom attribute values on a pass|
 
@@ -67,6 +68,61 @@ const { status, data } = await apiInstance.getEventPassAttributes(
  - **Accept**: application/json
 
 
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful response |  -  |
+
+[[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)
+
+# **importEventPassAttributes**
+> ImportEventPassAttributes200Response importEventPassAttributes(passAttributesImportInputs)
+
+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.
+
+### Example
+
+```typescript
+import {
+    EventsPassesAttributesApi,
+    Configuration,
+    PassAttributesImportInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsPassesAttributesApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let passAttributesImportInputs: PassAttributesImportInputs; //
+
+const { status, data } = await apiInstance.importEventPassAttributes(
+    eventId,
+    passAttributesImportInputs
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **passAttributesImportInputs** | **PassAttributesImportInputs**|  | |
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+
+
+### Return type
+
+**ImportEventPassAttributes200Response**
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|

package/docs/ImportEventPassAttributes200Response.md

@@ -0,0 +1,24 @@
+# ImportEventPassAttributes200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **string** |  | [default to undefined]
+**message** | **string** |  | [default to undefined]
+**data** | [**PassAttributeImportSummary**](PassAttributeImportSummary.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { ImportEventPassAttributes200Response } from '@connectedxm/admin-sdk';
+
+const instance: ImportEventPassAttributes200Response = {
+    status,
+    message,
+    data,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/PassAttributeImportResult.md

@@ -0,0 +1,26 @@
+# PassAttributeImportResult
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**index** | **number** |  | [default to undefined]
+**passId** | **string** |  | [default to undefined]
+**status** | **string** |  | [default to undefined]
+**message** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { PassAttributeImportResult } from '@connectedxm/admin-sdk';
+
+const instance: PassAttributeImportResult = {
+    index,
+    passId,
+    status,
+    message,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/PassAttributeImportSummary.md

@@ -0,0 +1,26 @@
+# PassAttributeImportSummary
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**created** | **number** |  | [default to undefined]
+**updated** | **number** |  | [default to undefined]
+**unchanged** | **number** |  | [default to undefined]
+**results** | [**Array<PassAttributeImportResult>**](PassAttributeImportResult.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { PassAttributeImportSummary } from '@connectedxm/admin-sdk';
+
+const instance: PassAttributeImportSummary = {
+    created,
+    updated,
+    unchanged,
+    results,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/PassAttributesImportInputs.md

@@ -0,0 +1,20 @@
+# PassAttributesImportInputs
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**rows** | [**Array<PassAttributesImportInputsRowsInner>**](PassAttributesImportInputsRowsInner.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { PassAttributesImportInputs } from '@connectedxm/admin-sdk';
+
+const instance: PassAttributesImportInputs = {
+    rows,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/PassAttributesImportInputsRowsInner.md

@@ -0,0 +1,22 @@
+# PassAttributesImportInputsRowsInner
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**passId** | **string** |  | [default to undefined]
+**values** | [**Array<PassAttributesUpdateInputsValuesInner>**](PassAttributesUpdateInputsValuesInner.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { PassAttributesImportInputsRowsInner } from '@connectedxm/admin-sdk';
+
+const instance: PassAttributesImportInputsRowsInner = {
+    passId,
+    values,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@connectedxm/admin-sdk",
-  "version": "11.9.1",
+  "version": "11.10.0",
   "description": "OpenAPI client for @connectedxm/admin-sdk",
   "author": "OpenAPI-Generator Contributors",
   "repository": {