nodes/generated

Interface TapfiliateNodeParameters

Source


interface TapfiliateNodeParameters {
    additionalFields?:
        | {
            addressUi?: {
                addressValues: {
                    address?: string;
                    address_two?: string;
                    city?: string;
                    country?: string;
                    postal_code?: string;
                    state?: string;
                };
            };
            companyName?: string;
        }
        | { approved?: boolean; coupon?: string };
    affiliateId?: string;
    email?: string;
    filters?:
        | {
            affiliate_group_id?: string;
            click_id?: string;
            email?: string;
            parentId?: string;
            referral_code?: string;
            source_id?: string;
        }
        | {
            affiliate_group_id?: string;
            email?: string;
            parentId?: string;
            source_id?: string;
        };
    firstname?: string;
    key?: string;
    lastname?: string;
    limit?: number;
    metadataUi?: {
        metadataValues: { key?: string; value?: string }[];
    };
    operation?: | "create"
    | "get"
    | "getAll"
    | "update"
    | "add"
    | "remove"
    | "delete"
    | "approve"
    | "disapprove";
    programId?: string;
    resource?: | "affiliate"
    | "affiliateMetadata"
    | "programAffiliate";
    returnAll?: boolean;
    value?: string;
}

Properties§

§readonly additionalFields?:
    | {
        addressUi?: {
            addressValues: {
                address?: string;
                address_two?: string;
                city?: string;
                country?: string;
                postal_code?: string;
                state?: string;
            };
        };
        companyName?: string;
    }
    | { approved?: boolean; coupon?: string }

Default: {}

§readonly affiliateId?: string

The ID of the affiliate

§readonly email?: string

The affiliate’s email

§readonly filters?:
    | {
        affiliate_group_id?: string;
        click_id?: string;
        email?: string;
        parentId?: string;
        referral_code?: string;
        source_id?: string;
    }
    | {
        affiliate_group_id?: string;
        email?: string;
        parentId?: string;
        source_id?: string;
    }

Default: {}

§readonly firstname?: string

The affiliate’s firstname

§readonly key?: string

Name of the metadata key to remove

§readonly lastname?: string

The affiliate’s lastname

§readonly limit?: number

Max number of results to return Default: 100 Type options: {"minValue":1,"maxValue":1000}

§readonly metadataUi?: { ... }

Meta data Default: {} Type options: {"multipleValues":true}

§readonly operation?:
    | "create"
    | "get"
    | "getAll"
    | "update"
    | "add"
    | "remove"
    | "delete"
    | "approve"
    | "disapprove"

Default: "create"

§readonly programId?: string

The ID of the Program to add the affiliate to. This ID can be found as part of the URL when viewing the program on the platform. Choose from the list, or specify an ID using an expression. Type options: {"loadOptionsMethod":"getPrograms"}

§readonly resource?: "affiliate" | "affiliateMetadata" | "programAffiliate"

Default: "affiliate"

§readonly returnAll?: boolean

Whether to return all results or only up to a given limit

§readonly value?: string

Value to set for the metadata key