dub 0.34.2 → 0.36.0

package/dist/esm/models/components/linkschema.d.ts

@@ -0,0 +1,752 @@
+import { TagSchema, TagSchema$Outbound } from "./tagschema.js";
+import * as z from "zod";
+/**
+ * Geo targeting information for the short link in JSON format `{[COUNTRY]: https://example.com }`. Learn more: https://d.to/geo
+ */
+export type Geo = {
+    af?: string | undefined;
+    al?: string | undefined;
+    dz?: string | undefined;
+    as?: string | undefined;
+    ad?: string | undefined;
+    ao?: string | undefined;
+    ai?: string | undefined;
+    aq?: string | undefined;
+    ag?: string | undefined;
+    ar?: string | undefined;
+    am?: string | undefined;
+    aw?: string | undefined;
+    au?: string | undefined;
+    at?: string | undefined;
+    az?: string | undefined;
+    bs?: string | undefined;
+    bh?: string | undefined;
+    bd?: string | undefined;
+    bb?: string | undefined;
+    by?: string | undefined;
+    be?: string | undefined;
+    bz?: string | undefined;
+    bj?: string | undefined;
+    bm?: string | undefined;
+    bt?: string | undefined;
+    bo?: string | undefined;
+    ba?: string | undefined;
+    bw?: string | undefined;
+    bv?: string | undefined;
+    br?: string | undefined;
+    io?: string | undefined;
+    bn?: string | undefined;
+    bg?: string | undefined;
+    bf?: string | undefined;
+    bi?: string | undefined;
+    kh?: string | undefined;
+    cm?: string | undefined;
+    ca?: string | undefined;
+    cv?: string | undefined;
+    ky?: string | undefined;
+    cf?: string | undefined;
+    td?: string | undefined;
+    cl?: string | undefined;
+    cn?: string | undefined;
+    cx?: string | undefined;
+    cc?: string | undefined;
+    co?: string | undefined;
+    km?: string | undefined;
+    cg?: string | undefined;
+    cd?: string | undefined;
+    ck?: string | undefined;
+    cr?: string | undefined;
+    ci?: string | undefined;
+    hr?: string | undefined;
+    cu?: string | undefined;
+    cy?: string | undefined;
+    cz?: string | undefined;
+    dk?: string | undefined;
+    dj?: string | undefined;
+    dm?: string | undefined;
+    do?: string | undefined;
+    ec?: string | undefined;
+    eg?: string | undefined;
+    sv?: string | undefined;
+    gq?: string | undefined;
+    er?: string | undefined;
+    ee?: string | undefined;
+    et?: string | undefined;
+    fk?: string | undefined;
+    fo?: string | undefined;
+    fj?: string | undefined;
+    fi?: string | undefined;
+    fr?: string | undefined;
+    gf?: string | undefined;
+    pf?: string | undefined;
+    tf?: string | undefined;
+    ga?: string | undefined;
+    gm?: string | undefined;
+    ge?: string | undefined;
+    de?: string | undefined;
+    gh?: string | undefined;
+    gi?: string | undefined;
+    gr?: string | undefined;
+    gl?: string | undefined;
+    gd?: string | undefined;
+    gp?: string | undefined;
+    gu?: string | undefined;
+    gt?: string | undefined;
+    gn?: string | undefined;
+    gw?: string | undefined;
+    gy?: string | undefined;
+    ht?: string | undefined;
+    hm?: string | undefined;
+    va?: string | undefined;
+    hn?: string | undefined;
+    hk?: string | undefined;
+    hu?: string | undefined;
+    is?: string | undefined;
+    in?: string | undefined;
+    id?: string | undefined;
+    ir?: string | undefined;
+    iq?: string | undefined;
+    ie?: string | undefined;
+    il?: string | undefined;
+    it?: string | undefined;
+    jm?: string | undefined;
+    jp?: string | undefined;
+    jo?: string | undefined;
+    kz?: string | undefined;
+    ke?: string | undefined;
+    ki?: string | undefined;
+    kp?: string | undefined;
+    kr?: string | undefined;
+    kw?: string | undefined;
+    kg?: string | undefined;
+    la?: string | undefined;
+    lv?: string | undefined;
+    lb?: string | undefined;
+    ls?: string | undefined;
+    lr?: string | undefined;
+    ly?: string | undefined;
+    li?: string | undefined;
+    lt?: string | undefined;
+    lu?: string | undefined;
+    mo?: string | undefined;
+    mg?: string | undefined;
+    mw?: string | undefined;
+    my?: string | undefined;
+    mv?: string | undefined;
+    ml?: string | undefined;
+    mt?: string | undefined;
+    mh?: string | undefined;
+    mq?: string | undefined;
+    mr?: string | undefined;
+    mu?: string | undefined;
+    yt?: string | undefined;
+    mx?: string | undefined;
+    fm?: string | undefined;
+    md?: string | undefined;
+    mc?: string | undefined;
+    mn?: string | undefined;
+    ms?: string | undefined;
+    ma?: string | undefined;
+    mz?: string | undefined;
+    mm?: string | undefined;
+    na?: string | undefined;
+    nr?: string | undefined;
+    np?: string | undefined;
+    nl?: string | undefined;
+    nc?: string | undefined;
+    nz?: string | undefined;
+    ni?: string | undefined;
+    ne?: string | undefined;
+    ng?: string | undefined;
+    nu?: string | undefined;
+    nf?: string | undefined;
+    mk?: string | undefined;
+    mp?: string | undefined;
+    no?: string | undefined;
+    om?: string | undefined;
+    pk?: string | undefined;
+    pw?: string | undefined;
+    ps?: string | undefined;
+    pa?: string | undefined;
+    pg?: string | undefined;
+    py?: string | undefined;
+    pe?: string | undefined;
+    ph?: string | undefined;
+    pn?: string | undefined;
+    pl?: string | undefined;
+    pt?: string | undefined;
+    pr?: string | undefined;
+    qa?: string | undefined;
+    re?: string | undefined;
+    ro?: string | undefined;
+    ru?: string | undefined;
+    rw?: string | undefined;
+    sh?: string | undefined;
+    kn?: string | undefined;
+    lc?: string | undefined;
+    pm?: string | undefined;
+    vc?: string | undefined;
+    ws?: string | undefined;
+    sm?: string | undefined;
+    st?: string | undefined;
+    sa?: string | undefined;
+    sn?: string | undefined;
+    sc?: string | undefined;
+    sl?: string | undefined;
+    sg?: string | undefined;
+    sk?: string | undefined;
+    si?: string | undefined;
+    sb?: string | undefined;
+    so?: string | undefined;
+    za?: string | undefined;
+    gs?: string | undefined;
+    es?: string | undefined;
+    lk?: string | undefined;
+    sd?: string | undefined;
+    sr?: string | undefined;
+    sj?: string | undefined;
+    sz?: string | undefined;
+    se?: string | undefined;
+    ch?: string | undefined;
+    sy?: string | undefined;
+    tw?: string | undefined;
+    tj?: string | undefined;
+    tz?: string | undefined;
+    th?: string | undefined;
+    tl?: string | undefined;
+    tg?: string | undefined;
+    tk?: string | undefined;
+    to?: string | undefined;
+    tt?: string | undefined;
+    tn?: string | undefined;
+    tr?: string | undefined;
+    tm?: string | undefined;
+    tc?: string | undefined;
+    tv?: string | undefined;
+    ug?: string | undefined;
+    ua?: string | undefined;
+    ae?: string | undefined;
+    gb?: string | undefined;
+    us?: string | undefined;
+    um?: string | undefined;
+    uy?: string | undefined;
+    uz?: string | undefined;
+    vu?: string | undefined;
+    ve?: string | undefined;
+    vn?: string | undefined;
+    vg?: string | undefined;
+    vi?: string | undefined;
+    wf?: string | undefined;
+    eh?: string | undefined;
+    ye?: string | undefined;
+    zm?: string | undefined;
+    zw?: string | undefined;
+    ax?: string | undefined;
+    bq?: string | undefined;
+    cw?: string | undefined;
+    gg?: string | undefined;
+    im?: string | undefined;
+    je?: string | undefined;
+    me?: string | undefined;
+    bl?: string | undefined;
+    mf?: string | undefined;
+    rs?: string | undefined;
+    sx?: string | undefined;
+    ss?: string | undefined;
+    xk?: string | undefined;
+};
+export type LinkSchema = {
+    /**
+     * The unique ID of the short link.
+     */
+    id: string;
+    /**
+     * The domain of the short link. If not provided, the primary domain for the workspace will be used (or `dub.sh` if the workspace has no domains).
+     */
+    domain: string;
+    /**
+     * The short link slug. If not provided, a random 7-character slug will be generated.
+     */
+    key: string;
+    /**
+     * This is the ID of the link in your database. If set, it can be used to identify the link in the future. Must be prefixed with 'ext_' when passed as a query parameter.
+     */
+    externalId: string | null;
+    /**
+     * The destination URL of the short link.
+     */
+    url: string;
+    /**
+     * [BETA] Whether to track conversions for the short link.
+     */
+    trackConversion?: boolean | undefined;
+    /**
+     * Whether the short link is archived.
+     */
+    archived?: boolean | undefined;
+    /**
+     * The date and time when the short link will expire in ISO-8601 format.
+     */
+    expiresAt: string | null;
+    /**
+     * The URL to redirect to when the short link has expired.
+     */
+    expiredUrl: string | null;
+    /**
+     * The password required to access the destination URL of the short link.
+     */
+    password: string | null;
+    /**
+     * Whether the short link uses Custom Social Media Cards feature.
+     */
+    proxy?: boolean | undefined;
+    /**
+     * The title of the short link generated via `api.dub.co/metatags`. Will be used for Custom Social Media Cards if `proxy` is true.
+     */
+    title: string | null;
+    /**
+     * The description of the short link generated via `api.dub.co/metatags`. Will be used for Custom Social Media Cards if `proxy` is true.
+     */
+    description: string | null;
+    /**
+     * The image of the short link generated via `api.dub.co/metatags`. Will be used for Custom Social Media Cards if `proxy` is true.
+     */
+    image: string | null;
+    /**
+     * The custom link preview video (og:video). Will be used for Custom Social Media Cards if `proxy` is true. Learn more: https://d.to/og
+     */
+    video: string | null;
+    /**
+     * Whether the short link uses link cloaking.
+     */
+    rewrite?: boolean | undefined;
+    /**
+     * Whether to allow search engines to index the short link.
+     */
+    doIndex?: boolean | undefined;
+    /**
+     * The iOS destination URL for the short link for iOS device targeting.
+     */
+    ios: string | null;
+    /**
+     * The Android destination URL for the short link for Android device targeting.
+     */
+    android: string | null;
+    /**
+     * Geo targeting information for the short link in JSON format `{[COUNTRY]: https://example.com }`. Learn more: https://d.to/geo
+     */
+    geo: Geo | null;
+    /**
+     * Whether the short link's stats are publicly accessible.
+     */
+    publicStats?: boolean | undefined;
+    /**
+     * The unique ID of the tag assigned to the short link. This field is deprecated – use `tags` instead.
+     *
+     * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
+     */
+    tagId: string | null;
+    /**
+     * The tags assigned to the short link.
+     */
+    tags: Array<TagSchema> | null;
+    /**
+     * The comments for the short link.
+     */
+    comments: string | null;
+    /**
+     * The full URL of the short link, including the https protocol (e.g. `https://dub.sh/try`).
+     */
+    shortLink: string;
+    /**
+     * The full URL of the QR code for the short link (e.g. `https://api.dub.co/qr?url=https://dub.sh/try`).
+     */
+    qrCode: string;
+    /**
+     * The UTM source of the short link.
+     */
+    utmSource: string | null;
+    /**
+     * The UTM medium of the short link.
+     */
+    utmMedium: string | null;
+    /**
+     * The UTM campaign of the short link.
+     */
+    utmCampaign: string | null;
+    /**
+     * The UTM term of the short link.
+     */
+    utmTerm: string | null;
+    /**
+     * The UTM content of the short link.
+     */
+    utmContent: string | null;
+    /**
+     * The user ID of the creator of the short link.
+     */
+    userId: string;
+    /**
+     * The workspace ID of the short link.
+     */
+    workspaceId: string;
+    /**
+     * The number of clicks on the short link.
+     */
+    clicks?: number | undefined;
+    /**
+     * The date and time when the short link was last clicked.
+     */
+    lastClicked: string | null;
+    /**
+     * [BETA]: The number of leads the short links has generated.
+     */
+    leads?: number | undefined;
+    /**
+     * [BETA]: The number of sales the short links has generated.
+     */
+    sales?: number | undefined;
+    /**
+     * The date and time when the short link was created.
+     */
+    createdAt: string;
+    /**
+     * The date and time when the short link was last updated.
+     */
+    updatedAt: string;
+    /**
+     * The project ID of the short link. This field is deprecated – use `workspaceId` instead.
+     *
+     * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
+     */
+    projectId: string;
+};
+/** @internal */
+export declare const Geo$inboundSchema: z.ZodType<Geo, z.ZodTypeDef, unknown>;
+/** @internal */
+export type Geo$Outbound = {
+    AF?: string | undefined;
+    AL?: string | undefined;
+    DZ?: string | undefined;
+    AS?: string | undefined;
+    AD?: string | undefined;
+    AO?: string | undefined;
+    AI?: string | undefined;
+    AQ?: string | undefined;
+    AG?: string | undefined;
+    AR?: string | undefined;
+    AM?: string | undefined;
+    AW?: string | undefined;
+    AU?: string | undefined;
+    AT?: string | undefined;
+    AZ?: string | undefined;
+    BS?: string | undefined;
+    BH?: string | undefined;
+    BD?: string | undefined;
+    BB?: string | undefined;
+    BY?: string | undefined;
+    BE?: string | undefined;
+    BZ?: string | undefined;
+    BJ?: string | undefined;
+    BM?: string | undefined;
+    BT?: string | undefined;
+    BO?: string | undefined;
+    BA?: string | undefined;
+    BW?: string | undefined;
+    BV?: string | undefined;
+    BR?: string | undefined;
+    IO?: string | undefined;
+    BN?: string | undefined;
+    BG?: string | undefined;
+    BF?: string | undefined;
+    BI?: string | undefined;
+    KH?: string | undefined;
+    CM?: string | undefined;
+    CA?: string | undefined;
+    CV?: string | undefined;
+    KY?: string | undefined;
+    CF?: string | undefined;
+    TD?: string | undefined;
+    CL?: string | undefined;
+    CN?: string | undefined;
+    CX?: string | undefined;
+    CC?: string | undefined;
+    CO?: string | undefined;
+    KM?: string | undefined;
+    CG?: string | undefined;
+    CD?: string | undefined;
+    CK?: string | undefined;
+    CR?: string | undefined;
+    CI?: string | undefined;
+    HR?: string | undefined;
+    CU?: string | undefined;
+    CY?: string | undefined;
+    CZ?: string | undefined;
+    DK?: string | undefined;
+    DJ?: string | undefined;
+    DM?: string | undefined;
+    DO?: string | undefined;
+    EC?: string | undefined;
+    EG?: string | undefined;
+    SV?: string | undefined;
+    GQ?: string | undefined;
+    ER?: string | undefined;
+    EE?: string | undefined;
+    ET?: string | undefined;
+    FK?: string | undefined;
+    FO?: string | undefined;
+    FJ?: string | undefined;
+    FI?: string | undefined;
+    FR?: string | undefined;
+    GF?: string | undefined;
+    PF?: string | undefined;
+    TF?: string | undefined;
+    GA?: string | undefined;
+    GM?: string | undefined;
+    GE?: string | undefined;
+    DE?: string | undefined;
+    GH?: string | undefined;
+    GI?: string | undefined;
+    GR?: string | undefined;
+    GL?: string | undefined;
+    GD?: string | undefined;
+    GP?: string | undefined;
+    GU?: string | undefined;
+    GT?: string | undefined;
+    GN?: string | undefined;
+    GW?: string | undefined;
+    GY?: string | undefined;
+    HT?: string | undefined;
+    HM?: string | undefined;
+    VA?: string | undefined;
+    HN?: string | undefined;
+    HK?: string | undefined;
+    HU?: string | undefined;
+    IS?: string | undefined;
+    IN?: string | undefined;
+    ID?: string | undefined;
+    IR?: string | undefined;
+    IQ?: string | undefined;
+    IE?: string | undefined;
+    IL?: string | undefined;
+    IT?: string | undefined;
+    JM?: string | undefined;
+    JP?: string | undefined;
+    JO?: string | undefined;
+    KZ?: string | undefined;
+    KE?: string | undefined;
+    KI?: string | undefined;
+    KP?: string | undefined;
+    KR?: string | undefined;
+    KW?: string | undefined;
+    KG?: string | undefined;
+    LA?: string | undefined;
+    LV?: string | undefined;
+    LB?: string | undefined;
+    LS?: string | undefined;
+    LR?: string | undefined;
+    LY?: string | undefined;
+    LI?: string | undefined;
+    LT?: string | undefined;
+    LU?: string | undefined;
+    MO?: string | undefined;
+    MG?: string | undefined;
+    MW?: string | undefined;
+    MY?: string | undefined;
+    MV?: string | undefined;
+    ML?: string | undefined;
+    MT?: string | undefined;
+    MH?: string | undefined;
+    MQ?: string | undefined;
+    MR?: string | undefined;
+    MU?: string | undefined;
+    YT?: string | undefined;
+    MX?: string | undefined;
+    FM?: string | undefined;
+    MD?: string | undefined;
+    MC?: string | undefined;
+    MN?: string | undefined;
+    MS?: string | undefined;
+    MA?: string | undefined;
+    MZ?: string | undefined;
+    MM?: string | undefined;
+    NA?: string | undefined;
+    NR?: string | undefined;
+    NP?: string | undefined;
+    NL?: string | undefined;
+    NC?: string | undefined;
+    NZ?: string | undefined;
+    NI?: string | undefined;
+    NE?: string | undefined;
+    NG?: string | undefined;
+    NU?: string | undefined;
+    NF?: string | undefined;
+    MK?: string | undefined;
+    MP?: string | undefined;
+    NO?: string | undefined;
+    OM?: string | undefined;
+    PK?: string | undefined;
+    PW?: string | undefined;
+    PS?: string | undefined;
+    PA?: string | undefined;
+    PG?: string | undefined;
+    PY?: string | undefined;
+    PE?: string | undefined;
+    PH?: string | undefined;
+    PN?: string | undefined;
+    PL?: string | undefined;
+    PT?: string | undefined;
+    PR?: string | undefined;
+    QA?: string | undefined;
+    RE?: string | undefined;
+    RO?: string | undefined;
+    RU?: string | undefined;
+    RW?: string | undefined;
+    SH?: string | undefined;
+    KN?: string | undefined;
+    LC?: string | undefined;
+    PM?: string | undefined;
+    VC?: string | undefined;
+    WS?: string | undefined;
+    SM?: string | undefined;
+    ST?: string | undefined;
+    SA?: string | undefined;
+    SN?: string | undefined;
+    SC?: string | undefined;
+    SL?: string | undefined;
+    SG?: string | undefined;
+    SK?: string | undefined;
+    SI?: string | undefined;
+    SB?: string | undefined;
+    SO?: string | undefined;
+    ZA?: string | undefined;
+    GS?: string | undefined;
+    ES?: string | undefined;
+    LK?: string | undefined;
+    SD?: string | undefined;
+    SR?: string | undefined;
+    SJ?: string | undefined;
+    SZ?: string | undefined;
+    SE?: string | undefined;
+    CH?: string | undefined;
+    SY?: string | undefined;
+    TW?: string | undefined;
+    TJ?: string | undefined;
+    TZ?: string | undefined;
+    TH?: string | undefined;
+    TL?: string | undefined;
+    TG?: string | undefined;
+    TK?: string | undefined;
+    TO?: string | undefined;
+    TT?: string | undefined;
+    TN?: string | undefined;
+    TR?: string | undefined;
+    TM?: string | undefined;
+    TC?: string | undefined;
+    TV?: string | undefined;
+    UG?: string | undefined;
+    UA?: string | undefined;
+    AE?: string | undefined;
+    GB?: string | undefined;
+    US?: string | undefined;
+    UM?: string | undefined;
+    UY?: string | undefined;
+    UZ?: string | undefined;
+    VU?: string | undefined;
+    VE?: string | undefined;
+    VN?: string | undefined;
+    VG?: string | undefined;
+    VI?: string | undefined;
+    WF?: string | undefined;
+    EH?: string | undefined;
+    YE?: string | undefined;
+    ZM?: string | undefined;
+    ZW?: string | undefined;
+    AX?: string | undefined;
+    BQ?: string | undefined;
+    CW?: string | undefined;
+    GG?: string | undefined;
+    IM?: string | undefined;
+    JE?: string | undefined;
+    ME?: string | undefined;
+    BL?: string | undefined;
+    MF?: string | undefined;
+    RS?: string | undefined;
+    SX?: string | undefined;
+    SS?: string | undefined;
+    XK?: string | undefined;
+};
+/** @internal */
+export declare const Geo$outboundSchema: z.ZodType<Geo$Outbound, z.ZodTypeDef, Geo>;
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export declare namespace Geo$ {
+    /** @deprecated use `Geo$inboundSchema` instead. */
+    const inboundSchema: z.ZodType<Geo, z.ZodTypeDef, unknown>;
+    /** @deprecated use `Geo$outboundSchema` instead. */
+    const outboundSchema: z.ZodType<Geo$Outbound, z.ZodTypeDef, Geo>;
+    /** @deprecated use `Geo$Outbound` instead. */
+    type Outbound = Geo$Outbound;
+}
+/** @internal */
+export declare const LinkSchema$inboundSchema: z.ZodType<LinkSchema, z.ZodTypeDef, unknown>;
+/** @internal */
+export type LinkSchema$Outbound = {
+    id: string;
+    domain: string;
+    key: string;
+    externalId: string | null;
+    url: string;
+    trackConversion: boolean;
+    archived: boolean;
+    expiresAt: string | null;
+    expiredUrl: string | null;
+    password: string | null;
+    proxy: boolean;
+    title: string | null;
+    description: string | null;
+    image: string | null;
+    video: string | null;
+    rewrite: boolean;
+    doIndex: boolean;
+    ios: string | null;
+    android: string | null;
+    geo: Geo$Outbound | null;
+    publicStats: boolean;
+    tagId: string | null;
+    tags: Array<TagSchema$Outbound> | null;
+    comments: string | null;
+    shortLink: string;
+    qrCode: string;
+    utm_source: string | null;
+    utm_medium: string | null;
+    utm_campaign: string | null;
+    utm_term: string | null;
+    utm_content: string | null;
+    userId: string;
+    workspaceId: string;
+    clicks: number;
+    lastClicked: string | null;
+    leads: number;
+    sales: number;
+    createdAt: string;
+    updatedAt: string;
+    projectId: string;
+};
+/** @internal */
+export declare const LinkSchema$outboundSchema: z.ZodType<LinkSchema$Outbound, z.ZodTypeDef, LinkSchema>;
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export declare namespace LinkSchema$ {
+    /** @deprecated use `LinkSchema$inboundSchema` instead. */
+    const inboundSchema: z.ZodType<LinkSchema, z.ZodTypeDef, unknown>;
+    /** @deprecated use `LinkSchema$outboundSchema` instead. */
+    const outboundSchema: z.ZodType<LinkSchema$Outbound, z.ZodTypeDef, LinkSchema>;
+    /** @deprecated use `LinkSchema$Outbound` instead. */
+    type Outbound = LinkSchema$Outbound;
+}
+//# sourceMappingURL=linkschema.d.ts.map