@connectedxm/admin-sdk 11.9.1 → 11.10.0

package/.openapi-generator/FILES

@@ -1120,6 +1120,7 @@ docs/ImageWCopyUri.md
 docs/Import.md
 docs/ImportAllOfCount.md
 docs/ImportCreateInputs.md
+docs/ImportEventPassAttributes200Response.md
 docs/ImportItem.md
 docs/ImportItemStatus.md
 docs/ImportRooms200Response.md
@@ -1284,6 +1285,10 @@ docs/OrganizationWebhooksApi.md
 docs/PageType.md
 docs/PassAddOn.md
 docs/PassAttribute.md
+docs/PassAttributeImportResult.md
+docs/PassAttributeImportSummary.md
+docs/PassAttributesImportInputs.md
+docs/PassAttributesImportInputsRowsInner.md
 docs/PassAttributesUpdateInputs.md
 docs/PassAttributesUpdateInputsValuesInner.md
 docs/PassChange.md

package/README.md

@@ -1,4 +1,4 @@
-## @connectedxm/admin-sdk@11.9.1
+## @connectedxm/admin-sdk@11.10.0
 
 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:
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
 _published:_
 
 ```
-npm install @connectedxm/admin-sdk@11.9.1 --save
+npm install @connectedxm/admin-sdk@11.10.0 --save
 ```
 
 _unPublished (not recommended):_

package/api.ts

@@ -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).
@@ -10831,6 +10831,16 @@ export interface ImportCreateInputs {
 }
 
 
