/** * 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 { GetWebFeedResponse } from '../model/getWebFeedResponse'; import { GetWebFeedResponseCollection } from '../model/getWebFeedResponseCollection'; import { PatchWebFeedResponse } from '../model/patchWebFeedResponse'; import { PostWebFeedResponse } from '../model/postWebFeedResponse'; import { WebFeedCreateQuery } from '../model/webFeedCreateQuery'; import { WebFeedPartialUpdateQuery } from '../model/webFeedPartialUpdateQuery'; import { Session } from './apis'; export declare class WebFeedsApi { 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; /** * Create a web feed.

*Rate limits*:
Burst: `1/s`
Steady: `15/m` **Scopes:** `web-feeds:write` * @summary Create Web Feed * @param webFeedCreateQuery Create a web feed */ createWebFeed(webFeedCreateQuery: WebFeedCreateQuery): Promise<{ response: AxiosResponse; body: PostWebFeedResponse; }>; /** * Delete the web feed with the given ID.

*Rate limits*:
Burst: `1/s`
Steady: `15/m` **Scopes:** `web-feeds:write` * @summary Delete Web Feed * @param id The ID of the web feed */ deleteWebFeed(id: string): Promise<{ response: AxiosResponse; body?: any; }>; /** * Get the web feed with the given ID.

*Rate limits*:
Burst: `1/s`
Steady: `15/m` **Scopes:** `web-feeds:read` * @summary Get Web Feed * @param id The ID of the web feed * @param fieldsWebFeed For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets */ getWebFeed(id: string, options?: { fieldsWebFeed?: Array<'content_type' | 'created' | 'name' | 'request_method' | 'status' | 'updated' | 'url'>; }): Promise<{ response: AxiosResponse; body: GetWebFeedResponse; }>; /** * Get all web feeds for an account.

*Rate limits*:
Burst: `1/s`
Steady: `15/m` **Scopes:** `web-feeds:read` * @summary Get Web Feeds * @param fieldsWebFeed For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets* @param filter For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `any`, `contains`, `equals`<br>`created`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`* @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination* @param pageSize Default: 5. Min: 1. Max: 20.* @param sort For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting */ getWebFeeds(options?: { fieldsWebFeed?: Array<'content_type' | 'created' | 'name' | 'request_method' | 'status' | 'updated' | 'url'>; filter?: string; pageCursor?: string; pageSize?: number; sort?: 'created' | '-created' | 'name' | '-name' | 'updated' | '-updated'; }): Promise<{ response: AxiosResponse; body: GetWebFeedResponseCollection; }>; /** * Update the web feed with the given ID.

*Rate limits*:
Burst: `1/s`
Steady: `15/m` **Scopes:** `web-feeds:write` * @summary Update Web Feed * @param id The ID of the web feed* @param webFeedPartialUpdateQuery Update a web feed by ID */ updateWebFeed(id: string, webFeedPartialUpdateQuery: WebFeedPartialUpdateQuery): Promise<{ response: AxiosResponse; body: PatchWebFeedResponse; }>; }