@adcp/sdk API Reference - v7.9.0
    Preparing search index...

    Variable MediaBuySchemaConst

    MediaBuySchema: ZodObject<
        {
            media_buy_id: ZodString;
            account: ZodOptional<
                ZodObject<
                    {
                        account_id: ZodString;
                        name: ZodString;
                        advertiser: ZodOptional<ZodString>;
                        billing_proxy: ZodOptional<ZodString>;
                        status: ZodUnion<
                            readonly [
                                ZodLiteral<"active">,
                                ZodLiteral<"pending_approval">,
                                ZodLiteral<"rejected">,
                                ZodLiteral<"payment_required">,
                                ZodLiteral<"suspended">,
                                ZodLiteral<"closed">,
                            ],
                        >;
                        brand: ZodOptional<
                            ZodObject<
                                {
                                    domain: ZodString;
                                    brand_id: ZodOptional<ZodString>;
                                    industries: ZodOptional<ZodArray<ZodString>>;
                                    data_subject_contestation: ZodOptional<
                                        ZodRecord<ZodString, ZodUnknown>,
                                    >;
                                },
                                $loose,
                            >,
                        >;
                        operator: ZodOptional<ZodString>;
                        billing: ZodOptional<
                            ZodUnion<
                                readonly [
                                    ZodLiteral<"operator">,
                                    ZodLiteral<"agent">,
                                    ZodLiteral<"advertiser">,
                                ],
                            >,
                        >;
                        billing_entity: ZodOptional<
                            ZodObject<
                                {
                                    legal_name: ZodString;
                                    vat_id: ZodOptional<ZodString>;
                                    tax_id: ZodOptional<ZodString>;
                                    registration_number: ZodOptional<ZodString>;
                                    address: ZodOptional<
                                        ZodObject<
                                            {
                                                street: ...;
                                                city: ...;
                                                postal_code: ...;
                                                region: ...;
                                                country: ...;
                                            },
                                            $loose,
                                        >,
                                    >;
                                    contacts: ZodOptional<ZodArray<ZodObject<(...), (...)>>>;
                                    bank: ZodOptional<
                                        ZodObject<
                                            {
                                                account_holder: ...;
                                                iban: ...;
                                                bic: ...;
                                                routing_number: ...;
                                                account_number: ...;
                                            },
                                            $loose,
                                        >,
                                    >;
                                    ext: ZodOptional<ZodObject<{}, $loose>>;
                                },
                                $loose,
                            >,
                        >;
                        rate_card: ZodOptional<ZodString>;
                        payment_terms: ZodOptional<
                            ZodUnion<
                                readonly [
                                    ZodLiteral<"net_15">,
                                    ZodLiteral<"net_30">,
                                    ZodLiteral<"net_45">,
                                    ZodLiteral<"net_60">,
                                    ZodLiteral<"net_90">,
                                    ZodLiteral<"prepay">,
                                ],
                            >,
                        >;
                        credit_limit: ZodOptional<
                            ZodObject<{ amount: ZodNumber; currency: ZodString }, $loose>,
                        >;
                        setup: ZodOptional<
                            ZodObject<
                                {
                                    url: ZodOptional<ZodString>;
                                    message: ZodString;
                                    expires_at: ZodOptional<ZodISODateTime>;
                                },
                                $loose,
                            >,
                        >;
                        account_scope: ZodOptional<
                            ZodUnion<
                                readonly [
                                    ZodLiteral<"operator">,
                                    ZodLiteral<"brand">,
                                    ZodLiteral<"operator_brand">,
                                    ZodLiteral<"agent">,
                                ],
                            >,
                        >;
                        governance_agents: ZodOptional<
                            ZodArray<
                                ZodObject<
                                    { url: ZodString; categories: ZodOptional<ZodArray<(...)>> },
                                    $loose,
                                >,
                            >,
                        >;
                        reporting_bucket: ZodOptional<
                            ZodObject<
                                {
                                    protocol: ZodUnion<
                                        readonly [
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                        ],
                                    >;
                                    bucket: ZodString;
                                    prefix: ZodOptional<ZodString>;
                                    region: ZodOptional<ZodString>;
                                    format: ZodOptional<
                                        ZodUnion<readonly [(...), (...), (...), (...), (...)]>,
                                    >;
                                    compression: ZodOptional<ZodUnion<readonly [(...), (...)]>>;
                                    file_retention_days: ZodNumber;
                                    setup_instructions: ZodOptional<ZodString>;
                                },
                                $loose,
                            >,
                        >;
                        sandbox: ZodOptional<ZodBoolean>;
                        ext: ZodOptional<ZodObject<{}, $loose>>;
                    },
                    $loose,
                >,
            >;
            status: ZodUnion<
                readonly [
                    ZodLiteral<"pending_creatives">,
                    ZodLiteral<"pending_start">,
                    ZodLiteral<"active">,
                    ZodLiteral<"paused">,
                    ZodLiteral<"completed">,
                    ZodLiteral<"rejected">,
                    ZodLiteral<"canceled">,
                ],
            >;
            rejection_reason: ZodOptional<ZodString>;
            confirmed_at: ZodOptional<ZodISODateTime>;
            cancellation: ZodOptional<
                ZodObject<
                    {
                        canceled_at: ZodISODateTime;
                        canceled_by: ZodUnion<
                            readonly [ZodLiteral<"buyer">, ZodLiteral<"seller">],
                        >;
                        reason: ZodOptional<ZodString>;
                    },
                    $loose,
                >,
            >;
            total_budget: ZodNumber;
            packages: ZodArray<
                ZodObject<
                    {
                        package_id: ZodString;
                        product_id: ZodOptional<ZodString>;
                        budget: ZodOptional<ZodNumber>;
                        pacing: ZodOptional<
                            ZodUnion<
                                readonly [
                                    ZodLiteral<"even">,
                                    ZodLiteral<"asap">,
                                    ZodLiteral<"front_loaded">,
                                ],
                            >,
                        >;
                        pricing_option_id: ZodOptional<ZodString>;
                        bid_price: ZodOptional<ZodNumber>;
                        price_breakdown: ZodOptional<
                            ZodObject<
                                {
                                    list_price: ZodNumber;
                                    adjustments: ZodArray<ZodRecord<ZodString, ZodUnknown>>;
                                },
                                $loose,
                            >,
                        >;
                        impressions: ZodOptional<ZodNumber>;
                        catalogs: ZodOptional<
                            ZodArray<
                                ZodObject<
                                    {
                                        catalog_id: ZodOptional<ZodString>;
                                        name: ZodOptional<ZodString>;
                                        type: ZodUnion<
                                            readonly [
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                            ],
                                        >;
                                        url: ZodOptional<ZodString>;
                                        feed_format: ZodOptional<ZodUnion<(...)>>;
                                        update_frequency: ZodOptional<ZodUnion<(...)>>;
                                        items: ZodOptional<ZodArray<(...)>>;
                                        ids: ZodOptional<ZodArray<(...)>>;
                                        gtins: ZodOptional<ZodArray<(...)>>;
                                        tags: ZodOptional<ZodArray<(...)>>;
                                        category: ZodOptional<ZodString>;
                                        query: ZodOptional<ZodString>;
                                        conversion_events: ZodOptional<ZodArray<(...)>>;
                                        content_id_type: ZodOptional<ZodUnion<(...)>>;
                                        feed_field_mappings: ZodOptional<ZodArray<(...)>>;
                                    },
                                    $loose,
                                >,
                            >,
                        >;
                        format_ids: ZodOptional<
                            ZodArray<
                                ZodObject<
                                    {
                                        agent_url: ZodString;
                                        id: ZodString;
                                        width: ZodOptional<ZodNumber>;
                                        height: ZodOptional<ZodNumber>;
                                        duration_ms: ZodOptional<ZodNumber>;
                                    },
                                    $loose,
                                >,
                            >,
                        >;
                        targeting_overlay: ZodOptional<
                            ZodObject<
                                {
                                    geo_countries: ZodOptional<ZodArray<ZodString>>;
                                    geo_countries_exclude: ZodOptional<ZodArray<ZodString>>;
                                    geo_regions: ZodOptional<ZodArray<ZodString>>;
                                    geo_regions_exclude: ZodOptional<ZodArray<ZodString>>;
                                    geo_metros: ZodOptional<ZodArray<ZodObject<(...), (...)>>>;
                                    geo_metros_exclude: ZodOptional<ZodArray<ZodObject<(...), (...)>>>;
                                    geo_postal_areas: ZodOptional<ZodArray<ZodObject<(...), (...)>>>;
                                    geo_postal_areas_exclude: ZodOptional<
                                        ZodArray<ZodObject<(...), (...)>>,
                                    >;
                                    daypart_targets: ZodOptional<ZodArray<ZodObject<(...), (...)>>>;
                                    axe_include_segment: ZodOptional<ZodString>;
                                    axe_exclude_segment: ZodOptional<ZodString>;
                                    audience_include: ZodOptional<ZodArray<ZodString>>;
                                    audience_exclude: ZodOptional<ZodArray<ZodString>>;
                                    frequency_cap: ZodOptional<
                                        ZodObject<
                                            {
                                                suppress: ...;
                                                suppress_minutes: ...;
                                                max_impressions: ...;
                                                per: ...;
                                                window: ...;
                                            },
                                            $loose,
                                        >,
                                    >;
                                    property_list: ZodOptional<
                                        ZodObject<
                                            { agent_url: ...; list_id: ...; auth_token: ... },
                                            $loose,
                                        >,
                                    >;
                                    collection_list: ZodOptional<
                                        ZodObject<
                                            { agent_url: ...; list_id: ...; auth_token: ... },
                                            $loose,
                                        >,
                                    >;
                                    collection_list_exclude: ZodOptional<
                                        ZodObject<
                                            { agent_url: ...; list_id: ...; auth_token: ... },
                                            $loose,
                                        >,
                                    >;
                                    age_restriction: ZodOptional<
                                        ZodObject<
                                            { min: ...; verification_required: ...; accepted_methods: ... },
                                            $loose,
                                        >,
                                    >;
                                    device_platform: ZodOptional<ZodArray<ZodUnion<(...)>>>;
                                    device_type: ZodOptional<ZodArray<ZodUnion<(...)>>>;
                                    device_type_exclude: ZodOptional<ZodArray<ZodUnion<(...)>>>;
                                    store_catchments: ZodOptional<ZodArray<ZodObject<(...), (...)>>>;
                                    geo_proximity: ZodOptional<ZodArray<ZodRecord<(...), (...)>>>;
                                    language: ZodOptional<ZodArray<ZodString>>;
                                    keyword_targets: ZodOptional<ZodArray<ZodObject<(...), (...)>>>;
                                    negative_keywords: ZodOptional<ZodArray<ZodObject<(...), (...)>>>;
                                },
                                $loose,
                            >,
                        >;
                        measurement_terms: ZodOptional<
                            ZodObject<
                                {
                                    billing_measurement: ZodOptional<
                                        ZodObject<
                                            {
                                                vendor: ...;
                                                max_variance_percent: ...;
                                                measurement_window: ...;
                                            },
                                            $loose,
                                        >,
                                    >;
                                    makegood_policy: ZodOptional<
                                        ZodObject<{ available_remedies: ... }, $loose>,
                                    >;
                                },
                                $loose,
                            >,
                        >;
                        performance_standards: ZodOptional<
                            ZodArray<
                                ZodObject<
                                    {
                                        metric: ZodUnion<readonly [(...), (...), (...), (...), (...)]>;
                                        threshold: ZodNumber;
                                        standard: ZodOptional<ZodUnion<(...)>>;
                                        vendor: ZodObject<
                                            {
                                                domain: ...;
                                                brand_id: ...;
                                                industries: ...;
                                                data_subject_contestation: ...;
                                            },
                                            $loose,
                                        >;
                                    },
                                    $loose,
                                >,
                            >,
                        >;
                        creative_assignments: ZodOptional<
                            ZodArray<
                                ZodObject<
                                    {
                                        creative_id: ZodString;
                                        weight: ZodOptional<ZodNumber>;
                                        placement_ids: ZodOptional<ZodArray<(...)>>;
                                    },
                                    $loose,
                                >,
                            >,
                        >;
                        format_ids_to_provide: ZodOptional<
                            ZodArray<
                                ZodObject<
                                    {
                                        agent_url: ZodString;
                                        id: ZodString;
                                        width: ZodOptional<ZodNumber>;
                                        height: ZodOptional<ZodNumber>;
                                        duration_ms: ZodOptional<ZodNumber>;
                                    },
                                    $loose,
                                >,
                            >,
                        >;
                        optimization_goals: ZodOptional<
                            ZodArray<
                                ZodUnion<
                                    readonly [
                                        ZodObject<
                                            {
                                                kind: ...;
                                                metric: ...;
                                                reach_unit: ...;
                                                target_frequency: ...;
                                                view_duration_seconds: ...;
                                                target: ...;
                                                priority: ...;
                                            },
                                            $loose,
                                        >,
                                        ZodObject<
                                            {
                                                kind: ...;
                                                event_sources: ...;
                                                target: ...;
                                                attribution_window: ...;
                                                priority: ...;
                                            },
                                            $loose,
                                        >,
                                    ],
                                >,
                            >,
                        >;
                        start_time: ZodOptional<ZodISODateTime>;
                        end_time: ZodOptional<ZodISODateTime>;
                        paused: ZodOptional<ZodBoolean>;
                        canceled: ZodOptional<ZodBoolean>;
                        cancellation: ZodOptional<
                            ZodObject<
                                {
                                    canceled_at: ZodISODateTime;
                                    canceled_by: ZodUnion<
                                        readonly [ZodLiteral<(...)>, ZodLiteral<(...)>],
                                    >;
                                    reason: ZodOptional<ZodString>;
                                    acknowledged_at: ZodOptional<ZodISODateTime>;
                                },
                                $loose,
                            >,
                        >;
                        agency_estimate_number: ZodOptional<ZodString>;
                        creative_deadline: ZodOptional<ZodISODateTime>;
                        context: ZodOptional<ZodObject<{}, $loose>>;
                        ext: ZodOptional<ZodObject<{}, $loose>>;
                    },
                    $loose,
                >,
            >;
            invoice_recipient: ZodOptional<
                ZodObject<
                    {
                        legal_name: ZodString;
                        vat_id: ZodOptional<ZodString>;
                        tax_id: ZodOptional<ZodString>;
                        registration_number: ZodOptional<ZodString>;
                        address: ZodOptional<
                            ZodObject<
                                {
                                    street: ZodString;
                                    city: ZodString;
                                    postal_code: ZodString;
                                    region: ZodOptional<ZodString>;
                                    country: ZodString;
                                },
                                $loose,
                            >,
                        >;
                        contacts: ZodOptional<
                            ZodArray<
                                ZodObject<
                                    {
                                        role: ZodUnion<readonly [(...), (...), (...), (...)]>;
                                        name: ZodOptional<ZodString>;
                                        email: ZodOptional<ZodEmail>;
                                        phone: ZodOptional<ZodString>;
                                    },
                                    $loose,
                                >,
                            >,
                        >;
                        bank: ZodOptional<
                            ZodObject<
                                {
                                    account_holder: ZodString;
                                    iban: ZodOptional<ZodString>;
                                    bic: ZodOptional<ZodString>;
                                    routing_number: ZodOptional<ZodString>;
                                    account_number: ZodOptional<ZodString>;
                                },
                                $loose,
                            >,
                        >;
                        ext: ZodOptional<ZodObject<{}, $loose>>;
                    },
                    $loose,
                >,
            >;
            creative_deadline: ZodOptional<ZodISODateTime>;
            revision: ZodOptional<ZodNumber>;
            created_at: ZodOptional<ZodISODateTime>;
            updated_at: ZodOptional<ZodISODateTime>;
            ext: ZodOptional<ZodObject<{}, $loose>>;
        },
        $loose,
    > = ...