/**
 * Linkbreakers API
 * This is a documentation of all the APIs of Linkbreakers
 *
 * The version of the OpenAPI document: 1.118.3
 *
 *
 * 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';
import type { DeleteAttributeResponse, DeleteVisitorResponse, IdentifyRequest, IdentifyResponse, ListVisitorAttributeKeysResponse, ListVisitorsResponse, Visitor, VisitorsServiceUpdateBody } from '../models/index';
export interface VisitorsServiceDeleteRequest {
    id: string;
}
export interface VisitorsServiceDeleteAttributeRequest {
    id: string;
    attributeKey: string;
}
export interface VisitorsServiceGetRequest {
    id: string;
    include?: Array<string>;
}
export interface VisitorsServiceIdentifyRequest {
    identifyRequest: IdentifyRequest;
}
export interface VisitorsServiceListRequest {
    pageSize?: number;
    pageToken?: string;
    email?: string;
    search?: string;
    include?: Array<string>;
    linkId?: string;
    responseFormat?: string;
    sortField?: string;
    sortDirection?: string;
}
export interface VisitorsServiceListAttributeKeysRequest {
    linkId?: string;
}
export interface VisitorsServiceUpdateRequest {
    id: string;
    visitorsServiceUpdateBody: VisitorsServiceUpdateBody;
}
/**
 * VisitorsApi - interface
 *
 * @export
 * @interface VisitorsApiInterface
 */
