@cdx-forge/di-typescript-sdk 0.1.0-beta.1

package/dist/generated/src/apis/CustomerCampaignsApi.js

@@ -0,0 +1,596 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Candescent DI API
+ * Welcome to the **Candescent Digital Insight API** documentation. This comprehensive API platform enables financial institutions, Marketplace Partners, and developers to build powerful digital banking experiences.  ## Getting Started  New to the Candescent API? Start here:  - **[Quick Start Guide](/guides/getting-started/quickstart/)** - Make your first API call in minutes - **[API Categories Overview](/guides/getting-started/api-overview/)** - Explore all available API categories - **[Error Codes Reference](/guides/getting-started/error-codes/)** - Handle errors effectively  ## API Categories  | Category | Description | |----------|-------------| | **[Accounts](/api/generated/accounts/)** | Account information, transactions, and banking images | | **[Alert Configuration](/api/generated/alert-configuration/)** | Alert types and templates | | **[Alert Delivery](/api/generated/alert-delivery/)** | Alert delivery history | | **[Alert Preferences](/api/generated/alert-preferences/)** | End-user notification preferences | | **[Authentication](/api/generated/authentication/)** | OAuth 2.0 token management and authorization | | **[Business Banking](/api/generated/business-banking/)** | Business banking services | | **[Customer Campaigns](/api/generated/customer-campaigns/)** | User segmentation and promotions | | **[Customer Management](/api/generated/customer-management/)** | Customer profiles, registration, and self-service | | **[Documents and Preferences](/api/generated/documents-and-preferences/)** | Disclosures and e-statement preferences | | **[Money Movement](/api/generated/money-movement/)** | Recipients and fund transfers | | **[MX](/api/generated/mx/)** | Account aggregation and financial insights | | **[Notification Channels](/api/generated/notification-channels/)** | Notification channels for alert delivery |  ## Base URLs  | Environment | Base URL | |-------------|----------| | Stage       | `https://api.candescent.com/digitalbanking/stage` | | Production  | `https://api.candescent.com/digitalbanking` |  > **Note:** This documentation primarily references the **Stage** environment for examples.  ## Authentication Overview  Candescent APIs use OAuth 2.0 with JWT Bearer tokens. Follow these steps:  ### Step 1: Obtain Client Credentials Get your `Client ID` and `Client Secret` from the Candescent Developer Console.  ### Step 2: Generate an Access Token  ```bash curl -X POST \'https://api.candescent.com/digitalbanking/stage/oauth2/v1/token\' \\   -H \'Authorization: Basic <BASE64_ENCODED(CLIENT_ID:CLIENT_SECRET)>\' \\   -H \'Content-Type: application/x-www-form-urlencoded\' \\   -H \'transactionid: <YOUR_UNIQUE_UUID>\' \\   -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\   -d \'grant_type=client_credentials\' ```  ### Step 3: Make Authenticated Requests  Include the token in the `Authorization` header:  ```bash curl \'https://api.candescent.com/digitalbanking/stage/accounts/v1/accounts\' \\   -H \'Authorization: Bearer <YOUR_ACCESS_TOKEN>\' \\   -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\   -H \'transactionid: <YOUR_UNIQUE_UUID>\' ```  > **Tip:** Access tokens expire in ~1 hour. Implement token refresh logic for uninterrupted access.  For detailed authentication flows, see the **[Authentication API Reference](/api/generated/authentication/)**.
+ *
+ * The version of the OpenAPI document: 1.4.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import * as runtime from '../runtime.js';
+import { BaseGroupsWithParticipantsCountDTOFromJSON, BasePageDTOListImportJobDTOFromJSON, BasePageDTOListImportJobErrorDTOFromJSON, GroupBaseRequestDTOToJSON, GroupBaseResponseDTOFromJSON, ImportJobDTOSingleFromJSON, JobUploadStatusFromJSON, ResponseDTOFromJSON, UploadResponseFromJSON, UploadResponseDTOFromJSON, UserListToJSON, UserListsDTOToJSON, UserListsFileResponseFromJSON, } from '../models/index.js';
+/**
+ *
+ */
+export class CustomerCampaignsApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for createExperienceGroup without sending the request
+     */
+    async createExperienceGroupRequestOpts(requestParameters) {
+        if (requestParameters['groupBaseRequestDTO'] == null) {
+            throw new runtime.RequiredError('groupBaseRequestDTO', 'Required parameter "groupBaseRequestDTO" was null or undefined when calling createExperienceGroup().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        headerParameters['Content-Type'] = 'application/json';
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/groups/v3/groups`;
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: GroupBaseRequestDTOToJSON(requestParameters['groupBaseRequestDTO']),
+        };
+    }
+    /**
+     * Creates a new experience group for organizing users. Experience groups allow you to segment users for targeted features, promotions, or A/B testing.  After creation, use the PUT `/groups/v3/groups/{groupId}/participants` endpoint to add users to the group.
+     * Create experience group
+     */
+    async createExperienceGroupRaw(requestParameters, initOverrides) {
+        const requestOptions = await this.createExperienceGroupRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => GroupBaseResponseDTOFromJSON(jsonValue));
+    }
+    /**
+     * Creates a new experience group for organizing users. Experience groups allow you to segment users for targeted features, promotions, or A/B testing.  After creation, use the PUT `/groups/v3/groups/{groupId}/participants` endpoint to add users to the group.
+     * Create experience group
+     */
+    async createExperienceGroup(requestParameters, initOverrides) {
+        const response = await this.createExperienceGroupRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Creates request options for createUserList without sending the request
+     */
+    async createUserListRequestOpts(requestParameters) {
+        if (requestParameters['fiId'] == null) {
+            throw new runtime.RequiredError('fiId', 'Required parameter "fiId" was null or undefined when calling createUserList().');
+        }
+        if (requestParameters['body'] == null) {
+            throw new runtime.RequiredError('body', 'Required parameter "body" was null or undefined when calling createUserList().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        headerParameters['Content-Type'] = 'application/json';
+        if (requestParameters['originatingIp'] != null) {
+            headerParameters['originating_ip'] = String(requestParameters['originatingIp']);
+        }
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/pss/v1/fis/{fiId}/audiences/userListJobs`;
+        urlPath = urlPath.replace(`{${"fiId"}}`, encodeURIComponent(String(requestParameters['fiId'])));
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: UserListToJSON(requestParameters['body']),
+        };
+    }
+    /**
+     * Enqueues a job for uploading a user list with the given name to Promotion Suite, returning a job ID. The job then completes later, at which point the user list is visible as a target audience in Promotion Suite. This is an alternative to uploading a user list in the Promotion Suite UI and waiting for the upload to complete before being able to do anything else in it.
+     * Create user list upload job
+     */
+    async createUserListRaw(requestParameters, initOverrides) {
+        const requestOptions = await this.createUserListRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => UploadResponseFromJSON(jsonValue));
+    }
+    /**
+     * Enqueues a job for uploading a user list with the given name to Promotion Suite, returning a job ID. The job then completes later, at which point the user list is visible as a target audience in Promotion Suite. This is an alternative to uploading a user list in the Promotion Suite UI and waiting for the upload to complete before being able to do anything else in it.
+     * Create user list upload job
+     */
+    async createUserList(requestParameters, initOverrides) {
+        const response = await this.createUserListRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Creates request options for createUserListMetadata without sending the request
+     */
+    async createUserListMetadataRequestOpts(requestParameters) {
+        const queryParameters = {};
+        const headerParameters = {};
+        headerParameters['Content-Type'] = 'application/json';
+        if (requestParameters['contentType'] != null) {
+            headerParameters['Content-Type'] = String(requestParameters['contentType']);
+        }
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/audience/v1/userlists`;
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: UserListsDTOToJSON(requestParameters['userListsDTO']),
+        };
+    }
+    /**
+     * Metadata for the file uploaded through SFTP
+     * Create user list metadata
+     */
+    async createUserListMetadataRaw(requestParameters, initOverrides) {
+        const requestOptions = await this.createUserListMetadataRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.VoidApiResponse(response);
+    }
+    /**
+     * Metadata for the file uploaded through SFTP
+     * Create user list metadata
+     */
+    async createUserListMetadata(requestParameters = {}, initOverrides) {
+        await this.createUserListMetadataRaw(requestParameters, initOverrides);
+    }
+    /**
+     * Creates request options for deleteExperienceGroup without sending the request
+     */
+    async deleteExperienceGroupRequestOpts(requestParameters) {
+        if (requestParameters['groupId'] == null) {
+            throw new runtime.RequiredError('groupId', 'Required parameter "groupId" was null or undefined when calling deleteExperienceGroup().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/groups/v3/groups/{groupId}`;
+        urlPath = urlPath.replace(`{${"groupId"}}`, encodeURIComponent(String(requestParameters['groupId'])));
+        return {
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+    /**
+     * Deletes an experience group and removes all user associations. This action cannot be undone.  **Important:** - All participant associations will be permanently removed - Historical job data for this group will no longer be accessible - Ensure the group is not in use by any active campaigns or features before deletion  **Prerequisites:** - The group must exist and be in `ACTIVE` status - User must have appropriate permissions to delete groups
+     * Delete experience group
+     */
+    async deleteExperienceGroupRaw(requestParameters, initOverrides) {
+        const requestOptions = await this.deleteExperienceGroupRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => ResponseDTOFromJSON(jsonValue));
+    }
+    /**
+     * Deletes an experience group and removes all user associations. This action cannot be undone.  **Important:** - All participant associations will be permanently removed - Historical job data for this group will no longer be accessible - Ensure the group is not in use by any active campaigns or features before deletion  **Prerequisites:** - The group must exist and be in `ACTIVE` status - User must have appropriate permissions to delete groups
+     * Delete experience group
+     */
+    async deleteExperienceGroup(requestParameters, initOverrides) {
+        const response = await this.deleteExperienceGroupRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Creates request options for getJob without sending the request
+     */
+    async getJobRequestOpts(requestParameters) {
+        if (requestParameters['jobId'] == null) {
+            throw new runtime.RequiredError('jobId', 'Required parameter "jobId" was null or undefined when calling getJob().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/groups/v3/jobs/{jobId}`;
+        urlPath = urlPath.replace(`{${"jobId"}}`, encodeURIComponent(String(requestParameters['jobId'])));
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+    /**
+     * Retrieves the status and details of a specific job. Use this endpoint to monitor the progress of user imports or other batch operations.  **Job Status Values:** - `CREATED`: Job queued for processing - `PROCESSING`: Currently processing records - `SUCCESSFUL`: All records processed without errors - `PARTIAL_SUCCESS`: Some records succeeded, others failed - `FAILED`: Job failed to complete  For failed or partial success jobs, use GET `/groups/v3/jobs/{jobId}/errors` to retrieve error details.
+     * Get job by ID
+     */
+    async getJobRaw(requestParameters, initOverrides) {
+        const requestOptions = await this.getJobRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => ImportJobDTOSingleFromJSON(jsonValue));
+    }
+    /**
+     * Retrieves the status and details of a specific job. Use this endpoint to monitor the progress of user imports or other batch operations.  **Job Status Values:** - `CREATED`: Job queued for processing - `PROCESSING`: Currently processing records - `SUCCESSFUL`: All records processed without errors - `PARTIAL_SUCCESS`: Some records succeeded, others failed - `FAILED`: Job failed to complete  For failed or partial success jobs, use GET `/groups/v3/jobs/{jobId}/errors` to retrieve error details.
+     * Get job by ID
+     */
+    async getJob(requestParameters, initOverrides) {
+        const response = await this.getJobRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Creates request options for getJobErrors without sending the request
+     */
+    async getJobErrorsRequestOpts(requestParameters) {
+        if (requestParameters['jobId'] == null) {
+            throw new runtime.RequiredError('jobId', 'Required parameter "jobId" was null or undefined when calling getJobErrors().');
+        }
+        const queryParameters = {};
+        if (requestParameters['pageable'] != null) {
+            queryParameters['pageable'] = requestParameters['pageable'];
+        }
+        const headerParameters = {};
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/groups/v3/jobs/{jobId}/errors`;
+        urlPath = urlPath.replace(`{${"jobId"}}`, encodeURIComponent(String(requestParameters['jobId'])));
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+    /**
+     * Retrieves errors associated with a specific job. Use this endpoint to troubleshoot failed user imports or other batch operations.  **Error Details Include:** - `lineNbr`: The line number in the uploaded CSV where the error occurred - `errorMsg`: Description of the validation or processing error  **Common Error Messages:** - \"ParticipantId cannot be larger than 32 characters\" - \"Invalid participant ID format\" - \"Duplicate participant ID\"  **Pagination:** Use `page` and `size` parameters to paginate through error results for large failed imports.
+     * Get job errors
+     */
+    async getJobErrorsRaw(requestParameters, initOverrides) {
+        const requestOptions = await this.getJobErrorsRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => BasePageDTOListImportJobErrorDTOFromJSON(jsonValue));
+    }
+    /**
+     * Retrieves errors associated with a specific job. Use this endpoint to troubleshoot failed user imports or other batch operations.  **Error Details Include:** - `lineNbr`: The line number in the uploaded CSV where the error occurred - `errorMsg`: Description of the validation or processing error  **Common Error Messages:** - \"ParticipantId cannot be larger than 32 characters\" - \"Invalid participant ID format\" - \"Duplicate participant ID\"  **Pagination:** Use `page` and `size` parameters to paginate through error results for large failed imports.
+     * Get job errors
+     */
+    async getJobErrors(requestParameters, initOverrides) {
+        const response = await this.getJobErrorsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Creates request options for getUserListDetails without sending the request
+     */
+    async getUserListDetailsRequestOpts(requestParameters) {
+        if (requestParameters['userlistFileName'] == null) {
+            throw new runtime.RequiredError('userlistFileName', 'Required parameter "userlistFileName" was null or undefined when calling getUserListDetails().');
+        }
+        if (requestParameters['viewName'] == null) {
+            throw new runtime.RequiredError('viewName', 'Required parameter "viewName" was null or undefined when calling getUserListDetails().');
+        }
+        const queryParameters = {};
+        if (requestParameters['userlistFileName'] != null) {
+            queryParameters['userlistFileName'] = requestParameters['userlistFileName'];
+        }
+        if (requestParameters['viewName'] != null) {
+            queryParameters['viewName'] = requestParameters['viewName'];
+        }
+        const headerParameters = {};
+        if (requestParameters['contentType'] != null) {
+            headerParameters['Content-Type'] = String(requestParameters['contentType']);
+        }
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/audience/v1/userlists`;
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+    /**
+     * Gets userlist details corresponding to the viewName, userlistFileName specified
+     * Get user list details
+     */
+    async getUserListDetailsRaw(requestParameters, initOverrides) {
+        const requestOptions = await this.getUserListDetailsRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => UserListsFileResponseFromJSON(jsonValue));
+    }
+    /**
+     * Gets userlist details corresponding to the viewName, userlistFileName specified
+     * Get user list details
+     */
+    async getUserListDetails(requestParameters, initOverrides) {
+        const response = await this.getUserListDetailsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Creates request options for getUserListStatus without sending the request
+     */
+    async getUserListStatusRequestOpts(requestParameters) {
+        if (requestParameters['fiId'] == null) {
+            throw new runtime.RequiredError('fiId', 'Required parameter "fiId" was null or undefined when calling getUserListStatus().');
+        }
+        if (requestParameters['jobId'] == null) {
+            throw new runtime.RequiredError('jobId', 'Required parameter "jobId" was null or undefined when calling getUserListStatus().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        if (requestParameters['originatingIp'] != null) {
+            headerParameters['originating_ip'] = String(requestParameters['originatingIp']);
+        }
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/pss/v1/fis/{fiId}/audiences/userListJobs/{jobId}`;
+        urlPath = urlPath.replace(`{${"fiId"}}`, encodeURIComponent(String(requestParameters['fiId'])));
+        urlPath = urlPath.replace(`{${"jobId"}}`, encodeURIComponent(String(requestParameters['jobId'])));
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+    /**
+     * Gets the status of a user list upload job, showing its current state and progress.
+     * Get user list upload status
+     */
+    async getUserListStatusRaw(requestParameters, initOverrides) {
+        const requestOptions = await this.getUserListStatusRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => JobUploadStatusFromJSON(jsonValue));
+    }
+    /**
+     * Gets the status of a user list upload job, showing its current state and progress.
+     * Get user list upload status
+     */
+    async getUserListStatus(requestParameters, initOverrides) {
+        const response = await this.getUserListStatusRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Creates request options for listExperienceGroups without sending the request
+     */
+    async listExperienceGroupsRequestOpts(requestParameters) {
+        const queryParameters = {};
+        if (requestParameters['pageable'] != null) {
+            queryParameters['pageable'] = requestParameters['pageable'];
+        }
+        const headerParameters = {};
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/groups/v3/groups`;
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+    /**
+     * Retrieves all experience groups with their participant counts. Use pagination parameters to navigate through large result sets.  **Pagination:** - Use `page` (0-based) and `size` parameters to paginate results - Response includes HATEOAS links for navigation (first, self, next, last) - Default page size is 20 records
+     * List experience groups
+     */
+    async listExperienceGroupsRaw(requestParameters, initOverrides) {
+        const requestOptions = await this.listExperienceGroupsRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => BaseGroupsWithParticipantsCountDTOFromJSON(jsonValue));
+    }
+    /**
+     * Retrieves all experience groups with their participant counts. Use pagination parameters to navigate through large result sets.  **Pagination:** - Use `page` (0-based) and `size` parameters to paginate results - Response includes HATEOAS links for navigation (first, self, next, last) - Default page size is 20 records
+     * List experience groups
+     */
+    async listExperienceGroups(requestParameters = {}, initOverrides) {
+        const response = await this.listExperienceGroupsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Creates request options for listJobs without sending the request
+     */
+    async listJobsRequestOpts(requestParameters) {
+        const queryParameters = {};
+        if (requestParameters['pageable'] != null) {
+            queryParameters['pageable'] = requestParameters['pageable'];
+        }
+        if (requestParameters['groupId'] != null) {
+            queryParameters['groupId'] = requestParameters['groupId'];
+        }
+        const headerParameters = {};
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/groups/v3/jobs`;
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+    /**
+     * Retrieves a paginated list of jobs. Jobs represent batch operations such as user imports. Filter by group ID to see jobs for a specific group.  **Filtering:** - Use the optional `groupId` query parameter to filter jobs for a specific group  **Sorting:** - Results can be sorted using the `sort` parameter (e.g., `insertDateTime,desc`) - Default sort is by most recent jobs first
+     * List jobs
+     */
+    async listJobsRaw(requestParameters, initOverrides) {
+        const requestOptions = await this.listJobsRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => BasePageDTOListImportJobDTOFromJSON(jsonValue));
+    }
+    /**
+     * Retrieves a paginated list of jobs. Jobs represent batch operations such as user imports. Filter by group ID to see jobs for a specific group.  **Filtering:** - Use the optional `groupId` query parameter to filter jobs for a specific group  **Sorting:** - Results can be sorted using the `sort` parameter (e.g., `insertDateTime,desc`) - Default sort is by most recent jobs first
+     * List jobs
+     */
+    async listJobs(requestParameters = {}, initOverrides) {
+        const response = await this.listJobsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Creates request options for updateExperienceGroup without sending the request
+     */
+    async updateExperienceGroupRequestOpts(requestParameters) {
+        if (requestParameters['groupId'] == null) {
+            throw new runtime.RequiredError('groupId', 'Required parameter "groupId" was null or undefined when calling updateExperienceGroup().');
+        }
+        if (requestParameters['groupBaseRequestDTO'] == null) {
+            throw new runtime.RequiredError('groupBaseRequestDTO', 'Required parameter "groupBaseRequestDTO" was null or undefined when calling updateExperienceGroup().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        headerParameters['Content-Type'] = 'application/json';
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/groups/v3/groups/{groupId}`;
+        urlPath = urlPath.replace(`{${"groupId"}}`, encodeURIComponent(String(requestParameters['groupId'])));
+        return {
+            path: urlPath,
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: GroupBaseRequestDTOToJSON(requestParameters['groupBaseRequestDTO']),
+        };
+    }
+    /**
+     * Updates an existing experience group. You can modify the group name and description.  **Important:** - If `groupDescription` is not included in the request, it will be deleted from the group - The `groupType` and `groupPlatform` cannot be modified - Updating a group does not affect its participants
+     * Update experience group
+     */
+    async updateExperienceGroupRaw(requestParameters, initOverrides) {
+        const requestOptions = await this.updateExperienceGroupRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => GroupBaseResponseDTOFromJSON(jsonValue));
+    }
+    /**
+     * Updates an existing experience group. You can modify the group name and description.  **Important:** - If `groupDescription` is not included in the request, it will be deleted from the group - The `groupType` and `groupPlatform` cannot be modified - Updating a group does not affect its participants
+     * Update experience group
+     */
+    async updateExperienceGroup(requestParameters, initOverrides) {
+        const response = await this.updateExperienceGroupRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Creates request options for uploadUserListFile without sending the request
+     */
+    async uploadUserListFileRequestOpts(requestParameters) {
+        if (requestParameters['groupId'] == null) {
+            throw new runtime.RequiredError('groupId', 'Required parameter "groupId" was null or undefined when calling uploadUserListFile().');
+        }
+        if (requestParameters['type'] == null) {
+            throw new runtime.RequiredError('type', 'Required parameter "type" was null or undefined when calling uploadUserListFile().');
+        }
+        if (requestParameters['fileName'] == null) {
+            throw new runtime.RequiredError('fileName', 'Required parameter "fileName" was null or undefined when calling uploadUserListFile().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        const consumes = [
+            { contentType: 'multipart/form-data' },
+        ];
+        // @ts-ignore: canConsumeForm may be unused
+        const canConsumeForm = runtime.canConsumeForm(consumes);
+        let formParams;
+        let useForm = false;
+        // use FormData to transmit files using content-type "multipart/form-data"
+        useForm = canConsumeForm;
+        if (useForm) {
+            formParams = new FormData();
+        }
+        else {
+            formParams = new URLSearchParams();
+        }
+        if (requestParameters['type'] != null) {
+            formParams.append('type', requestParameters['type']);
+        }
+        if (requestParameters['fileName'] != null) {
+            formParams.append('fileName', requestParameters['fileName']);
+        }
+        let urlPath = `/groups/v3/groups/{groupId}/participants`;
+        urlPath = urlPath.replace(`{${"groupId"}}`, encodeURIComponent(String(requestParameters['groupId'])));
+        return {
+            path: urlPath,
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: formParams,
+        };
+    }
+    /**
+     * Uploads a CSV file containing participant IDs to add, remove, or replace users in an experience group.  **File Requirements:** - Format: CSV file with participant IDs - Each participant ID must be 32 characters or less - File is submitted as multipart/form-data  **Operation Types:** - `ADD`: Add new participants to the existing group members - `REMOVE`: Remove specified participants from the group - `REPLACE`: Replace all existing participants with the new list  **Processing:** The upload creates an asynchronous job. Use the returned `jobId` to monitor progress  via the GET `/groups/v3/jobs/{jobId}` endpoint.
+     * Upload group participants file
+     */
+    async uploadUserListFileRaw(requestParameters, initOverrides) {
+        const requestOptions = await this.uploadUserListFileRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => UploadResponseDTOFromJSON(jsonValue));
+    }
+    /**
+     * Uploads a CSV file containing participant IDs to add, remove, or replace users in an experience group.  **File Requirements:** - Format: CSV file with participant IDs - Each participant ID must be 32 characters or less - File is submitted as multipart/form-data  **Operation Types:** - `ADD`: Add new participants to the existing group members - `REMOVE`: Remove specified participants from the group - `REPLACE`: Replace all existing participants with the new list  **Processing:** The upload creates an asynchronous job. Use the returned `jobId` to monitor progress  via the GET `/groups/v3/jobs/{jobId}` endpoint.
+     * Upload group participants file
+     */
+    async uploadUserListFile(requestParameters, initOverrides) {
+        const response = await this.uploadUserListFileRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+}
+/**
+ * @export
+ */
+export const UploadUserListFileTypeEnum = {
+    ADD: 'ADD',
+    REMOVE: 'REMOVE',
+    REPLACE: 'REPLACE'
+};