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

package/dist/generated/src/apis/CustomerCampaignsApi.d.ts

@@ -0,0 +1,527 @@
+/**
+ * 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 type { BaseGroupsWithParticipantsCountDTO, BasePageDTOListImportJobDTO, BasePageDTOListImportJobErrorDTO, GroupBaseRequestDTO, GroupBaseResponseDTO, ImportJobDTOSingle, JobUploadStatus, Pageable, ResponseDTO, UploadResponse, UploadResponseDTO, UserList, UserListsDTO, UserListsFileResponse } from '../models/index.js';
+export interface CustomerCampaignsApiCreateExperienceGroupRequest {
+    groupBaseRequestDTO: GroupBaseRequestDTO;
+}
+export interface CustomerCampaignsApiCreateUserListRequest {
+    fiId: string;
+    body: UserList;
+    originatingIp?: string;
+}
+export interface CustomerCampaignsApiCreateUserListMetadataRequest {
+    contentType?: string;
+    userListsDTO?: UserListsDTO;
+}
+export interface CustomerCampaignsApiDeleteExperienceGroupRequest {
+    groupId: string;
+}
+export interface CustomerCampaignsApiGetJobRequest {
+    jobId: string;
+}
+export interface CustomerCampaignsApiGetJobErrorsRequest {
+    jobId: string;
+    pageable?: Pageable;
+}
+export interface CustomerCampaignsApiGetUserListDetailsRequest {
+    userlistFileName: string;
+    viewName: string;
+    contentType?: string;
+}
+export interface CustomerCampaignsApiGetUserListStatusRequest {
+    fiId: string;
+    jobId: string;
+    originatingIp?: string;
+}
+export interface CustomerCampaignsApiListExperienceGroupsRequest {
+    pageable?: Pageable;
+}
+export interface CustomerCampaignsApiListJobsRequest {
+    pageable?: Pageable;
+    groupId?: string;
+}
+export interface CustomerCampaignsApiUpdateExperienceGroupRequest {
+    groupId: string;
+    groupBaseRequestDTO: GroupBaseRequestDTO;
+}
+export interface CustomerCampaignsApiUploadUserListFileRequest {
+    groupId: string;
+    type: UploadUserListFileTypeEnum;
+    fileName: Blob;
+}
+/**
+ * CustomerCampaignsApi - interface
+ *
+ * @export
+ * @interface CustomerCampaignsApiInterface
+ */
+export interface CustomerCampaignsApiInterface {
+    /**
+     * Creates request options for createExperienceGroup without sending the request
+     * @param {GroupBaseRequestDTO} groupBaseRequestDTO
+     * @throws {RequiredError}
+     * @memberof CustomerCampaignsApiInterface
+     */
+    createExperienceGroupRequestOpts(requestParameters: CustomerCampaignsApiCreateExperienceGroupRequest): Promise<runtime.RequestOpts>;
+    /**
+     * 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.
+     * @summary Create experience group
+     * @param {GroupBaseRequestDTO} groupBaseRequestDTO
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CustomerCampaignsApiInterface
+     */
+    createExperienceGroupRaw(requestParameters: CustomerCampaignsApiCreateExperienceGroupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GroupBaseResponseDTO>>;
+    /**
+     * 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
+     */
+    createExperienceGroup(requestParameters: CustomerCampaignsApiCreateExperienceGroupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GroupBaseResponseDTO>;
+    /**
+     * Creates request options for createUserList without sending the request
+     * @param {string} fiId Identifies the financial institution
+     * @param {UserList} body The name of the user list and the member IDs of the users it will contain.
+     * @param {string} [originatingIp] The IP address of the device making the request. If not provided, the IP address logged will be extracted from the HTTP request.
+     * @throws {RequiredError}
+     * @memberof CustomerCampaignsApiInterface
+     */
+    createUserListRequestOpts(requestParameters: CustomerCampaignsApiCreateUserListRequest): Promise<runtime.RequestOpts>;
+    /**
+     * 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.
+     * @summary Create user list upload job
+     * @param {string} fiId Identifies the financial institution
+     * @param {UserList} body The name of the user list and the member IDs of the users it will contain.
+     * @param {string} [originatingIp] The IP address of the device making the request. If not provided, the IP address logged will be extracted from the HTTP request.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CustomerCampaignsApiInterface
+     */
+    createUserListRaw(requestParameters: CustomerCampaignsApiCreateUserListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UploadResponse>>;
+    /**
+     * 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
+     */
+    createUserList(requestParameters: CustomerCampaignsApiCreateUserListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UploadResponse>;
+    /**
+     * Creates request options for createUserListMetadata without sending the request
+     * @param {string} [contentType] The data format the client expects to receive in the response. Currently the only supported value &#x60;application/json&#x60;.
+     * @param {UserListsDTO} [userListsDTO]
+     * @throws {RequiredError}
+     * @memberof CustomerCampaignsApiInterface
+     */
+    createUserListMetadataRequestOpts(requestParameters: CustomerCampaignsApiCreateUserListMetadataRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Metadata for the file uploaded through SFTP
+     * @summary Create user list metadata
+     * @param {string} [contentType] The data format the client expects to receive in the response. Currently the only supported value &#x60;application/json&#x60;.
+     * @param {UserListsDTO} [userListsDTO]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CustomerCampaignsApiInterface
+     */
+    createUserListMetadataRaw(requestParameters: CustomerCampaignsApiCreateUserListMetadataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Metadata for the file uploaded through SFTP
+     * Create user list metadata
+     */
+    createUserListMetadata(requestParameters: CustomerCampaignsApiCreateUserListMetadataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for deleteExperienceGroup without sending the request
+     * @param {string} groupId
+     * @throws {RequiredError}
+     * @memberof CustomerCampaignsApiInterface
+     */
+    deleteExperienceGroupRequestOpts(requestParameters: CustomerCampaignsApiDeleteExperienceGroupRequest): Promise<runtime.RequestOpts>;
+    /**
+     * 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
+     * @summary Delete experience group
+     * @param {string} groupId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CustomerCampaignsApiInterface
+     */
+    deleteExperienceGroupRaw(requestParameters: CustomerCampaignsApiDeleteExperienceGroupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ResponseDTO>>;
+    /**
+     * 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
+     */
+    deleteExperienceGroup(requestParameters: CustomerCampaignsApiDeleteExperienceGroupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ResponseDTO>;
+    /**
+     * Creates request options for getJob without sending the request
+     * @param {string} jobId
+     * @throws {RequiredError}
+     * @memberof CustomerCampaignsApiInterface
+     */
+    getJobRequestOpts(requestParameters: CustomerCampaignsApiGetJobRequest): Promise<runtime.RequestOpts>;
+    /**
+     * 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.
+     * @summary Get job by ID
+     * @param {string} jobId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CustomerCampaignsApiInterface
+     */
+    getJobRaw(requestParameters: CustomerCampaignsApiGetJobRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ImportJobDTOSingle>>;
+    /**
+     * 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
+     */
+    getJob(requestParameters: CustomerCampaignsApiGetJobRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ImportJobDTOSingle>;
+    /**
+     * Creates request options for getJobErrors without sending the request
+     * @param {string} jobId
+     * @param {Pageable} [pageable]
+     * @throws {RequiredError}
+     * @memberof CustomerCampaignsApiInterface
+     */
+    getJobErrorsRequestOpts(requestParameters: CustomerCampaignsApiGetJobErrorsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * 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.
+     * @summary Get job errors
+     * @param {string} jobId
+     * @param {Pageable} [pageable]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CustomerCampaignsApiInterface
+     */
+    getJobErrorsRaw(requestParameters: CustomerCampaignsApiGetJobErrorsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BasePageDTOListImportJobErrorDTO>>;
+    /**
+     * 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
+     */
+    getJobErrors(requestParameters: CustomerCampaignsApiGetJobErrorsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BasePageDTOListImportJobErrorDTO>;
+    /**
+     * Creates request options for getUserListDetails without sending the request
+     * @param {string} userlistFileName
+     * @param {string} viewName
+     * @param {string} [contentType] The data format the client expects to receive in the response. Currently the only supported value &#x60;application/json&#x60;.
+     * @throws {RequiredError}
+     * @memberof CustomerCampaignsApiInterface
+     */
+    getUserListDetailsRequestOpts(requestParameters: CustomerCampaignsApiGetUserListDetailsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Gets userlist details corresponding to the viewName, userlistFileName specified
+     * @summary Get user list details
+     * @param {string} userlistFileName
+     * @param {string} viewName
+     * @param {string} [contentType] The data format the client expects to receive in the response. Currently the only supported value &#x60;application/json&#x60;.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CustomerCampaignsApiInterface
+     */
+    getUserListDetailsRaw(requestParameters: CustomerCampaignsApiGetUserListDetailsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserListsFileResponse>>;
+    /**
+     * Gets userlist details corresponding to the viewName, userlistFileName specified
+     * Get user list details
+     */
+    getUserListDetails(requestParameters: CustomerCampaignsApiGetUserListDetailsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserListsFileResponse>;
+    /**
+     * Creates request options for getUserListStatus without sending the request
+     * @param {string} fiId Identifies the financial institution
+     * @param {string} jobId The ID of the user list upload job to check. A job ID is returned in the response of a successful request to enqueue a user list upload job
+     * @param {string} [originatingIp] The IP address of the device making the request. If not provided, the IP address logged will be extracted from the HTTP request.
+     * @throws {RequiredError}
+     * @memberof CustomerCampaignsApiInterface
+     */
+    getUserListStatusRequestOpts(requestParameters: CustomerCampaignsApiGetUserListStatusRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Gets the status of a user list upload job, showing its current state and progress.
+     * @summary Get user list upload status
+     * @param {string} fiId Identifies the financial institution
+     * @param {string} jobId The ID of the user list upload job to check. A job ID is returned in the response of a successful request to enqueue a user list upload job
+     * @param {string} [originatingIp] The IP address of the device making the request. If not provided, the IP address logged will be extracted from the HTTP request.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CustomerCampaignsApiInterface
+     */
+    getUserListStatusRaw(requestParameters: CustomerCampaignsApiGetUserListStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<JobUploadStatus>>;
+    /**
+     * Gets the status of a user list upload job, showing its current state and progress.
+     * Get user list upload status
+     */
+    getUserListStatus(requestParameters: CustomerCampaignsApiGetUserListStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<JobUploadStatus>;
+    /**
+     * Creates request options for listExperienceGroups without sending the request
+     * @param {Pageable} [pageable]
+     * @throws {RequiredError}
+     * @memberof CustomerCampaignsApiInterface
+     */
+    listExperienceGroupsRequestOpts(requestParameters: CustomerCampaignsApiListExperienceGroupsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * 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
+     * @summary List experience groups
+     * @param {Pageable} [pageable]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CustomerCampaignsApiInterface
+     */
+    listExperienceGroupsRaw(requestParameters: CustomerCampaignsApiListExperienceGroupsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BaseGroupsWithParticipantsCountDTO>>;
+    /**
+     * 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
+     */
+    listExperienceGroups(requestParameters: CustomerCampaignsApiListExperienceGroupsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BaseGroupsWithParticipantsCountDTO>;
+    /**
+     * Creates request options for listJobs without sending the request
+     * @param {Pageable} [pageable]
+     * @param {string} [groupId]
+     * @throws {RequiredError}
+     * @memberof CustomerCampaignsApiInterface
+     */
+    listJobsRequestOpts(requestParameters: CustomerCampaignsApiListJobsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * 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
+     * @summary List jobs
+     * @param {Pageable} [pageable]
+     * @param {string} [groupId]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CustomerCampaignsApiInterface
+     */
+    listJobsRaw(requestParameters: CustomerCampaignsApiListJobsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BasePageDTOListImportJobDTO>>;
+    /**
+     * 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
+     */
+    listJobs(requestParameters: CustomerCampaignsApiListJobsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BasePageDTOListImportJobDTO>;
+    /**
+     * Creates request options for updateExperienceGroup without sending the request
+     * @param {string} groupId
+     * @param {GroupBaseRequestDTO} groupBaseRequestDTO
+     * @throws {RequiredError}
+     * @memberof CustomerCampaignsApiInterface
+     */
+    updateExperienceGroupRequestOpts(requestParameters: CustomerCampaignsApiUpdateExperienceGroupRequest): Promise<runtime.RequestOpts>;
+    /**
+     * 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
+     * @summary Update experience group
+     * @param {string} groupId
+     * @param {GroupBaseRequestDTO} groupBaseRequestDTO
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CustomerCampaignsApiInterface
+     */
+    updateExperienceGroupRaw(requestParameters: CustomerCampaignsApiUpdateExperienceGroupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GroupBaseResponseDTO>>;
+    /**
+     * 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
+     */
+    updateExperienceGroup(requestParameters: CustomerCampaignsApiUpdateExperienceGroupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GroupBaseResponseDTO>;
+    /**
+     * Creates request options for uploadUserListFile without sending the request
+     * @param {string} groupId
+     * @param {string} type
+     * @param {Blob} fileName
+     * @throws {RequiredError}
+     * @memberof CustomerCampaignsApiInterface
+     */
+    uploadUserListFileRequestOpts(requestParameters: CustomerCampaignsApiUploadUserListFileRequest): Promise<runtime.RequestOpts>;
+    /**
+     * 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.
+     * @summary Upload group participants file
+     * @param {string} groupId
+     * @param {string} type
+     * @param {Blob} fileName
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CustomerCampaignsApiInterface
+     */
+    uploadUserListFileRaw(requestParameters: CustomerCampaignsApiUploadUserListFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UploadResponseDTO>>;
+    /**
+     * 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
+     */
+    uploadUserListFile(requestParameters: CustomerCampaignsApiUploadUserListFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UploadResponseDTO>;
+}
+/**
+ *
+ */
+export declare class CustomerCampaignsApi extends runtime.BaseAPI implements CustomerCampaignsApiInterface {
+    /**
+     * Creates request options for createExperienceGroup without sending the request
+     */
+    createExperienceGroupRequestOpts(requestParameters: CustomerCampaignsApiCreateExperienceGroupRequest): Promise<runtime.RequestOpts>;
+    /**
+     * 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
+     */
+    createExperienceGroupRaw(requestParameters: CustomerCampaignsApiCreateExperienceGroupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GroupBaseResponseDTO>>;
+    /**
+     * 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
+     */
+    createExperienceGroup(requestParameters: CustomerCampaignsApiCreateExperienceGroupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GroupBaseResponseDTO>;
+    /**
+     * Creates request options for createUserList without sending the request
+     */
+    createUserListRequestOpts(requestParameters: CustomerCampaignsApiCreateUserListRequest): Promise<runtime.RequestOpts>;
+    /**
+     * 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
+     */
+    createUserListRaw(requestParameters: CustomerCampaignsApiCreateUserListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UploadResponse>>;
+    /**
+     * 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
+     */
+    createUserList(requestParameters: CustomerCampaignsApiCreateUserListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UploadResponse>;
+    /**
+     * Creates request options for createUserListMetadata without sending the request
+     */
+    createUserListMetadataRequestOpts(requestParameters: CustomerCampaignsApiCreateUserListMetadataRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Metadata for the file uploaded through SFTP
+     * Create user list metadata
+     */
+    createUserListMetadataRaw(requestParameters: CustomerCampaignsApiCreateUserListMetadataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Metadata for the file uploaded through SFTP
+     * Create user list metadata
+     */
+    createUserListMetadata(requestParameters?: CustomerCampaignsApiCreateUserListMetadataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for deleteExperienceGroup without sending the request
+     */
+    deleteExperienceGroupRequestOpts(requestParameters: CustomerCampaignsApiDeleteExperienceGroupRequest): Promise<runtime.RequestOpts>;
+    /**
+     * 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
+     */
+    deleteExperienceGroupRaw(requestParameters: CustomerCampaignsApiDeleteExperienceGroupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ResponseDTO>>;
+    /**
+     * 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
+     */
+    deleteExperienceGroup(requestParameters: CustomerCampaignsApiDeleteExperienceGroupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ResponseDTO>;
+    /**
+     * Creates request options for getJob without sending the request
+     */
+    getJobRequestOpts(requestParameters: CustomerCampaignsApiGetJobRequest): Promise<runtime.RequestOpts>;
+    /**
+     * 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
+     */
+    getJobRaw(requestParameters: CustomerCampaignsApiGetJobRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ImportJobDTOSingle>>;
+    /**
+     * 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
+     */
+    getJob(requestParameters: CustomerCampaignsApiGetJobRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ImportJobDTOSingle>;
+    /**
+     * Creates request options for getJobErrors without sending the request
+     */
+    getJobErrorsRequestOpts(requestParameters: CustomerCampaignsApiGetJobErrorsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * 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
+     */
+    getJobErrorsRaw(requestParameters: CustomerCampaignsApiGetJobErrorsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BasePageDTOListImportJobErrorDTO>>;
+    /**
+     * 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
+     */
+    getJobErrors(requestParameters: CustomerCampaignsApiGetJobErrorsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BasePageDTOListImportJobErrorDTO>;
+    /**
+     * Creates request options for getUserListDetails without sending the request
+     */
+    getUserListDetailsRequestOpts(requestParameters: CustomerCampaignsApiGetUserListDetailsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Gets userlist details corresponding to the viewName, userlistFileName specified
+     * Get user list details
+     */
+    getUserListDetailsRaw(requestParameters: CustomerCampaignsApiGetUserListDetailsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserListsFileResponse>>;
+    /**
+     * Gets userlist details corresponding to the viewName, userlistFileName specified
+     * Get user list details
+     */
+    getUserListDetails(requestParameters: CustomerCampaignsApiGetUserListDetailsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserListsFileResponse>;
+    /**
+     * Creates request options for getUserListStatus without sending the request
+     */
+    getUserListStatusRequestOpts(requestParameters: CustomerCampaignsApiGetUserListStatusRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Gets the status of a user list upload job, showing its current state and progress.
+     * Get user list upload status
+     */
+    getUserListStatusRaw(requestParameters: CustomerCampaignsApiGetUserListStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<JobUploadStatus>>;
+    /**
+     * Gets the status of a user list upload job, showing its current state and progress.
+     * Get user list upload status
+     */
+    getUserListStatus(requestParameters: CustomerCampaignsApiGetUserListStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<JobUploadStatus>;
+    /**
+     * Creates request options for listExperienceGroups without sending the request
+     */
+    listExperienceGroupsRequestOpts(requestParameters: CustomerCampaignsApiListExperienceGroupsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * 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
+     */
+    listExperienceGroupsRaw(requestParameters: CustomerCampaignsApiListExperienceGroupsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BaseGroupsWithParticipantsCountDTO>>;
+    /**
+     * 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
+     */
+    listExperienceGroups(requestParameters?: CustomerCampaignsApiListExperienceGroupsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BaseGroupsWithParticipantsCountDTO>;
+    /**
+     * Creates request options for listJobs without sending the request
+     */
+    listJobsRequestOpts(requestParameters: CustomerCampaignsApiListJobsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * 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
+     */
+    listJobsRaw(requestParameters: CustomerCampaignsApiListJobsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BasePageDTOListImportJobDTO>>;
+    /**
+     * 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
+     */
+    listJobs(requestParameters?: CustomerCampaignsApiListJobsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BasePageDTOListImportJobDTO>;
+    /**
+     * Creates request options for updateExperienceGroup without sending the request
+     */
+    updateExperienceGroupRequestOpts(requestParameters: CustomerCampaignsApiUpdateExperienceGroupRequest): Promise<runtime.RequestOpts>;
+    /**
+     * 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
+     */
+    updateExperienceGroupRaw(requestParameters: CustomerCampaignsApiUpdateExperienceGroupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GroupBaseResponseDTO>>;
+    /**
+     * 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
+     */
+    updateExperienceGroup(requestParameters: CustomerCampaignsApiUpdateExperienceGroupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GroupBaseResponseDTO>;
+    /**
+     * Creates request options for uploadUserListFile without sending the request
+     */
+    uploadUserListFileRequestOpts(requestParameters: CustomerCampaignsApiUploadUserListFileRequest): Promise<runtime.RequestOpts>;
+    /**
+     * 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
+     */
+    uploadUserListFileRaw(requestParameters: CustomerCampaignsApiUploadUserListFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UploadResponseDTO>>;
+    /**
+     * 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
+     */
+    uploadUserListFile(requestParameters: CustomerCampaignsApiUploadUserListFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UploadResponseDTO>;
+}
+/**
+ * @export
+ */
+export declare const UploadUserListFileTypeEnum: {
+    readonly ADD: "ADD";
+    readonly REMOVE: "REMOVE";
+    readonly REPLACE: "REPLACE";
+};
+export type UploadUserListFileTypeEnum = typeof UploadUserListFileTypeEnum[keyof typeof UploadUserListFileTypeEnum];