export interface VisitorsApiInterface {
    /**
     * Creates request options for visitorsServiceDelete without sending the request
     * @param {string} id Visitor identifier to remove (UUID)
     * @throws {RequiredError}
     * @memberof VisitorsApiInterface
     */
    visitorsServiceDeleteRequestOpts(requestParameters: VisitorsServiceDeleteRequest): Promise<runtime.RequestOpts>;
    /**
     * Removes a visitor profile and its stored attributes from the workspace.
     * @summary Delete a visitor
     * @param {string} id Visitor identifier to remove (UUID)
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof VisitorsApiInterface
     */
    visitorsServiceDeleteRaw(requestParameters: VisitorsServiceDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeleteVisitorResponse>>;
    /**
     * Removes a visitor profile and its stored attributes from the workspace.
     * Delete a visitor
     */
    visitorsServiceDelete(requestParameters: VisitorsServiceDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeleteVisitorResponse>;
    /**
     * Creates request options for visitorsServiceDeleteAttribute without sending the request
     * @param {string} id Visitor identifier whose attribute should be removed (UUID)
     * @param {string} attributeKey Attribute key to delete (without \&quot;$\&quot; prefix)
     * @throws {RequiredError}
     * @memberof VisitorsApiInterface
     */
    visitorsServiceDeleteAttributeRequestOpts(requestParameters: VisitorsServiceDeleteAttributeRequest): Promise<runtime.RequestOpts>;
    /**
     * Deletes a single attribute from the visitor profile without affecting other data.
     * @summary Delete a visitor attribute
     * @param {string} id Visitor identifier whose attribute should be removed (UUID)
     * @param {string} attributeKey Attribute key to delete (without \&quot;$\&quot; prefix)
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof VisitorsApiInterface
     */
    visitorsServiceDeleteAttributeRaw(requestParameters: VisitorsServiceDeleteAttributeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeleteAttributeResponse>>;
    /**
     * Deletes a single attribute from the visitor profile without affecting other data.
     * Delete a visitor attribute
     */
    visitorsServiceDeleteAttribute(requestParameters: VisitorsServiceDeleteAttributeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeleteAttributeResponse>;
    /**
     * Creates request options for visitorsServiceGet without sending the request
     * @param {string} id Visitor identifier (UUID)
     * @param {Array<string>} [include] Optional relationships to hydrate (\&quot;devices\&quot;, \&quot;events\&quot;, \&quot;links\&quot;)
     * @throws {RequiredError}
     * @memberof VisitorsApiInterface
     */
    visitorsServiceGetRequestOpts(requestParameters: VisitorsServiceGetRequest): Promise<runtime.RequestOpts>;
    /**
     * Retrieves a visitor profile by ID with optional devices, events, or links included.
     * @summary Get a visitor
     * @param {string} id Visitor identifier (UUID)
     * @param {Array<string>} [include] Optional relationships to hydrate (\&quot;devices\&quot;, \&quot;events\&quot;, \&quot;links\&quot;)
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof VisitorsApiInterface
     */
    visitorsServiceGetRaw(requestParameters: VisitorsServiceGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Visitor>>;
    /**
     * Retrieves a visitor profile by ID with optional devices, events, or links included.
     * Get a visitor
     */
    visitorsServiceGet(requestParameters: VisitorsServiceGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Visitor>;
    /**
     * Creates request options for visitorsServiceIdentify without sending the request
     * @param {IdentifyRequest} identifyRequest
     * @throws {RequiredError}
     * @memberof VisitorsApiInterface
     */
    visitorsServiceIdentifyRequestOpts(requestParameters: VisitorsServiceIdentifyRequest): Promise<runtime.RequestOpts>;
    /**
     * Identifies a visitor from an LBID. Anonymous visitors (created at scan time) are promoted or merged into existing identified visitors. If the identity matches an existing visitor, devices and events converge into that source-of-truth record.
     * @summary Identify visitor
     * @param {IdentifyRequest} identifyRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof VisitorsApiInterface
     */
    visitorsServiceIdentifyRaw(requestParameters: VisitorsServiceIdentifyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IdentifyResponse>>;
    /**
     * Identifies a visitor from an LBID. Anonymous visitors (created at scan time) are promoted or merged into existing identified visitors. If the identity matches an existing visitor, devices and events converge into that source-of-truth record.
     * Identify visitor
     */
    visitorsServiceIdentify(requestParameters: VisitorsServiceIdentifyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IdentifyResponse>;
    /**
     * Creates request options for visitorsServiceList without sending the request
     * @param {number} [pageSize] Maximum number of visitors to return (default 50, max 200)
     * @param {string} [pageToken] Cursor token to retrieve the next page of results
     * @param {string} [email] optional exact match filter
     * @param {string} [search] optional fuzzy search across known fields
     * @param {Array<string>} [include]
     * @param {string} [linkId] optional filter by link ID (UUID; visitors who have interacted with this link)
     * @param {string} [responseFormat]  - RESPONSE_FORMAT_UNSPECIFIED: Response format not specified  - RESPONSE_FORMAT_JSON: Response format JSON  - RESPONSE_FORMAT_CSV: Response format CSV
     * @param {string} [sortField] Field to sort by. Defaults to created_at (newest first).   - VISITOR_SORT_FIELD_UNSPECIFIED: Sort field not specified (defaults to created_at)  - VISITOR_SORT_FIELD_CREATED_AT: Sort by the date the visitor was first seen  - VISITOR_SORT_FIELD_VISIT_COUNT: Sort by total number of visits (events)  - VISITOR_SORT_FIELD_DEVICE_COUNT: Sort by number of attributed devices  - VISITOR_SORT_FIELD_QRCODE_COUNT: Sort by number of distinct QR codes interacted with
     * @param {string} [sortDirection] Sort direction. Defaults to descending.   - SORT_DIRECTION_UNSPECIFIED: Sort direction not specified (defaults to descending)  - SORT_DIRECTION_ASC: Sort in ascending order  - SORT_DIRECTION_DESC: Sort in descending order
     * @throws {RequiredError}
     * @memberof VisitorsApiInterface
     */
    visitorsServiceListRequestOpts(requestParameters: VisitorsServiceListRequest): Promise<runtime.RequestOpts>;
    /**
     * Returns a paginated collection of visitors with optional filters, includes, and CSV export.
     * @summary List visitors
     * @param {number} [pageSize] Maximum number of visitors to return (default 50, max 200)
     * @param {string} [pageToken] Cursor token to retrieve the next page of results
     * @param {string} [email] optional exact match filter
     * @param {string} [search] optional fuzzy search across known fields
     * @param {Array<string>} [include]
     * @param {string} [linkId] optional filter by link ID (UUID; visitors who have interacted with this link)
     * @param {string} [responseFormat]  - RESPONSE_FORMAT_UNSPECIFIED: Response format not specified  - RESPONSE_FORMAT_JSON: Response format JSON  - RESPONSE_FORMAT_CSV: Response format CSV
     * @param {string} [sortField] Field to sort by. Defaults to created_at (newest first).   - VISITOR_SORT_FIELD_UNSPECIFIED: Sort field not specified (defaults to created_at)  - VISITOR_SORT_FIELD_CREATED_AT: Sort by the date the visitor was first seen  - VISITOR_SORT_FIELD_VISIT_COUNT: Sort by total number of visits (events)  - VISITOR_SORT_FIELD_DEVICE_COUNT: Sort by number of attributed devices  - VISITOR_SORT_FIELD_QRCODE_COUNT: Sort by number of distinct QR codes interacted with
     * @param {string} [sortDirection] Sort direction. Defaults to descending.   - SORT_DIRECTION_UNSPECIFIED: Sort direction not specified (defaults to descending)  - SORT_DIRECTION_ASC: Sort in ascending order  - SORT_DIRECTION_DESC: Sort in descending order
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof VisitorsApiInterface
     */
    visitorsServiceListRaw(requestParameters: VisitorsServiceListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListVisitorsResponse>>;
    /**
     * Returns a paginated collection of visitors with optional filters, includes, and CSV export.
     * List visitors
     */
    visitorsServiceList(requestParameters: VisitorsServiceListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListVisitorsResponse>;
    /**
     * Creates request options for visitorsServiceListAttributeKeys without sending the request
     * @param {string} [linkId] Optional link identifier (UUID). When set, returns keys observed on visitors who interacted with this link.
     * @throws {RequiredError}
     * @memberof VisitorsApiInterface
     */
    visitorsServiceListAttributeKeysRequestOpts(requestParameters: VisitorsServiceListAttributeKeysRequest): Promise<runtime.RequestOpts>;
    /**
     * Returns the distinct visitor attribute keys available in the workspace or scoped to a single link.
     * @summary List visitor attribute keys
     * @param {string} [linkId] Optional link identifier (UUID). When set, returns keys observed on visitors who interacted with this link.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof VisitorsApiInterface
     */
    visitorsServiceListAttributeKeysRaw(requestParameters: VisitorsServiceListAttributeKeysRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListVisitorAttributeKeysResponse>>;
    /**
     * Returns the distinct visitor attribute keys available in the workspace or scoped to a single link.
     * List visitor attribute keys
     */
    visitorsServiceListAttributeKeys(requestParameters: VisitorsServiceListAttributeKeysRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListVisitorAttributeKeysResponse>;
    /**
     * Creates request options for visitorsServiceUpdate without sending the request
     * @param {string} id Visitor identifier (UUID)
     * @param {VisitorsServiceUpdateBody} visitorsServiceUpdateBody
     * @throws {RequiredError}
     * @memberof VisitorsApiInterface
     */
    visitorsServiceUpdateRequestOpts(requestParameters: VisitorsServiceUpdateRequest): Promise<runtime.RequestOpts>;
    /**
     * Applies partial attribute updates to an existing visitor profile.
     * @summary Update a visitor
     * @param {string} id Visitor identifier (UUID)
     * @param {VisitorsServiceUpdateBody} visitorsServiceUpdateBody
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof VisitorsApiInterface
     */
    visitorsServiceUpdateRaw(requestParameters: VisitorsServiceUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Visitor>>;
    /**
     * Applies partial attribute updates to an existing visitor profile.
     * Update a visitor
     */
    visitorsServiceUpdate(requestParameters: VisitorsServiceUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Visitor>;
}
/**
 *
 */
export declare class VisitorsApi extends runtime.BaseAPI implements VisitorsApiInterface {
    /**
     * Creates request options for visitorsServiceDelete without sending the request
     */
    visitorsServiceDeleteRequestOpts(requestParameters: VisitorsServiceDeleteRequest): Promise<runtime.RequestOpts>;
    /**
     * Removes a visitor profile and its stored attributes from the workspace.
     * Delete a visitor
     */
    visitorsServiceDeleteRaw(requestParameters: VisitorsServiceDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeleteVisitorResponse>>;
    /**
     * Removes a visitor profile and its stored attributes from the workspace.
     * Delete a visitor
     */
    visitorsServiceDelete(requestParameters: VisitorsServiceDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeleteVisitorResponse>;
    /**
     * Creates request options for visitorsServiceDeleteAttribute without sending the request
     */
    visitorsServiceDeleteAttributeRequestOpts(requestParameters: VisitorsServiceDeleteAttributeRequest): Promise<runtime.RequestOpts>;
    /**
     * Deletes a single attribute from the visitor profile without affecting other data.
     * Delete a visitor attribute
     */
    visitorsServiceDeleteAttributeRaw(requestParameters: VisitorsServiceDeleteAttributeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeleteAttributeResponse>>;
    /**
     * Deletes a single attribute from the visitor profile without affecting other data.
     * Delete a visitor attribute
     */
    visitorsServiceDeleteAttribute(requestParameters: VisitorsServiceDeleteAttributeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeleteAttributeResponse>;
    /**
     * Creates request options for visitorsServiceGet without sending the request
     */
    visitorsServiceGetRequestOpts(requestParameters: VisitorsServiceGetRequest): Promise<runtime.RequestOpts>;
    /**
     * Retrieves a visitor profile by ID with optional devices, events, or links included.
     * Get a visitor
     */
    visitorsServiceGetRaw(requestParameters: VisitorsServiceGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Visitor>>;
    /**
     * Retrieves a visitor profile by ID with optional devices, events, or links included.
     * Get a visitor
     */
    visitorsServiceGet(requestParameters: VisitorsServiceGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Visitor>;
    /**
     * Creates request options for visitorsServiceIdentify without sending the request
     */
    visitorsServiceIdentifyRequestOpts(requestParameters: VisitorsServiceIdentifyRequest): Promise<runtime.RequestOpts>;
    /**
     * Identifies a visitor from an LBID. Anonymous visitors (created at scan time) are promoted or merged into existing identified visitors. If the identity matches an existing visitor, devices and events converge into that source-of-truth record.
     * Identify visitor
     */
    visitorsServiceIdentifyRaw(requestParameters: VisitorsServiceIdentifyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IdentifyResponse>>;
    /**
     * Identifies a visitor from an LBID. Anonymous visitors (created at scan time) are promoted or merged into existing identified visitors. If the identity matches an existing visitor, devices and events converge into that source-of-truth record.
     * Identify visitor
     */
    visitorsServiceIdentify(requestParameters: VisitorsServiceIdentifyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IdentifyResponse>;
    /**
     * Creates request options for visitorsServiceList without sending the request
     */
    visitorsServiceListRequestOpts(requestParameters: VisitorsServiceListRequest): Promise<runtime.RequestOpts>;
    /**
     * Returns a paginated collection of visitors with optional filters, includes, and CSV export.
     * List visitors
     */
    visitorsServiceListRaw(requestParameters: VisitorsServiceListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListVisitorsResponse>>;
    /**
     * Returns a paginated collection of visitors with optional filters, includes, and CSV export.
     * List visitors
     */
    visitorsServiceList(requestParameters?: VisitorsServiceListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListVisitorsResponse>;
    /**
     * Creates request options for visitorsServiceListAttributeKeys without sending the request
     */
    visitorsServiceListAttributeKeysRequestOpts(requestParameters: VisitorsServiceListAttributeKeysRequest): Promise<runtime.RequestOpts>;
    /**
     * Returns the distinct visitor attribute keys available in the workspace or scoped to a single link.
     * List visitor attribute keys
     */
    visitorsServiceListAttributeKeysRaw(requestParameters: VisitorsServiceListAttributeKeysRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListVisitorAttributeKeysResponse>>;
    /**
     * Returns the distinct visitor attribute keys available in the workspace or scoped to a single link.
     * List visitor attribute keys
     */
    visitorsServiceListAttributeKeys(requestParameters?: VisitorsServiceListAttributeKeysRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListVisitorAttributeKeysResponse>;
    /**
     * Creates request options for visitorsServiceUpdate without sending the request
     */
    visitorsServiceUpdateRequestOpts(requestParameters: VisitorsServiceUpdateRequest): Promise<runtime.RequestOpts>;
    /**
     * Applies partial attribute updates to an existing visitor profile.
     * Update a visitor
     */
    visitorsServiceUpdateRaw(requestParameters: VisitorsServiceUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Visitor>>;
    /**
     * Applies partial attribute updates to an existing visitor profile.
     * Update a visitor
     */
    visitorsServiceUpdate(requestParameters: VisitorsServiceUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Visitor>;
}