/**
 * 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 { RequestFile } from './models';
import { CampaignValuesRequestDTOResourceObjectAttributesTimeframe } from './campaignValuesRequestDTOResourceObjectAttributesTimeframe';
export class CampaignValuesRequestDTOResourceObjectAttributes {
    /**
    * List of statistics to query for. All rate statistics will be returned in fractional form [0.0, 1.0]
    */
    'statistics': Array<CampaignValuesRequestDTOResourceObjectAttributes.StatisticsEnum> | 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<CampaignValuesRequestDTOResourceObjectAttributes.GroupByEnum> | 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}> = [
        {
            "name": "statistics",
            "baseName": "statistics",
            "type": "Array<CampaignValuesRequestDTOResourceObjectAttributes.StatisticsEnum>"
        },
        {
            "name": "timeframe",
            "baseName": "timeframe",
            "type": "CampaignValuesRequestDTOResourceObjectAttributesTimeframe"
        },
        {
            "name": "conversionMetricId",
            "baseName": "conversion_metric_id",
            "type": "string"
        },
        {
            "name": "groupBy",
            "baseName": "group_by",
            "type": "Array<CampaignValuesRequestDTOResourceObjectAttributes.GroupByEnum>"
        },
        {
            "name": "filter",
            "baseName": "filter",
            "type": "string"
        }    ];

    static getAttributeTypeMap() {
        return CampaignValuesRequestDTOResourceObjectAttributes.attributeTypeMap;
    }
}

export namespace CampaignValuesRequestDTOResourceObjectAttributes {
    export enum StatisticsEnum {
        AverageOrderValue = <any> 'average_order_value',
        BounceRate = <any> 'bounce_rate',
        Bounced = <any> 'bounced',
        BouncedOrFailed = <any> 'bounced_or_failed',
        BouncedOrFailedRate = <any> 'bounced_or_failed_rate',
        ClickRate = <any> 'click_rate',
        ClickToOpenRate = <any> 'click_to_open_rate',
        Clicks = <any> 'clicks',
        ClicksUnique = <any> 'clicks_unique',
        ConversionRate = <any> 'conversion_rate',
        ConversionUniques = <any> 'conversion_uniques',
        ConversionValue = <any> 'conversion_value',
        Conversions = <any> 'conversions',
        Delivered = <any> 'delivered',
        DeliveryRate = <any> 'delivery_rate',
        Failed = <any> 'failed',
        FailedRate = <any> 'failed_rate',
        MessageSegmentCountSum = <any> 'message_segment_count_sum',
        OpenRate = <any> 'open_rate',
        Opens = <any> 'opens',
        OpensUnique = <any> 'opens_unique',
        Recipients = <any> 'recipients',
        RevenuePerRecipient = <any> 'revenue_per_recipient',
        SpamComplaintRate = <any> 'spam_complaint_rate',
        SpamComplaints = <any> 'spam_complaints',
        TextMessageCreditUsageAmount = <any> 'text_message_credit_usage_amount',
        TextMessageRoi = <any> 'text_message_roi',
        TextMessageSpend = <any> 'text_message_spend',
        UnsubscribeRate = <any> 'unsubscribe_rate',
        UnsubscribeUniques = <any> 'unsubscribe_uniques',
        Unsubscribes = <any> 'unsubscribes'
    }
    export enum GroupByEnum {
        CampaignId = <any> 'campaign_id',
        CampaignMessageId = <any> 'campaign_message_id',
        CampaignMessageName = <any> 'campaign_message_name',
        Group = <any> 'group',
        GroupName = <any> 'group_name',
        SendChannel = <any> 'send_channel',
        TagId = <any> 'tag_id',
        TagName = <any> 'tag_name',
        TextMessageFormat = <any> 'text_message_format',
        Variation = <any> 'variation',
        VariationName = <any> 'variation_name'
    }
}