dub 0.28.1 → 0.29.2

package/models/operations/upsertlink.d.ts

@@ -0,0 +1,655 @@
+import * as z from "zod";
+/**
+ * The unique IDs of the tags assigned to the short link.
+ */
+export type UpsertLinkTagIds = string | Array<string>;
+/**
+ * The unique name of the tags assigned to the short link (case insensitive).
+ */
+export type UpsertLinkTagNames = string | Array<string>;
+/**
+ * Geo targeting information for the short link in JSON format `{[COUNTRY]: https://example.com }`.
+ */
+export type UpsertLinkGeo = {
+    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 UpsertLinkRequestBody = {
+    /**
+     * The destination URL of the short link.
+     */
+    url: 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 | undefined;
+    /**
+     * The short link slug. If not provided, a random 7-character slug will be generated.
+     */
+    key?: string | undefined;
+    /**
+     * 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 | undefined;
+    /**
+     * The prefix of the short link slug for randomly-generated keys (e.g. if prefix is `/c/`, generated keys will be in the `/c/:key` format). Will be ignored if `key` is provided.
+     */
+    prefix?: string | undefined;
+    /**
+     * Whether the short link is archived.
+     */
+    archived?: boolean | undefined;
+    /**
+     * 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 `tagIds` instead.
+     *
+     * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
+     */
+    tagId?: string | null | undefined;
+    /**
+     * The unique IDs of the tags assigned to the short link.
+     */
+    tagIds?: string | Array<string> | undefined;
+    /**
+     * The unique name of the tags assigned to the short link (case insensitive).
+     */
+    tagNames?: string | Array<string> | undefined;
+    /**
+     * The comments for the short link.
+     */
+    comments?: string | null | undefined;
+    /**
+     * The date and time when the short link will expire at.
+     */
+    expiresAt?: string | null | undefined;
+    /**
+     * The URL to redirect to when the short link has expired.
+     */
+    expiredUrl?: string | null | undefined;
+    /**
+     * The password required to access the destination URL of the short link.
+     */
+    password?: string | null | undefined;
+    /**
+     * 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 | undefined;
+    /**
+     * 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 | undefined;
+    /**
+     * 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 | undefined;
+    /**
+     * Whether the short link uses link cloaking.
+     */
+    rewrite?: boolean | undefined;
+    /**
+     * The iOS destination URL for the short link for iOS device targeting.
+     */
+    ios?: string | null | undefined;
+    /**
+     * The Android destination URL for the short link for Android device targeting.
+     */
+    android?: string | null | undefined;
+    /**
+     * Geo targeting information for the short link in JSON format `{[COUNTRY]: https://example.com }`.
+     */
+    geo?: UpsertLinkGeo | null | undefined;
+};
+/** @internal */
+export declare namespace UpsertLinkTagIds$ {
+    const inboundSchema: z.ZodType<UpsertLinkTagIds, z.ZodTypeDef, unknown>;
+    type Outbound = string | Array<string>;
+    const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, UpsertLinkTagIds>;
+}
+/** @internal */
+export declare namespace UpsertLinkTagNames$ {
+    const inboundSchema: z.ZodType<UpsertLinkTagNames, z.ZodTypeDef, unknown>;
+    type Outbound = string | Array<string>;
+    const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, UpsertLinkTagNames>;
+}
+/** @internal */
+export declare namespace UpsertLinkGeo$ {
+    const inboundSchema: z.ZodType<UpsertLinkGeo, z.ZodTypeDef, unknown>;
+    type 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;
+    };
+    const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, UpsertLinkGeo>;
+}
+/** @internal */
+export declare namespace UpsertLinkRequestBody$ {
+    const inboundSchema: z.ZodType<UpsertLinkRequestBody, z.ZodTypeDef, unknown>;
+    type Outbound = {
+        url: string;
+        domain?: string | undefined;
+        key?: string | undefined;
+        externalId?: string | null | undefined;
+        prefix?: string | undefined;
+        archived: boolean;
+        publicStats: boolean;
+        tagId?: string | null | undefined;
+        tagIds?: string | Array<string> | undefined;
+        tagNames?: string | Array<string> | undefined;
+        comments?: string | null | undefined;
+        expiresAt?: string | null | undefined;
+        expiredUrl?: string | null | undefined;
+        password?: string | null | undefined;
+        proxy: boolean;
+        title?: string | null | undefined;
+        description?: string | null | undefined;
+        image?: string | null | undefined;
+        rewrite: boolean;
+        ios?: string | null | undefined;
+        android?: string | null | undefined;
+        geo?: UpsertLinkGeo$.Outbound | null | undefined;
+    };
+    const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, UpsertLinkRequestBody>;
+}
+//# sourceMappingURL=upsertlink.d.ts.map