+export interface ImportEventPassAttributes200Response {
+    'status': ImportEventPassAttributes200ResponseStatusEnum;
+    'message': string;
+    'data': PassAttributeImportSummary;
+}
+
+export enum ImportEventPassAttributes200ResponseStatusEnum {
+    Ok = 'ok'
+}
+
 export interface ImportItem {
     'id': string;
     'importId': string;
@@ -12383,6 +12393,31 @@ export interface PassAttribute {
     'createdAt': string;
     'updatedAt': string;
 }
+export interface PassAttributeImportResult {
+    'index': number;
+    'passId': string;
+    'status': PassAttributeImportResultStatusEnum;
+    'message': string | null;
+}
+
+export enum PassAttributeImportResultStatusEnum {
+    Resolved = 'resolved',
+    Invalid = 'invalid'
+}
+
+export interface PassAttributeImportSummary {
+    'created': number;
+    'updated': number;
+    'unchanged': number;
+    'results': Array<PassAttributeImportResult>;
+}
+export interface PassAttributesImportInputs {
+    'rows': Array<PassAttributesImportInputsRowsInner>;
+}
+export interface PassAttributesImportInputsRowsInner {
+    'passId': string;
+    'values': Array<PassAttributesUpdateInputsValuesInner>;
+}
 export interface PassAttributesUpdateInputs {
     'values': Array<PassAttributesUpdateInputsValuesInner>;
 }
@@ -67262,6 +67297,51 @@ 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: async (eventId: string, passAttributesImportInputs: PassAttributesImportInputs, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // 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 = { method: 'POST', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication ApiKeyAuth required
+            await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
+
+            // authentication OrganizationId required
+            await 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 = {...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
@@ -67386,6 +67466,20 @@ export const EventsPassesAttributesApiFp = function(configuration?: Configuratio
             const localVarOperationServerBasePath = operationServerMap['EventsPassesAttributesApi.getEventPassAttributes']?.[localVarOperationServerIndex]?.url;
             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}
+         */
+        async importEventPassAttributes(eventId: string, passAttributesImportInputs: PassAttributesImportInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ImportEventPassAttributes200Response>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.importEventPassAttributes(eventId, passAttributesImportInputs, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['EventsPassesAttributesApi.importEventPassAttributes']?.[localVarOperationServerIndex]?.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
@@ -67435,6 +67529,16 @@ export const EventsPassesAttributesApiFactory = function (configuration?: Config
         getEventPassAttributes(requestParameters: EventsPassesAttributesApiGetEventPassAttributesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetEventPassAttributes200Response> {
             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: EventsPassesAttributesApiImportEventPassAttributesRequest, options?: RawAxiosRequestConfig): AxiosPromise<ImportEventPassAttributes200Response> {
+            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
@@ -67493,6 +67597,18 @@ export interface EventsPassesAttributesApiGetEventPassAttributesRequest {
     readonly search?: string
 }
 
+/**
+ * Request parameters for importEventPassAttributes operation in EventsPassesAttributesApi.
+ */
+export interface EventsPassesAttributesApiImportEventPassAttributesRequest {
+    /**
+     * The event identifier
+     */
+    readonly eventId: string
+
+    readonly passAttributesImportInputs: PassAttributesImportInputs
+}
+
 /**
  * Request parameters for removeEventPassAttribute operation in EventsPassesAttributesApi.
  */
@@ -67545,6 +67661,17 @@ export class EventsPassesAttributesApi extends BaseAPI {
         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}
+     */
+    public importEventPassAttributes(requestParameters: EventsPassesAttributesApiImportEventPassAttributesRequest, options?: RawAxiosRequestConfig) {
+        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/base.ts

@@ -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/common.ts

@@ -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/configuration.ts

@@ -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/dist/api.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).
@@ -9561,6 +9561,14 @@ export interface ImportCreateInputs {
     'values'?: Array<AddEventAccessUserRequest> | null;
     'type'?: ImportType | null;
 }
+export interface ImportEventPassAttributes200Response {
+    'status': ImportEventPassAttributes200ResponseStatusEnum;
+    'message': string;
+    'data': PassAttributeImportSummary;
+}
+export declare enum ImportEventPassAttributes200ResponseStatusEnum {
+    Ok = "ok"
+}
 export interface ImportItem {
     'id': string;
     'importId': string;
@@ -10999,6 +11007,29 @@ export interface PassAttribute {
     'createdAt': string;
     'updatedAt': string;
 }
+export interface PassAttributeImportResult {
+    'index': number;
+    'passId': string;
+    'status': PassAttributeImportResultStatusEnum;
+    'message': string | null;
+}
+export declare enum PassAttributeImportResultStatusEnum {
+    Resolved = "resolved",
+    Invalid = "invalid"
+}
+export interface PassAttributeImportSummary {
+    'created': number;
+    'updated': number;
+    'unchanged': number;
+    'results': Array<PassAttributeImportResult>;
+}
+export interface PassAttributesImportInputs {
+    'rows': Array<PassAttributesImportInputsRowsInner>;
+}
+export interface PassAttributesImportInputsRowsInner {
+    'passId': string;
+    'values': Array<PassAttributesUpdateInputsValuesInner>;
+}
 export interface PassAttributesUpdateInputs {
     'values': Array<PassAttributesUpdateInputsValuesInner>;
 }
@@ -39951,6 +39982,15 @@ export declare const EventsPassesAttributesApiAxiosParamCreator: (configuration?
      * @throws {RequiredError}
      */
     getEventPassAttributes: (eventId: string, passId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * 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: string, passAttributesImportInputs: PassAttributesImportInputs, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * 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
@@ -39989,6 +40029,15 @@ export declare const EventsPassesAttributesApiFp: (configuration?: Configuration
      * @throws {RequiredError}
      */
     getEventPassAttributes(eventId: string, passId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetEventPassAttributes200Response>>;
+    /**
+     * 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: string, passAttributesImportInputs: PassAttributesImportInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ImportEventPassAttributes200Response>>;
     /**
      * 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
@@ -40022,6 +40071,14 @@ export declare const EventsPassesAttributesApiFactory: (configuration?: Configur
      * @throws {RequiredError}
      */
     getEventPassAttributes(requestParameters: EventsPassesAttributesApiGetEventPassAttributesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetEventPassAttributes200Response>;
+    /**
+     * 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: EventsPassesAttributesApiImportEventPassAttributesRequest, options?: RawAxiosRequestConfig): AxiosPromise<ImportEventPassAttributes200Response>;
     /**
      * 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
@@ -40068,6 +40125,16 @@ export interface EventsPassesAttributesApiGetEventPassAttributesRequest {
      */
     readonly search?: string;
 }
+/**
+ * Request parameters for importEventPassAttributes operation in EventsPassesAttributesApi.
+ */
+export interface EventsPassesAttributesApiImportEventPassAttributesRequest {
+    /**
+     * The event identifier
+     */
+    readonly eventId: string;
+    readonly passAttributesImportInputs: PassAttributesImportInputs;
+}
 /**
  * Request parameters for removeEventPassAttribute operation in EventsPassesAttributesApi.
  */
@@ -40111,6 +40178,14 @@ export declare class EventsPassesAttributesApi extends BaseAPI {
      * @throws {RequiredError}
      */
     getEventPassAttributes(requestParameters: EventsPassesAttributesApiGetEventPassAttributesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetEventPassAttributes200Response, any, {}, any>>;
+    /**
+     * 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: EventsPassesAttributesApiImportEventPassAttributesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ImportEventPassAttributes200Response, any, {}, any>>;
     /**
      * 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