import type * as Pinnacle from "../index.js"; export interface AutofillDlcCampaignResponse { /** Whether the campaign renews automatically. */ autoRenew: boolean; /** Brand id. This identifier is a string that always begins with the prefix `b_`, for example: `b_1234567890`. */ brand?: string; /** Unique identifier for the campaign. This identifier is a string that always begins with the prefix `dlc_`, for example: `dlc_1234567890`. */ campaignId?: string; /** Description of the campaign. */ description?: string; /** Keyword response configuration. */ keywords?: AutofillDlcCampaignResponse.Keywords; /** Legal documentation links. */ links?: AutofillDlcCampaignResponse.Links; /** Describe the flow of how users will opt in to this campaign. See the [Opt-In Methods and Workflow](/guides/campaigns/opt-in-compliance#opt-in-methods-and-workflow) section for requirements. */ messageFlow?: string; /** Display name of the campaign. */ name?: string; /** Campaign configuration options. */ options?: AutofillDlcCampaignResponse.Options; /** Example messages for the campaign. See the [Sample Messages](/guides/campaigns/opt-in-compliance#sample-messages) section for requirements. */ sampleMessages?: string[]; /** Use case for the campaign. */ useCase?: AutofillDlcCampaignResponse.UseCase; } export declare namespace AutofillDlcCampaignResponse { /** * Keyword response configuration. */ interface Keywords { /** Help keyword settings. */ HELP: Keywords.Help; /** Opt-in keyword settings. */ OPT_IN: Keywords.OptIn; /** Opt-out keyword settings. */ OPT_OUT: Keywords.OptOut; } namespace Keywords { /** * Help keyword settings. */ interface Help { /** Response message for help keywords. See the [Keyword Response Messages](/guides/campaigns/opt-in-compliance#keyword-response-messages) section for requirements. */ message?: string; /** Keywords that trigger help response. */ values: string[]; } /** * Opt-in keyword settings. */ interface OptIn { /** Response message for opt-in keywords. See the [Keyword Response Messages](/guides/campaigns/opt-in-compliance#keyword-response-messages) section for requirements. */ message?: string; /** Keywords that trigger opt-in. */ values: string[]; } /** * Opt-out keyword settings. */ interface OptOut { /** Response message for opt-out keywords. See the [Keyword Response Messages](/guides/campaigns/opt-in-compliance#keyword-response-messages) section for requirements. */ message?: string; /** Keywords that trigger opt-out. */ values: string[]; } } /** * Legal documentation links. */ interface Links { /** Privacy policy URL. */ privacyPolicy?: string; /** Terms of service URL. */ termsOfService?: string; } /** * Campaign configuration options. */ interface Options { /** Whether the campaign uses affiliate marketing. */ affiliateMarketing: boolean; /** Whether the campaign is age-gated. */ ageGated: boolean; /** Whether the campaign involves direct lending. */ directLending: boolean; /** Link embedded in campaign message. */ embeddedLink?: string; /** Whether messages include phone numbers. */ embeddedPhone: boolean; /** Whether the campaign uses number pooling. */ numberPooling: boolean; } /** * Use case for the campaign. */ interface UseCase { /** Sub-use case categories. */ sub?: Pinnacle.SubUseCaseEnum[]; value?: Pinnacle.DlcCampaignUseCaseEnum; } }