/** * Klaviyo API * The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. * * Contact: developers@klaviyo.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import { AxiosResponse } from "axios"; import { GetTrackingSettingResponse } from '../model/getTrackingSettingResponse'; import { GetTrackingSettingResponseCollection } from '../model/getTrackingSettingResponseCollection'; import { PatchTrackingSettingResponse } from '../model/patchTrackingSettingResponse'; import { TrackingSettingPartialUpdateQuery } from '../model/trackingSettingPartialUpdateQuery'; import { Session } from './apis'; export declare class TrackingSettingsApi { session: Session; protected _basePath: string; protected _defaultHeaders: any; protected _useQuerystring: boolean; constructor(session: Session); set useQuerystring(value: boolean); set basePath(basePath: string); set defaultHeaders(defaultHeaders: any); get defaultHeaders(): any; get basePath(): string; /** * Get the UTM tracking setting with the given account ID. More information about UTM tracking settings can be found [here](https://help.klaviyo.com/hc/en-us/articles/115005247808).

*Rate limits*:
Burst: `10/s`
Steady: `150/m` **Scopes:** `tracking-settings:read` * @summary Get Tracking Setting * @param id The id of the tracking setting (account ID). * @param fieldsTrackingSetting For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets */ getTrackingSetting(id: string, options?: { fieldsTrackingSetting?: Array<'auto_add_parameters' | 'custom_parameters' | 'utm_campaign' | 'utm_campaign.campaign' | 'utm_campaign.campaign.type' | 'utm_campaign.campaign.value' | 'utm_campaign.flow' | 'utm_campaign.flow.type' | 'utm_campaign.flow.value' | 'utm_id' | 'utm_id.campaign' | 'utm_id.campaign.type' | 'utm_id.campaign.value' | 'utm_id.flow' | 'utm_id.flow.type' | 'utm_id.flow.value' | 'utm_medium' | 'utm_medium.campaign' | 'utm_medium.campaign.type' | 'utm_medium.campaign.value' | 'utm_medium.flow' | 'utm_medium.flow.type' | 'utm_medium.flow.value' | 'utm_source' | 'utm_source.campaign' | 'utm_source.campaign.type' | 'utm_source.campaign.value' | 'utm_source.flow' | 'utm_source.flow.type' | 'utm_source.flow.value' | 'utm_term' | 'utm_term.campaign' | 'utm_term.campaign.type' | 'utm_term.campaign.value' | 'utm_term.flow' | 'utm_term.flow.type' | 'utm_term.flow.value'>; }): Promise<{ response: AxiosResponse; body: GetTrackingSettingResponse; }>; /** * Get all UTM tracking settings in an account. Returns an array with a single tracking setting. More information about UTM tracking settings can be found [here](https://help.klaviyo.com/hc/en-us/articles/115005247808).

*Rate limits*:
Burst: `10/s`
Steady: `150/m` **Scopes:** `tracking-settings:read` * @summary Get Tracking Settings * @param fieldsTrackingSetting For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets* @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination* @param pageSize Default: 1. Min: 1. Max: 1. */ getTrackingSettings(options?: { fieldsTrackingSetting?: Array<'auto_add_parameters' | 'custom_parameters' | 'utm_campaign' | 'utm_campaign.campaign' | 'utm_campaign.campaign.type' | 'utm_campaign.campaign.value' | 'utm_campaign.flow' | 'utm_campaign.flow.type' | 'utm_campaign.flow.value' | 'utm_id' | 'utm_id.campaign' | 'utm_id.campaign.type' | 'utm_id.campaign.value' | 'utm_id.flow' | 'utm_id.flow.type' | 'utm_id.flow.value' | 'utm_medium' | 'utm_medium.campaign' | 'utm_medium.campaign.type' | 'utm_medium.campaign.value' | 'utm_medium.flow' | 'utm_medium.flow.type' | 'utm_medium.flow.value' | 'utm_source' | 'utm_source.campaign' | 'utm_source.campaign.type' | 'utm_source.campaign.value' | 'utm_source.flow' | 'utm_source.flow.type' | 'utm_source.flow.value' | 'utm_term' | 'utm_term.campaign' | 'utm_term.campaign.type' | 'utm_term.campaign.value' | 'utm_term.flow' | 'utm_term.flow.type' | 'utm_term.flow.value'>; pageCursor?: string; pageSize?: number; }): Promise<{ response: AxiosResponse; body: GetTrackingSettingResponseCollection; }>; /** * Update the UTM tracking setting with the given account ID. More information about UTM tracking settings can be found [here](https://help.klaviyo.com/hc/en-us/articles/115005247808).

*Rate limits*:
Burst: `10/s`
Steady: `150/m` **Scopes:** `tracking-settings:write` * @summary Update Tracking Setting * @param id The id of the tracking setting (account ID).* @param trackingSettingPartialUpdateQuery DTO for updating tracking settings */ updateTrackingSetting(id: string, trackingSettingPartialUpdateQuery: TrackingSettingPartialUpdateQuery): Promise<{ response: AxiosResponse; body: PatchTrackingSettingResponse; }>; }