/** * 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 { CampaignValuesRequestDTOResourceObjectAttributesTimeframe } from './campaignValuesRequestDTOResourceObjectAttributesTimeframe'; export declare class CampaignValuesRequestDTOResourceObjectAttributes { /** * List of statistics to query for. All rate statistics will be returned in fractional form [0.0, 1.0] */ 'statistics': Array | Array<'average_order_value' | 'bounce_rate' | 'bounced' | 'bounced_or_failed' | 'bounced_or_failed_rate' | 'click_rate' | 'click_to_open_rate' | 'clicks' | 'clicks_unique' | 'conversion_rate' | 'conversion_uniques' | 'conversion_value' | 'conversions' | 'delivered' | 'delivery_rate' | 'failed' | 'failed_rate' | 'message_segment_count_sum' | 'open_rate' | 'opens' | 'opens_unique' | 'recipients' | 'revenue_per_recipient' | 'spam_complaint_rate' | 'spam_complaints' | 'text_message_credit_usage_amount' | 'text_message_roi' | 'text_message_spend' | 'unsubscribe_rate' | 'unsubscribe_uniques' | 'unsubscribes'>; 'timeframe': CampaignValuesRequestDTOResourceObjectAttributesTimeframe; /** * ID of the metric to be used for conversion statistics */ 'conversionMetricId': string; /** * List of attributes to group the data by. Allowed group-bys are campaign_id, campaign_message_id, campaign_message_name, group, group_name, send_channel, tag_id, tag_name, text_message_format, variation, variation_name. If not passed in, the data will be grouped by campaign_id, campaign_message_id, send_channel. The following group by attributes are required: campaign_id, campaign_message_id */ 'groupBy'?: Array | Array<'campaign_id' | 'campaign_message_id' | 'campaign_message_name' | 'group' | 'group_name' | 'send_channel' | 'tag_id' | 'tag_name' | 'text_message_format' | 'variation' | 'variation_name'> | null; /** * API filter string used to filter the query. Scalar attributes (send_channel, campaign_id, campaign_message_id, campaign_message_name, variation, variation_name, text_message_format): Supported operators: equals, contains-any. List attributes (tag_id, tag_name): Supported operators: contains-any, contains-all. Only one filter can be used per attribute. Only AND can be used as a combination operator. Max of 100 items per list filter. When filtering on send_channel, allowed values are email, sms, push-notification, whatsapp. */ 'filter'?: string | null; static attributeTypeMap: Array<{ name: string; baseName: string; type: string; }>; static getAttributeTypeMap(): { name: string; baseName: string; type: string; }[]; } export declare namespace CampaignValuesRequestDTOResourceObjectAttributes { enum StatisticsEnum { AverageOrderValue, BounceRate, Bounced, BouncedOrFailed, BouncedOrFailedRate, ClickRate, ClickToOpenRate, Clicks, ClicksUnique, ConversionRate, ConversionUniques, ConversionValue, Conversions, Delivered, DeliveryRate, Failed, FailedRate, MessageSegmentCountSum, OpenRate, Opens, OpensUnique, Recipients, RevenuePerRecipient, SpamComplaintRate, SpamComplaints, TextMessageCreditUsageAmount, TextMessageRoi, TextMessageSpend, UnsubscribeRate, UnsubscribeUniques, Unsubscribes } enum GroupByEnum { CampaignId, CampaignMessageId, CampaignMessageName, Group, GroupName, SendChannel, TagId, TagName, TextMessageFormat, Variation, VariationName } }