@basetime/a2w-api-ts/dist/types/Campaign.d.ts

Client library that communicates with the addtowallet API.

import { z } from 'zod';
/**
 * Schema for the details of a campaign.
 */
export declare const CampaignSchema: z.ZodObject<{
    id: z.ZodString;
    name: z.ZodString;
    client: z.ZodObject<{
        id: z.ZodString;
        name: z.ZodString;
        logoUrl: z.ZodString;
        domain: z.ZodNullable<z.ZodObject<{
            organization: z.ZodString;
            name: z.ZodString;
            domain: z.ZodString;
            hostname: z.ZodString;
            homepageRedirectUrl: z.ZodString;
            cNameVerification: z.ZodString;
            cNameDomain: z.ZodString;
            isProcessing: z.ZodBoolean;
            status: z.ZodEnum<{
                valid: "valid";
                invalid: "invalid";
                pending: "pending";
                still_pending: "still_pending";
            }>;
            isActive: z.ZodBoolean;
            isDeleted: z.ZodBoolean;
            validationDate: z.ZodOptional<z.ZodCoercedDate<unknown>>;
            firstChecked: z.ZodOptional<z.ZodCoercedDate<unknown>>;
        }, z.core.$loose>>;
        backgroundColor: z.ZodString;
        favIcon16: z.ZodString;
        favIcon32: z.ZodString;
        favIcon48: z.ZodString;
        favIcon120: z.ZodString;
        favIcon240: z.ZodString;
        defaultProximityUUID: z.ZodString;
        termsHtml: z.ZodString;
        privacyHtml: z.ZodString;
        headerPixels: z.ZodOptional<z.ZodString>;
        footerPixels: z.ZodOptional<z.ZodString>;
        owner: z.ZodString;
        ownerUser: z.ZodOptional<z.ZodObject<{
            id: z.ZodString;
            displayName: z.ZodString;
            email: z.ZodString;
            photoURL: z.ZodString;
            avatarColor: z.ZodString;
            organizations: z.ZodArray<z.ZodString>;
            clientsDisplay: z.ZodArray<z.ZodString>;
            dateLastLogin: z.ZodCoercedDate<unknown>;
        }, z.core.$loose>>;
        admins: z.ZodArray<z.ZodString>;
        editors: z.ZodArray<z.ZodString>;
        joinCode: z.ZodString;
    }, z.core.$loose>;
    templates: z.ZodArray<z.ZodObject<{
        id: z.ZodString;
        name: z.ZodString;
        version: z.ZodNumber;
        versionID: z.ZodString;
        files: z.ZodRecord<z.ZodString, z.ZodString>;
        templateUrls: z.ZodRecord<z.ZodString, z.ZodString>;
        attributes: z.ZodArray<z.ZodObject<{
            key: z.ZodString;
            value: z.ZodString;
            type: z.ZodEnum<{
                boolean: "boolean";
                color: "color";
                image: "image";
                text: "text";
            }>;
        }, z.core.$loose>>;
        apple: z.ZodRecord<z.ZodString, z.ZodUnknown>;
        google: z.ZodObject<{
            id: z.ZodString;
        }, z.core.$loose>;
        relevantDateOverride: z.ZodOptional<z.ZodString>;
        expirationDateOverride: z.ZodOptional<z.ZodString>;
        organization: z.ZodObject<{
            id: z.ZodString;
            name: z.ZodString;
            logoUrl: z.ZodString;
            domain: z.ZodNullable<z.ZodObject<{
                organization: z.ZodString;
                name: z.ZodString;
                domain: z.ZodString;
                hostname: z.ZodString;
                homepageRedirectUrl: z.ZodString;
                cNameVerification: z.ZodString;
                cNameDomain: z.ZodString;
                isProcessing: z.ZodBoolean;
                status: z.ZodEnum<{
                    valid: "valid";
                    invalid: "invalid";
                    pending: "pending";
                    still_pending: "still_pending";
                }>;
                isActive: z.ZodBoolean;
                isDeleted: z.ZodBoolean;
                validationDate: z.ZodOptional<z.ZodCoercedDate<unknown>>;
                firstChecked: z.ZodOptional<z.ZodCoercedDate<unknown>>;
            }, z.core.$loose>>;
            backgroundColor: z.ZodString;
            favIcon16: z.ZodString;
            favIcon32: z.ZodString;
            favIcon48: z.ZodString;
            favIcon120: z.ZodString;
            favIcon240: z.ZodString;
            defaultProximityUUID: z.ZodString;
            termsHtml: z.ZodString;
            privacyHtml: z.ZodString;
            headerPixels: z.ZodOptional<z.ZodString>;
            footerPixels: z.ZodOptional<z.ZodString>;
            owner: z.ZodString;
            ownerUser: z.ZodOptional<z.ZodObject<{
                id: z.ZodString;
                displayName: z.ZodString;
                email: z.ZodString;
                photoURL: z.ZodString;
                avatarColor: z.ZodString;
                organizations: z.ZodArray<z.ZodString>;
                clientsDisplay: z.ZodArray<z.ZodString>;
                dateLastLogin: z.ZodCoercedDate<unknown>;
            }, z.core.$loose>>;
            admins: z.ZodArray<z.ZodString>;
            editors: z.ZodArray<z.ZodString>;
            joinCode: z.ZodString;
        }, z.core.$loose>;
        folder: z.ZodString;
        sessionId: z.ZodString;
        screenshotUrl: z.ZodOptional<z.ZodString>;
        screenshotAppleUrl: z.ZodOptional<z.ZodString>;
        screenshotAndroidUrl: z.ZodOptional<z.ZodString>;
        pdfUrl: z.ZodOptional<z.ZodString>;
        pdfAppleUrl: z.ZodOptional<z.ZodString>;
        pdfAndroidUrl: z.ZodOptional<z.ZodString>;
        updatedDate: z.ZodCoercedDate<unknown>;
        isPublicShare: z.ZodBoolean;
        status: z.ZodString;
        assignee: z.ZodOptional<z.ZodNullable<z.ZodObject<{
            id: z.ZodString;
            displayName: z.ZodString;
            email: z.ZodString;
            photoURL: z.ZodString;
            avatarColor: z.ZodString;
            organizations: z.ZodArray<z.ZodString>;
            clientsDisplay: z.ZodArray<z.ZodString>;
            dateLastLogin: z.ZodCoercedDate<unknown>;
        }, z.core.$loose>>>;
        createdBy: z.ZodOptional<z.ZodNullable<z.ZodObject<{
            id: z.ZodString;
            displayName: z.ZodString;
            email: z.ZodString;
            photoURL: z.ZodString;
            avatarColor: z.ZodString;
            organizations: z.ZodArray<z.ZodString>;
            clientsDisplay: z.ZodArray<z.ZodString>;
            dateLastLogin: z.ZodCoercedDate<unknown>;
        }, z.core.$loose>>>;
        labels: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
    }, z.core.$loose>>;
    landingPage: z.ZodString;
    primaryKey: z.ZodString;
    tags: z.ZodArray<z.ZodString>;
    description: z.ZodString;
    headerPixels: z.ZodOptional<z.ZodString>;
    footerPixels: z.ZodOptional<z.ZodString>;
    openEnrollment: z.ZodBoolean;
    openEnrollmentLandingPage: z.ZodString;
    openEnrollmentPermalink: z.ZodString;
    openEnrollmentJwtSecret: z.ZodString;
    importDataSource: z.ZodString;
    exportDataSource: z.ZodString;
    importConfig: z.ZodUnknown;
    exportConfig: z.ZodUnknown;
    jobNotifications: z.ZodString;
    passesCount: z.ZodNumber;
    claimedCount: z.ZodNumber;
    registeredCount: z.ZodNumber;
    enrolledCount: z.ZodNumber;
    isDeleted: z.ZodBoolean;
    passTypeIdentifier: z.ZodString;
    googleIssuer: z.ZodString;
    runningDate: z.ZodNullable<z.ZodCoercedDate<unknown>>;
    templateLastChangeDate: z.ZodNullable<z.ZodCoercedDate<unknown>>;
    templateCurrentChangeDate: z.ZodNullable<z.ZodCoercedDate<unknown>>;
    schedule: z.ZodOptional<z.ZodObject<{
        when: z.ZodUnion<readonly [z.ZodEnum<{
            daily: "daily";
            "daily-except-weekends": "daily-except-weekends";
            weekly: "weekly";
            monthly: "monthly";
        }>, z.ZodLiteral<"">]>;
        weekday: z.ZodString;
        monthday: z.ZodString;
        time: z.ZodString;
    }, z.core.$loose>>;
    folder: z.ZodString;
    stats: z.ZodObject<{
        countMacType: z.ZodNumber;
        countWindowsType: z.ZodNumber;
        countLinuxType: z.ZodNumber;
        countMobileType: z.ZodNumber;
        countDesktopType: z.ZodNumber;
        countWearableType: z.ZodNumber;
        countTabletType: z.ZodNumber;
        countAndroidType: z.ZodNumber;
        countIOSType: z.ZodNumber;
        countWinPhoneType: z.ZodNumber;
    }, z.core.$loose>;
    browsers: z.ZodRecord<z.ZodString, z.ZodNumber>;
    countries: z.ZodRecord<z.ZodString, z.ZodNumber>;
    states: z.ZodRecord<z.ZodString, z.ZodNumber>;
    createdDate: z.ZodCoercedDate<unknown>;
}, z.core.$loose>;
/**
 * The details of a campaign.
 */
export type Campaign = z.infer<typeof CampaignSchema>;