types.d.ts

/**
 * Returns a Promise that resolves with a new CustomerProfileAPI object.
 * @param tenantId - the tenant id
 * @param iMSOrgId - the iMSOrgId for your integration
 * @param apiKey - the API key for your integration
 * @param accessToken - the access token for your integration
 * @param [sandbox] - sandbox name
 * @returns a Promise with a CustomerProfileAPI object
 */
export function init(tenantId: string, iMSOrgId: string, apiKey: string, accessToken: string, sandbox?: string): Promise<CustomerProfileAPI>;

export class CustomerProfileAPI {
    /**
     * Initializes a CustomerProfileAPI object and returns it.
     * @param tenantId - the tenant id
     * @param iMSOrgId - the iMSOrgId for your integration
     * @param apiKey - the API key for your integration
     * @param accessToken - the access token for your integration
     * @param [sandbox] - sandbox name
     * @returns a CustomerProfileAPI object
     */
    init(tenantId: string, iMSOrgId: string, apiKey: string, accessToken: string, sandbox?: string): Promise<CustomerProfileAPI>;
    /**
     * The tenant id
     */
    tenantId: string;
    /**
     * The iMSOrgId
     */
    iMSOrgId: string;
    /**
     * The api key from your integration
     */
    apiKey: string;
    /**
     * The access token from your integration
     */
    accessToken: string;
    /**
     * The sandbox name
     */
    sandbox: string;
    /**
     * Get Profile by ID.
     * @param [parameters = {}] - parameters to pass
     * @returns the response
     */
    getProfile(parameters?: any): Promise<Response>;
    /**
     * Get ExperienceEvents.
     * @param [parameters = {}] - parameters to pass
     * @returns the response
     */
    getExperienceEvents(parameters?: any): Promise<Response>;
    /**
     * Retrieve a list of computed attributes.
     * @param [parameters = {}] - parameters to pass
     * @returns the response
     */
    listComputedAttributes(parameters?: any): Promise<Response>;
    /**
     * Create a computed attribute.
     * @param [parameters = {}] - parameters to pass
     * @returns the response
     */
    createComputedAttribute(parameters?: any): Promise<Response>;
    /**
     * Retrieve a specific computed attribute by its ID.
     * @param [parameters = {}] - parameters to pass
     * @param parameters.ATTRIBUTE_ID - The unique, read-only ID of the computed attribute that is generated by the system when the attribute is created.
     * @returns the response
     */
    lookupComputedAttribute(parameters?: {
        ATTRIBUTE_ID: string;
    }): Promise<Response>;
    /**
     * Update a computed attribute by its ID.
     * @param [parameters = {}] - parameters to pass
     * @param parameters.ATTRIBUTE_ID - The unique, read-only ID of the computed attribute that is generated by the system when the attribute is created.
     * @returns the response
     */
    updateComputedAttribute(parameters?: {
        ATTRIBUTE_ID: string;
    }): Promise<Response>;
    /**
     * Delete a computed attribute by its ID.
     * @param [parameters = {}] - parameters to pass
     * @param parameters.ATTRIBUTE_ID - The unique, read-only ID of the computed attribute that is generated by the system when the attribute is created.
     * @returns the response
     */
    deleteComputedAttribute(parameters?: {
        ATTRIBUTE_ID: string;
    }): Promise<Response>;
    /**
     * Retrieve a list of merge policies.
     * @param [parameters = {}] - parameters to pass
     * @param [parameters.'x-request-id'] - Request Id
     * @param [parameters.start] - Page offset - As per created time of resource
     * @param [parameters.limit] - Page Size
     * @param [parameters.orderBy] - Model attribute which will be using for ordering
     * @param [parameters.'schema.name'] - Schema class ID
     * @param [parameters.default] - default flag
     * @returns the response
     */
    getConfigMergePolicies(parameters?: {
        'x-request-id'?: string;
        start?: string;
        limit?: number;
        orderBy?: string;
        default?: boolean;
    }): Promise<Response>;
    /**
     * Create a new merge policy.
     * @param [parameters = {}] - parameters to pass
     * @param parameters.'Content-Type' - Type of content being sent in the body of the request. Should be 'application/json'.
     * @param parameters.'x-profile-instance-id' - Profile Instance ID
     * @param [parameters.'x-request-id'] - Request Id
     * @returns the response
     */
    postConfigMergePolicies(parameters?: {
        'Content-Type': string;
        'x-profile-instance-id': string;
        'x-request-id'?: string;
    }): Promise<Response>;
    /**
     * Lookup a merge policy by ID.
     * @param [parameters = {}] - parameters to pass
     * @param parameters.mergePolicyId - Merge policy ID.
     * @param [parameters.'x-request-id'] - Request Id
     * @returns the response
     */
    getConfigMergePoliciesMergePolicyId(parameters?: {
        mergePolicyId: string;
        'x-request-id'?: string;
    }): Promise<Response>;
    /**
     * Update a merge policy by ID.
     * @param [parameters = {}] - parameters to pass
     * @param parameters.mergePolicyId - Merge policy ID.
     * @param parameters.'x-profile-instance-id' - Profile Instance ID
     * @param [parameters.'x-request-id'] - Request Id
     * @returns the response
     */
    putConfigMergePoliciesMergePolicyId(parameters?: {
        mergePolicyId: string;
        'x-profile-instance-id': string;
        'x-request-id'?: string;
    }): Promise<Response>;
    /**
     * Update one or more attributes of a merge policy specified by ID.
     * @param [parameters = {}] - parameters to pass
     * @param parameters.mergePolicyId - Merge policy ID.
     * @param parameters.'x-profile-instance-id' - Profile Instance ID
     * @param [parameters.'x-request-id'] - Request Id
     * @returns the response
     */
    patchConfigMergePoliciesMergePolicyId(parameters?: {
        mergePolicyId: string;
        'x-profile-instance-id': string;
        'x-request-id'?: string;
    }): Promise<Response>;
    /**
     * Delete a merge policy by ID.
     * @param [parameters = {}] - parameters to pass
     * @param parameters.mergePolicyId - Merge policy ID.
     * @param [parameters.'x-request-id'] - Request Id
     * @returns the response
     */
    deleteConfigMergePoliciesMergePolicyId(parameters?: {
        mergePolicyId: string;
        'x-request-id'?: string;
    }): Promise<Response>;
    /**
     * Lookup an entity by ID or namespace.
     * @param [parameters = {}] - parameters to pass
     * @param parameters.'schema.name' - XED schema class name.
     * @param [parameters.'relatedSchema.name'] - XDM schema class name that the ExperienceEvent is associated with. Used when looking up ExperienceEvents.
     * @param [parameters.entityId] - ID of the entity. For Native XID lookup, use `entityId=<XID>` and leave `entityIdNS` absent; For ID:NS lookup, use both `entityId` and `entityIdNS` fields.
     * @param [parameters.entityIdNS] - Identity Namespace code. Used for ID:NS lookup. If this field is used, `entityId` cannot be empty.
     * @param [parameters.relatedEntityId] - ID of the entity that the ExperienceEvents are associated with. Used when looking up ExperienceEvents. For Native XID lookup, use `relatedEntityId=<XID>` and leave `relatedEntityIdNS` absent; For ID:NS lookup, use both `relatedEntityId` and `relatedEntityIdNS` fields.
     * @param [parameters.relatedEntityIdNS] - Identity Namespace code of the related entity ID of ExperienceEvent. Used when looking up ExperienceEvents. If this field is used, `entityId` cannot be empty.
     * @param [parameters.fields] - Fields for the model object. By default, all fields will be fetched. Separated by comma.
     * @param [parameters.mergePolicyId] - ID of the merge policy. A merge policy includes information for Identity stitching and key-value XDM object merging. If not present, the default merge policy will be used.
     * @param [parameters.startTime] - Start time of Time range filter for ExperienceEvents. Should be at millisecond granularity. Included. Default: From beginning.
     * @param [parameters.endTime] - End time of Time range filter for ExperienceEvents. Should be at millisecond granularity. Excluded. Default: To the end.
     * @param [parameters.limit] - Number of records to return from the result. Only for time-series objects. Default: 1000
     * @param [parameters.orderby] - The sort order of retrieved ExperienceEvents by timestamp. Syntax: (+/-)timestamp. Default: +timestamp
     * @returns the response
     */
    getAccessEntities(parameters?: {
        entityId?: string;
        entityIdNS?: string;
        relatedEntityId?: string;
        relatedEntityIdNS?: string;
        fields?: string;
        mergePolicyId?: string;
        startTime?: number;
        endTime?: number;
        limit?: number;
        orderby?: string;
    }): Promise<Response>;
    /**
     * Lookup multiple entities by IDs or namespaces.
     * @param [parameters = {}] - parameters to pass
     * @param parameters.'Content-Type' - Type of content being sent in the body of the request. Should be 'application/json'.
     * @returns the response
     */
    postAccessEntities(parameters?: {
        'Content-Type': string;
    }): Promise<Response>;
    /**
     * Delete an entity by ID.
     * @param [parameters = {}] - parameters to pass
     * @param parameters.'schema.name' - Name of the associated XDM schema.
     * @param [parameters.entityId] - ID of the entity. For Native XID, use `entityId=<XID>` and leave `entityIdNS` absent; For ID:NS, use both `entityId` and `entityIdNS` fields.
     * @param [parameters.entityIdNS] - Identity Namespace code. Used for ID:NS. If this field is used, `entityId` cannot be empty.
     * @param [parameters.mergePolicyId] - ID of the merge policy. A merge policy includes information for Identity stitching and key-value XDM object merging. If not present, the default merge policy will be used.
     * @returns the response
     */
    deleteAccessEntities(parameters?: {
        entityId?: string;
        entityIdNS?: string;
        mergePolicyId?: string;
    }): Promise<Response>;
    /**
     * Retrieve a list of all export jobs.
     * @param [parameters = {}] - parameters to pass
     * @param [parameters.limit] - Limit the number of export jobs returned in the list.
     * @param [parameters.offset] - Offset the page of results returned (ordered by created time of resource)
     * @param [parameters.status] - Filter the export jobs returned by job status. Possible values are "NEW", "SUCCEEDED", and "FAILED".
     * @returns the response
     */
    getScanJobsRoute(parameters?: {
        limit?: number;
        offset?: string;
        status?: string;
    }): Promise<Response>;
    /**
     * Create a new export job.
     * @param [parameters = {}] - parameters to pass
     * @param parameters.'Content-Type' - Type of content being sent in the body of the request. Should be 'application/json'.
     * @param [parameters.'x-profile-instance-id'] - Profile Instance ID
     * @returns the response
     */
    postScanJobRoute(parameters?: {
        'Content-Type': string;
        'x-profile-instance-id'?: string;
    }): Promise<Response>;
    /**
     * Lookup an export job by ID.
     * @param [parameters = {}] - parameters to pass
     * @param parameters.exportJobId - Export job ID
     * @returns the response
     */
    getScanJobRoute(parameters?: {
        exportJobId: string;
    }): Promise<Response>;
    /**
     * Cancel or delete an export job by ID.
     * @param [parameters = {}] - parameters to pass
     * @param parameters.exportJobId - Export job ID
     * @returns the response
     */
    cancelScanJobRoute(parameters?: {
        exportJobId: string;
    }): Promise<Response>;
    /**
     * Retrieve a list of segment definitions.
     * @param [parameters = {}] - parameters to pass
     * @param parameters.'x-request-id' - Unique ID per request
     * @param [parameters.start] - Page offset - As per created time of resource
     * @param [parameters.limit] - Page size
     * @param [parameters.page] - Page number
     * @param [parameters.sort] - Sort parameters
     * @returns the response
     */
    getSegmentsRoute(parameters?: {
        'x-request-id': string;
        start?: number;
        limit?: number;
        page?: number;
        sort?: string;
    }): Promise<Response>;
    /**
     * Create a new segment definition.
     * @param [parameters = {}] - parameters to pass
     * @param parameters.'Content-Type' - Type of content being sent in the body of the request. Should be 'application/json'.
     * @param parameters.'x-request-id' - Unique ID per request
     * @returns the response
     */
    postSegmentRoute(parameters?: {
        'Content-Type': string;
        'x-request-id': string;
    }): Promise<Response>;
    /**
     * Lookup a segment definition by ID.
     * @param [parameters = {}] - parameters to pass
     * @param parameters.segmentId - Segment Definition ID.
     * @param parameters.'x-request-id' - Unique ID per request
     * @returns the response
     */
    getSegmentRoute(parameters?: {
        segmentId: string;
        'x-request-id': string;
    }): Promise<Response>;
    /**
     * Delete a segment definition by ID.
     * @param [parameters = {}] - parameters to pass
     * @param parameters.segmentId - Segment Definition ID.
     * @param parameters.'x-request-id' - Unique ID per request
     * @returns the response
     */
    deleteSegmentRoute(parameters?: {
        segmentId: string;
        'x-request-id': string;
    }): Promise<Response>;
    /**
     * Overwrite a segment definition.
     * @param [parameters = {}] - parameters to pass
     * @param parameters.segmentId - Segment Definition ID.
     * @param parameters.'Content-Type' - Type of content being sent in the body of the request. Should be 'application/json'.
     * @param parameters.'x-request-id' - Unique ID per request
     * @returns the response
     */
    patchSegmentRoute(parameters?: {
        segmentId: string;
        'Content-Type': string;
        'x-request-id': string;
    }): Promise<Response>;
    /**
     * Convert PQL formatting between pql/text and pql/json.
     * @param [parameters = {}] - parameters to pass
     * @param parameters.'Content-Type' - Type of content being sent in the body of the request. Should be 'application/json'.
     * @param parameters.'x-request-id' - Unique ID per request
     * @returns the response
     */
    postSegmentConversionRoute(parameters?: {
        'Content-Type': string;
        'x-request-id': string;
    }): Promise<Response>;
    /**
     * Retrieve a list of all segment job requests.
     * @param [parameters = {}] - parameters to pass
     * @param [parameters.'x-request-id'] - Request ID
     * @param [parameters.start] - Page Offset - As per created Time of resource
     * @param [parameters.limit] - Page Size
     * @param [parameters.status] - The job status
     * @returns the response
     */
    getSegmentJobs(parameters?: {
        'x-request-id'?: string;
        start?: number;
        limit?: number;
        status?: string;
    }): Promise<Response>;
    /**
     * Create a new segment job request.
     * @param [parameters = {}] - parameters to pass
     * @param parameters.'Content-Type' - Type of content being sent in the body of the request. Should be 'application/json'.
     * @param parameters.'x-profile-instance-id' - Profile Instance ID
     * @param [parameters.'x-request-id'] - Request ID
     * @returns the response
     */
    postSJRRoute(parameters?: {
        'Content-Type': string;
        'x-profile-instance-id': string;
        'x-request-id'?: string;
    }): Promise<Response>;
    /**
     * Lookup a segment job request by ID.
     * @param [parameters = {}] - parameters to pass
     * @param parameters.segmentJobId - Segment job request ID.
     * @param [parameters.'x-request-id'] - Request ID
     * @returns the response
     */
    getSegmentJobsSegmentJobId(parameters?: {
        segmentJobId: string;
        'x-request-id'?: string;
    }): Promise<Response>;
    /**
     * Cancel or delete a segment job request by ID.
     * @param [parameters = {}] - parameters to pass
     * @param parameters.segmentJobId - Segment job request ID.
     * @param [parameters.'x-request-id'] - Request ID
     * @returns the response
     */
    deleteSegmentJobsSegmentJobId(parameters?: {
        segmentJobId: string;
        'x-request-id'?: string;
    }): Promise<Response>;
    /**
     * Create a new preview job.
     * @param [parameters = {}] - parameters to pass
     * @param parameters.'Content-Type' - Type of content being sent in the body of the request. Should be 'application/json'.
     * @returns the response
     */
    postSessionlessPreviewRoute(parameters?: {
        'Content-Type': string;
    }): Promise<Response>;
    /**
     * Lookup the results of a preview job by ID.
     * @param [parameters = {}] - parameters to pass
     * @param parameters.previewId - ID of the preview job.
     * @param [parameters.offset] - Page offset
     * @param [parameters.limit] - How many entries should be present in a page. 1000 if not specified.
     * @returns the response
     */
    getSessionlessPreviewStatusRoute(parameters?: {
        previewId: string;
        offset?: string;
        limit?: number;
    }): Promise<Response>;
    /**
     * Cancel or delete a preview job by ID.
     * @param [parameters = {}] - parameters to pass
     * @param parameters.previewId - ID of the preview job.
     * @returns the response
     */
    deleteSessionLessPreviewStatusRoute(parameters?: {
        previewId: string;
    }): Promise<Response>;
    /**
     * Lookup the results of an estimate job by ID.
     * @param [parameters = {}] - parameters to pass
     * @param parameters.previewId - ID of the preview job.
     * @returns the response
     */
    getEstimateStatusRoute(parameters?: {
        previewId: string;
    }): Promise<Response>;
    /**
     * Retrieve a list of edge projection configurations. The latest definitions are returned.
     * @param [parameters = {}] - parameters to pass
     * @param parameters.'x-gw-ims-authorization' - Gateway IMS service token.
     * @param [parameters.schemaName] - XDM schema name
     * @param [parameters.name] - projection name
     * @param [parameters.'x-user-token'] - User access token.
     * @param [parameters.'x-request-id'] - Optional header that may be used for debugging purposes when investigating issues with a client flow. The same ID can be used to identify a single request to the service from a flow. A new ID should be created for each request.
     * @returns the response
     */
    listProjectionConfigurations(parameters?: {
        'x-gw-ims-authorization': string;
        schemaName?: string;
        name?: string;
        'x-user-token'?: string;
        'x-request-id'?: string;
    }): Promise<Response>;
    /**
     * Create a new edge projection configuration.
     * @param [parameters = {}] - parameters to pass
     * @param parameters.schemaName - XDM schema name
     * @param parameters.'x-gw-ims-authorization' - Gateway IMS service token.
     * @param [parameters.'x-user-token'] - User access token.
     * @param [parameters.'x-request-id'] - Optional header that may be used for debugging purposes when investigating issues with a client flow. The same ID can be used to identify a single request to the service from a flow. A new ID should be created for each request.
     * @returns the response
     */
    createProjectionConfiguration(parameters?: {
        schemaName: string;
        'x-gw-ims-authorization': string;
        'x-user-token'?: string;
        'x-request-id'?: string;
    }): Promise<Response>;
    /**
     * Lookup an edge projection configuration by ID. The latest definition is returned.
     * @param [parameters = {}] - parameters to pass
     * @param parameters.projectionid - undefined
     * @param parameters.'x-gw-ims-authorization' - Gateway IMS service token.
     * @param [parameters.'x-user-token'] - User access token.
     * @param [parameters.'x-request-id'] - Optional header that may be used for debugging purposes when investigating issues with a client flow. The same ID can be used to identify a single request to the service from a flow. A new ID should be created for each request.
     * @returns the response
     */
    getProjectionConfiguration(parameters?: {
        projectionid: string;
        'x-gw-ims-authorization': string;
        'x-user-token'?: string;
        'x-request-id'?: string;
    }): Promise<Response>;
    /**
     * Create or update an edge projection configuration by ID. Overwrites the entire configuration.
     * @param [parameters = {}] - parameters to pass
     * @param parameters.projectionid - undefined
     * @param parameters.'x-gw-ims-authorization' - Gateway IMS service token.
     * @param [parameters.'x-user-token'] - User access token.
     * @param [parameters.'x-request-id'] - Optional header that may be used for debugging purposes when investigating issues with a client flow. The same ID can be used to identify a single request to the service from a flow. A new ID should be created for each request.
     * @returns the response
     */
    updateProjectionConfiguration(parameters?: {
        projectionid: string;
        'x-gw-ims-authorization': string;
        'x-user-token'?: string;
        'x-request-id'?: string;
    }): Promise<Response>;
    /**
     * Delete an edge projection configuration by ID.
     * @param [parameters = {}] - parameters to pass
     * @param parameters.projectionid - undefined
     * @param parameters.'x-gw-ims-authorization' - Gateway IMS service token.
     * @param [parameters.'x-user-token'] - User access token.
     * @param [parameters.'x-request-id'] - Optional header that may be used for debugging purposes when investigating issues with a client flow. The same ID can be used to identify a single request to the service from a flow. A new ID should be created for each request.
     * @returns the response
     */
    deleteProjectionConfiguration(parameters?: {
        projectionid: string;
        'x-gw-ims-authorization': string;
        'x-user-token'?: string;
        'x-request-id'?: string;
    }): Promise<Response>;
    /**
     * Retrieve a list of edge projection destinations. The latest definitions are returned.
     * @param [parameters = {}] - parameters to pass
     * @param [parameters.'x-request-id'] - Optional header that may be used for debugging purposes when investigating issues with a workflow. The same ID can be used to identify a single request to the service from a flow. A new ID should be created for each request.
     * @returns the response
     */
    listProjectionDestinations(parameters?: {
        'x-request-id'?: string;
    }): Promise<Response>;
    /**
     * Create a new edge projection destination.
     * @param [parameters = {}] - parameters to pass
     * @param parameters.'x-gw-ims-authorization' - Gateway IMS service token.
     * @param [parameters.'x-user-token'] - User access token.
     * @param [parameters.'x-request-id'] - Optional header that may be used for debugging purposes when investigating issues with a client flow. The same ID can be used to identify a single request to the service from a flow. A new ID should be created for each request.
     * @returns the response
     */
    createProjectionDestination(parameters?: {
        'x-gw-ims-authorization': string;
        'x-user-token'?: string;
        'x-request-id'?: string;
    }): Promise<Response>;
    /**
     * Lookup an edge projection destination by ID. The latest definition is returned.
     * @param [parameters = {}] - parameters to pass
     * @param parameters.destinationId - undefined
     * @param parameters.'x-gw-ims-authorization' - Gateway IMS service token.
     * @param [parameters.'x-user-token'] - User access token.
     * @param [parameters.'x-request-id'] - Optional header that may be used for debugging purposes when investigating issues with a client flow. The same ID can be used to identify a single request to the service from a flow. A new ID should be created for each request.
     * @returns the response
     */
    getProjectionDestination(parameters?: {
        destinationId: string;
        'x-gw-ims-authorization': string;
        'x-user-token'?: string;
        'x-request-id'?: string;
    }): Promise<Response>;
    /**
     * Create or update an edge projection destination by ID. Overwrites the entire configuration.
     * @param [parameters = {}] - parameters to pass
     * @param parameters.destinationId - undefined
     * @param parameters.'x-gw-ims-authorization' - Gateway IMS service token.
     * @param [parameters.'x-user-token'] - User access token.
     * @param [parameters.'x-request-id'] - Optional header that may be used for debugging purposes when investigating issues with a client flow. The same ID can be used to identify a single request to the service from a flow. A new ID should be created for each request.
     * @returns the response
     */
    putProjectionDestination(parameters?: {
        destinationId: string;
        'x-gw-ims-authorization': string;
        'x-user-token'?: string;
        'x-request-id'?: string;
    }): Promise<Response>;
    /**
     * Delete an edge projection destination by ID.
     * @param [parameters = {}] - parameters to pass
     * @param parameters.destinationId - undefined
     * @param parameters.'x-gw-ims-authorization' - Gateway IMS service token.
     * @param [parameters.'x-user-token'] - User access token.
     * @param [parameters.'x-request-id'] - Optional header that may be used for debugging purposes when investigating issues with a client flow. The same ID can be used to identify a single request to the service from a flow. A new ID should be created for each request.
     * @returns the response
     */
    deleteProjectionDestination(parameters?: {
        destinationId: string;
        'x-gw-ims-authorization': string;
        'x-user-token'?: string;
        'x-request-id'?: string;
    }): Promise<Response>;
    /**
     * Retrieve a list of event types.
     * @param [parameters = {}] - parameters to pass
     * @param [parameters.'x-request-id'] - Optional header that may be used for debugging purposes when investigating issues with a workflow. The same ID can be used to identify a single request to the service from a flow. A new ID should be created for each request.
     * @param [parameters.start] - Page offset for the response. Default is 0.
     * @param [parameters.limit] - Page size
     * @param [parameters.orderBy] - The model attribute to be used for ordering.
     * @returns the response
     */
    getConfigEventTypes(parameters?: {
        'x-request-id'?: string;
        start?: number;
        limit?: number;
        orderBy?: string;
    }): Promise<Response>;
    /**
     * Create a new event type.
     * @param [parameters = {}] - parameters to pass
     * @param parameters.'x-profile-instance-id' - Profile instance ID.
     * @param [parameters.'x-request-id'] - Optional header that may be used for debugging purposes when investigating issues with a workflow. The same ID can be used to identify a single request to the service from a flow. A new ID should be created for each request.
     * @returns the response
     */
    postConfigEventTypes(parameters?: {
        'x-profile-instance-id': string;
        'x-request-id'?: string;
    }): Promise<Response>;
    /**
     * Lookup an event type by ID.
     * @param [parameters = {}] - parameters to pass
     * @param parameters.eventTypeId - Event type ID.
     * @param [parameters.'x-request-id'] - Optional header that may be used for debugging purposes when investigating issues with a workflow. The same ID can be used to identify a single request to the service from a flow. A new ID should be created for each request.
     * @returns the response
     */
    getConfigEventTypesEventTypeId(parameters?: {
        eventTypeId: string;
        'x-request-id'?: string;
    }): Promise<Response>;
    /**
     * Overwrite an event type by ID.
     * @param [parameters = {}] - parameters to pass
     * @param parameters.eventTypeId - Event type ID.
     * @param parameters.'x-profile-instance-id' - Profile instance ID.
     * @param [parameters.'x-request-id'] - Optional header that may be used for debugging purposes when investigating issues with a workflow. The same ID can be used to identify a single request to the service from a flow. A new ID should be created for each request.
     * @returns the response
     */
    putConfigEventTypesEventTypeId(parameters?: {
        eventTypeId: string;
        'x-profile-instance-id': string;
        'x-request-id'?: string;
    }): Promise<Response>;
    /**
     * Update one or more attributes of an event type by ID.
     * @param [parameters = {}] - parameters to pass
     * @param parameters.eventTypeId - Event type ID.
     * @param parameters.'x-profile-instance-id' - Profile instance ID.
     * @param [parameters.'x-request-id'] - Optional header that may be used for debugging purposes when investigating issues with a workflow. The same ID can be used to identify a single request to the service from a flow. A new ID should be created for each request.
     * @returns the response
     */
    patchConfigEventTypesEventTypeId(parameters?: {
        eventTypeId: string;
        'x-profile-instance-id': string;
        'x-request-id'?: string;
    }): Promise<Response>;
    /**
     * Delete an event type by ID.
     * @param [parameters = {}] - parameters to pass
     * @param parameters.eventTypeId - Event type ID.
     * @param [parameters.'x-request-id'] - Optional header that may be used for debugging purposes when investigating issues with a workflow. The same ID can be used to identify a single request to the service from a flow. A new ID should be created for each request.
     * @returns the response
     */
    deleteConfigEventTypesEventTypeId(parameters?: {
        eventTypeId: string;
        'x-request-id'?: string;
    }): Promise<Response>;
    /**
     * Retrieve a list of all macros for your organization.
     * @param [parameters = {}] - parameters to pass
     * @param [parameters.'x-request-id'] - Request ID
     * @param [parameters.start] - Page offset (at the created time of resource)
     * @param [parameters.limit] - Maximum number of objects to display on each page.
     * @param [parameters.orderBy] - Model attribute which will be using for ordering.
     * @param [parameters.dataSetId] - Dataset ID.
     * @param [parameters.schemaClassId] - Schema class ID.
     * @param [parameters.value] - Event type value.
     * @returns the response
     */
    getConfigMacros(parameters?: {
        'x-request-id'?: string;
        start?: string;
        limit?: number;
        orderBy?: string;
        dataSetId?: string;
        schemaClassId?: string;
        value?: string;
    }): Promise<Response>;
    /**
     * Create a new macro.
     * @param [parameters = {}] - parameters to pass
     * @param parameters.'x-profile-instance-id' - Profile Instance ID
     * @param [parameters.'x-request-id'] - Request ID
     * @returns the response
     */
    postConfigMacros(parameters?: {
        'x-profile-instance-id': string;
        'x-request-id'?: string;
    }): Promise<Response>;
    /**
     * Lookup a macro by ID.
     * @param [parameters = {}] - parameters to pass
     * @param parameters.macroId - Macro ID. For example, `ca8fe8a8-0f38-478a-9905-fd515d1d2988`
     * @param [parameters.'x-request-id'] - Request Id
     * @returns the response
     */
    getConfigMacrosMacroId(parameters?: {
        macroId: string;
        'x-request-id'?: string;
    }): Promise<Response>;
    /**
     * Overwrite a macro by ID.
     * @param [parameters = {}] - parameters to pass
     * @param parameters.macroId - Macro ID. For example, `ca8fe8a8-0f38-478a-9905-fd515d1d2988`
     * @param parameters.'x-profile-instance-id' - Profile Instance ID
     * @param [parameters.'x-request-id'] - Request ID
     * @returns the response
     */
    putConfigMacrosMacroId(parameters?: {
        macroId: string;
        'x-profile-instance-id': string;
        'x-request-id'?: string;
    }): Promise<Response>;
    /**
     * Update a macro by ID.
     * @param [parameters = {}] - parameters to pass
     * @param parameters.macroId - Macro ID. For example, `ca8fe8a8-0f38-478a-9905-fd515d1d2988`
     * @param parameters.'x-profile-instance-id' - Profile Instance ID.
     * @param [parameters.'x-request-id'] - Request ID.
     * @returns the response
     */
    patchConfigMacrosMacroId(parameters?: {
        macroId: string;
        'x-profile-instance-id': string;
        'x-request-id'?: string;
    }): Promise<Response>;
    /**
     * Delete a macro by ID.
     * @param [parameters = {}] - parameters to pass
     * @param parameters.macroId - Macro ID. For example, `ca8fe8a8-0f38-478a-9905-fd515d1d2988`
     * @param [parameters.'x-request-id'] - Request ID.
     * @returns the response
     */
    deleteConfigMacrosMacroId(parameters?: {
        macroId: string;
        'x-request-id'?: string;
    }): Promise<Response>;
    /**
     * Retrieve a list of schedules for your IMS Org
     * @param [parameters = {}] - parameters to pass
     * @param [parameters.'x-request-id'] - Optional header that may be used for debugging purposes when investigating issues with a workflow. The same ID can be used to identify a single request to the service from a flow. A new ID should be created for each request.
     * @param [parameters.start] - Return results from a specific page offset. For example, `start=3`
     * @param [parameters.limit] - Limit response to a specific number of objects. Must be a positive number. For example, `limit=10`
     * @returns the response
     */
    getSchedules(parameters?: {
        'x-request-id'?: string;
        start?: number;
        limit?: number;
    }): Promise<Response>;
    /**
     * Create a schedule, including specifying the time when the schedule should be triggered.
     * @param [parameters = {}] - parameters to pass
     * @param parameters.'Content-Type' - Type of content being sent in the body of the request. Should be 'application/json'.
     * @param [parameters.'x-request-id'] - Optional header that may be used for debugging purposes when investigating issues with a workflow. The same ID can be used to identify a single request to the service from a flow. A new ID should be created for each request.
     * @returns the response
     */
    createSchedule(parameters?: {
        'Content-Type': string;
        'x-request-id'?: string;
    }): Promise<Response>;
    /**
     * Lookup a schedule by its ID.
     * @param [parameters = {}] - parameters to pass
     * @param parameters.SCHEDULE_ID - The ID of the schedule against which the operation is being performed.
     * @param [parameters.'x-request-id'] - Optional header that may be used for debugging purposes when investigating issues with a workflow. The same ID can be used to identify a single request to the service from a flow. A new ID should be created for each request.
     * @returns the response
     */
    getScheduleById(parameters?: {
        SCHEDULE_ID: string;
        'x-request-id'?: string;
    }): Promise<Response>;
    /**
     * Update a schedule, including changing the trigger time or enabling/disabling the schedule.
     * @param [parameters = {}] - parameters to pass
     * @param parameters.SCHEDULE_ID - The ID of the schedule against which the operation is being performed.
     * @param [parameters.'x-request-id'] - Optional header that may be used for debugging purposes when investigating issues with a workflow. The same ID can be used to identify a single request to the service from a flow. A new ID should be created for each request.
     * @returns the response
     */
    updateSchedule(parameters?: {
        SCHEDULE_ID: string;
        'x-request-id'?: string;
    }): Promise<Response>;
    /**
     * Delete a schedule by its ID.
     * @param [parameters = {}] - parameters to pass
     * @param parameters.SCHEDULE_ID - The ID of the schedule against which the operation is being performed.
     * @param [parameters.'x-request-id'] - Optional header that may be used for debugging purposes when investigating issues with a workflow. The same ID can be used to identify a single request to the service from a flow. A new ID should be created for each request.
     * @returns the response
     */
    deleteSchedule(parameters?: {
        SCHEDULE_ID: string;
        'x-request-id'?: string;
    }): Promise<Response>;
    /**
     * Retrieve a list of all delete requests (Profile System Jobs) created by your organization.
     * @param [parameters = {}] - parameters to pass
     * @param [parameters.start] - Return results from a specific page offset. For example, `start=3`
     * @param [parameters.limit] - Limit response to a specific number of objects. Must be a positive number. For example, `limit=10`
     * @param [parameters.page] - Return a specific page of results, as per the create time of the request. For example, `page=0`
     * @param [parameters.sort] - Sort results by a specific field in ascending (`asc`) or descending (`desc`) order. The sort parameter does not work when returning multiple pages of results. For example, `sort=batchId:asc`
     * @returns the response
     */
    listDeleteRequests(parameters?: {
        start?: number;
        limit?: number;
        page?: number;
        sort?: string;
    }): Promise<Response>;
    /**
     * Create a delete request (Profile System Job)
     * @param [parameters = {}] - parameters to pass
     * @param parameters.'Content-Type' - Type of content being sent in the body of the request. Should be 'application/json'.
     * @returns the response
     */
    createDeleteRequest(parameters?: {
        'Content-Type': string;
    }): Promise<Response>;
    /**
     * View a specific delete request (Profile System Job) by its ID.
     * @param [parameters = {}] - parameters to pass
     * @param parameters.ID - ID of the delete request (Profile System Job) that you wish to view. For example, '3e64ad31-5e6b-4399-80ad-ccfab54254ae'.
     * @returns the response
     */
    viewDeleteRequest(parameters?: {
        ID: string;
    }): Promise<Response>;
    /**
     * Remove a specific delete request (Profile System Job) by its ID.
     * @param [parameters = {}] - parameters to pass
     * @param parameters.ID - ID of the delete request (Profile System Job) that you wish to view. For example, '3e64ad31-5e6b-4399-80ad-ccfab54254ae'.
     * @returns the response
     */
    deleteDeleteRequest(parameters?: {
        ID: string;
    }): Promise<Response>;
}

/**
 * Create dynamic methods from openApi spec file
 */
export class OpenApi {
}