Interface OneSimpleApiNodeParameters

Source
interface OneSimpleApiNodeParameters {
    artistName?: string;
    download?: boolean;
    emailAddress?: string;
    fromCurrency?: string;
    link?: string;
    message?: string;
    operation?:
        | "screenshot"
        | "pdf"
        | "seo"
        | "instagramProfile"
        | "spotifyArtistProfile"
        | "exchangeRate"
        | "imageMetadata"
        | "expandURL"
        | "qrCode"
        | "validateEmail";
    options?: | {
        force?: boolean;
        page?: | "A0"
        | "A1"
        | "A2"
        | "A3"
        | "A4"
        | "A5"
        | "A6"
        | "Ledger"
        | "Legal"
        | "Letter"
        | "Tabloid";
    }
    | {
        format?: "PNG"
        | "SVG";
        size?: "Small" | "Medium" | "Large";
    }
    | {
        force?: boolean;
        fullpage?: boolean;
        screen?: | "phone"
        | "phone-landscape"
        | "retina"
        | "tablet"
        | "tablet-landscape";
    }
    | { headers?: boolean };
    output?: string;
    profileName?: string;
    resource?:
        | "website"
        | "information"
        | "socialProfile"
        | "utility";
    toCurrency?: string;
    value?: string;
}

Properties§

Source§

readonly artistName?: string

Artist name to get details for

Source§

readonly download?: boolean

Whether to download the PDF or return a link to it

Source§

readonly emailAddress?: string

Source§

readonly fromCurrency?: string

Link to webpage to convert

Source§

readonly message?: string

The text that should be turned into a QR code - like a website URL

Source§

readonly operation?:
    | "screenshot"
    | "pdf"
    | "seo"
    | "instagramProfile"
    | "spotifyArtistProfile"
    | "exchangeRate"
    | "imageMetadata"
    | "expandURL"
    | "qrCode"
    | "validateEmail"

Default: "pdf"

Source§

readonly options?:
    | {
        force?: boolean;
        page?: | "A0"
        | "A1"
        | "A2"
        | "A3"
        | "A4"
        | "A5"
        | "A6"
        | "Ledger"
        | "Legal"
        | "Letter"
        | "Tabloid";
    }
    | {
        format?: "PNG"
        | "SVG";
        size?: "Small" | "Medium" | "Large";
    }
    | {
        force?: boolean;
        fullpage?: boolean;
        screen?: | "phone"
        | "phone-landscape"
        | "retina"
        | "tablet"
        | "tablet-landscape";
    }
    | { headers?: boolean }

Default: {}

Source§

readonly output?: string

The name of the output field to put the binary file data in Default: "data"

Source§

readonly profileName?: string

Profile name to get details of

Source§

readonly resource?: "website" | "information" | "socialProfile" | "utility"

Default: "website"

Source§

readonly toCurrency?: string

Source§

readonly value?: string

Value to convert