@codeqr/ts 0.8.0 → 0.19.3

package/resources/links/links.d.mts

@@ -1,7 +1,7 @@
 import { APIResource } from "../../core/resource.mjs";
 import * as TagsAPI from "../tags.mjs";
 import * as BulkAPI from "./bulk.mjs";
-import { Bulk, BulkCreateParams, BulkCreateResponse, BulkDeleteParams, BulkDeleteResponse } from "./bulk.mjs";
+import { Bulk, BulkCreateParams, BulkCreateResponse } from "./bulk.mjs";
 import { APIPromise } from "../../core/api-promise.mjs";
 import { RequestOptions } from "../../internal/request-options.mjs";
 export declare class Links extends APIResource {
@@ -45,15 +45,6 @@ export declare class Links extends APIResource {
      * ```
      */
     delete(linkID: string, options?: RequestOptions): APIPromise<LinkDeleteResponse>;
-    /**
-     * Retrieve the number of links for the authenticated workspace.
-     *
-     * @example
-     * ```ts
-     * const response = await client.links.count();
-     * ```
-     */
-    count(query?: LinkCountParams | null | undefined, options?: RequestOptions): APIPromise<LinkCountResponse>;
     /**
      * Retrieve the info for a link.
      *
@@ -67,19 +58,6 @@ export declare class Links extends APIResource {
      * ```
      */
     retrieveInfo(query: LinkRetrieveInfoParams, options?: RequestOptions): APIPromise<Link>;
-    /**
-     * Upsert a link for the authenticated workspace by its URL. If a link with the
-     * same URL already exists, return it (or update it if there are any changes).
-     * Otherwise, a new link will be created.
-     *
-     * @example
-     * ```ts
-     * const link = await client.links.upsert({
-     *   url: 'https://google.com',
-     * });
-     * ```
-     */
-    upsert(body: LinkUpsertParams, options?: RequestOptions): APIPromise<Link>;
 }
 export interface Link {
     /**
@@ -294,10 +272,6 @@ export interface LinkDeleteResponse {
      */
     id: string;
 }
-/**
- * The number of links matching the query.
- */
-export type LinkCountResponse = number;
 export interface LinkCreateParams {
     /**
      * The destination URL of the short link.
@@ -432,6 +406,10 @@ export interface LinkCreateParams {
      * Whether to track conversions for the short link.
      */
     trackConversion?: boolean;
+    /**
+     * Whether this link should be used as a reusable template.
+     */
+    useAsTemplate?: boolean;
     /**
      * The video of the short link.
      */
@@ -834,6 +812,10 @@ export interface LinkUpdateParams {
      * The destination URL of the short link.
      */
     url?: string;
+    /**
+     * Whether this link should be used as a reusable template.
+     */
+    useAsTemplate?: boolean;
     /**
      * The video of the short link.
      */
@@ -1244,6 +1226,10 @@ export interface LinkListParams {
      * if not provided.
      */
     trackConversion?: boolean;
+    /**
+     * Filter links marked as templates.
+     */
+    useAsTemplate?: boolean;
     /**
      * The ID of the user to filter by.
      */
@@ -1511,832 +1497,34 @@ export declare namespace LinkListParams {
         ZW?: string;
     }
 }
-export interface LinkCountParams {
-    /**
-     * The Android device to filter by.
-     */
-    android?: string;
-    /**
-     * Maximum number of clicks
-     */
-    clicksMax?: number;
-    /**
-     * Minimum number of clicks
-     */
-    clicksMin?: number;
-    /**
-     * The comments to filter by.
-     */
-    comments?: string;
-    /**
-     * Created after date (ISO string)
-     */
-    createdAfter?: string;
-    /**
-     * Created before date (ISO string)
-     */
-    createdBefore?: string;
-    /**
-     * The domain to filter the links. For example, `ac.me`. If not provided, all links
-     * of the project will be returned.
-     */
-    domain?: string;
-    /**
-     * Expires after date (ISO string)
-     */
-    expiresAfter?: string;
-    /**
-     * The date and time the short link will expire in ISO-8601 format. Must be in the
-     * future.
-     */
-    expiresAt?: string | null;
-    /**
-     * Expires before date (ISO string)
-     */
-    expiresBefore?: string;
-    /**
-     * The folder ID to filter the links by.
-     */
-    folderId?: string;
-    /**
-     * Geographic segmentation information for the short link in JSON format
-     * `{[COUNTRY]: https://example.com }`.
-     */
-    geo?: LinkCountParams.Geo | null;
-    /**
-     * The field to group the links by.
-     */
-    groupBy?: 'domain' | 'tagId' | 'userId' | 'folderId';
-    /**
-     * Filter links that have comments (any comments)
-     */
-    hasComments?: boolean;
-    /**
-     * Filter links that have custom social media cards
-     */
-    hasCustomSocial?: boolean;
-    /**
-     * Filter links that have device targeting
-     */
-    hasDevice?: boolean;
-    /**
-     * Filter links that have expiration date (any expiration)
-     */
-    hasExpiration?: boolean;
-    /**
-     * Filter links that have geo-targeting
-     */
-    hasGeo?: boolean;
-    /**
-     * Filter links that have password protection (any password)
-     */
-    hasPassword?: boolean;
-    /**
-     * Filter links that have tags (any tags)
-     */
-    hasTags?: boolean;
-    /**
-     * Filter links that have UTM parameters
-     */
-    hasUTM?: boolean;
+export interface LinkRetrieveInfoParams {
     /**
-     * The iOS device to filter by.
+     * The domain of the link to be retrieved. For example, for `codeqr.link/github`,
+     * the domain is `codeqr.link`.
      */
-    ios?: string;
+    domain: string;
     /**
-     * The password to filter by.
+     * The key of the link to be retrieved. For example, for `codeqr.link/github`, the
+     * key is `github`.
      */
-    password?: string;
+    key: string;
     /**
      * The slug of the project to which the link belongs. For example, for
      * `app.codeqr.io/acme`, the projectSlug is `acme`.
      */
-    projectSlug?: string;
-    /**
-     * The search term to filter the links. The search term will be matched against the
-     * short link slug and the destination URL.
-     */
-    search?: string;
-    /**
-     * If should include archived links in the response. The default is `false` if not
-     * provided.
-     */
-    showArchived?: boolean;
-    /**
-     * @deprecated [OBSOLETO (use tagIds em vez disso)]: The unique ID of the tag
-     * assigned to the short link.
-     */
-    tagId?: string;
-    /**
-     * The IDs of the tags to filter the links.
-     */
-    tagIds?: string | Array<string>;
-    /**
-     * The unique name of the tags assigned to the short link (case insensitive).
-     */
-    tagNames?: string | Array<string>;
-    /**
-     * If should include links with conversion tracking enabled. The default is `false`
-     * if not provided.
-     */
-    trackConversion?: boolean;
-    /**
-     * The ID of the user to filter by.
-     */
-    userId?: string;
+    projectSlug: string;
     /**
-     * If should include tags in the response. The default is `false` if not provided.
+     * This is the ID of the link in your database. Must be prefixed with `ext_` when
+     * passed as a query parameter.
      */
-    withTags?: boolean;
-}
-export declare namespace LinkCountParams {
+    externalId?: string;
     /**
-     * Geographic segmentation information for the short link in JSON format
-     * `{[COUNTRY]: https://example.com }`.
-     */
-    interface Geo {
-        AD?: string;
-        AE?: string;
-        AF?: string;
-        AG?: string;
-        AI?: string;
-        AL?: string;
-        AM?: string;
-        AO?: string;
-        AQ?: string;
-        AR?: string;
-        AS?: string;
-        AT?: string;
-        AU?: string;
-        AW?: string;
-        AX?: string;
-        AZ?: string;
-        BA?: string;
-        BB?: string;
-        BD?: string;
-        BE?: string;
-        BF?: string;
-        BG?: string;
-        BH?: string;
-        BI?: string;
-        BJ?: string;
-        BL?: string;
-        BM?: string;
-        BN?: string;
-        BO?: string;
-        BQ?: string;
-        BR?: string;
-        BS?: string;
-        BT?: string;
-        BV?: string;
-        BW?: string;
-        BY?: string;
-        BZ?: string;
-        CA?: string;
-        CC?: string;
-        CD?: string;
-        CF?: string;
-        CG?: string;
-        CH?: string;
-        CI?: string;
-        CK?: string;
-        CL?: string;
-        CM?: string;
-        CN?: string;
-        CO?: string;
-        CR?: string;
-        CU?: string;
-        CV?: string;
-        CW?: string;
-        CX?: string;
-        CY?: string;
-        CZ?: string;
-        DE?: string;
-        DJ?: string;
-        DK?: string;
-        DM?: string;
-        DO?: string;
-        DZ?: string;
-        EC?: string;
-        EE?: string;
-        EG?: string;
-        EH?: string;
-        ER?: string;
-        ES?: string;
-        ET?: string;
-        FI?: string;
-        FJ?: string;
-        FK?: string;
-        FM?: string;
-        FO?: string;
-        FR?: string;
-        GA?: string;
-        GB?: string;
-        GD?: string;
-        GE?: string;
-        GF?: string;
-        GG?: string;
-        GH?: string;
-        GI?: string;
-        GL?: string;
-        GM?: string;
-        GN?: string;
-        GP?: string;
-        GQ?: string;
-        GR?: string;
-        GS?: string;
-        GT?: string;
-        GU?: string;
-        GW?: string;
-        GY?: string;
-        HK?: string;
-        HM?: string;
-        HN?: string;
-        HR?: string;
-        HT?: string;
-        HU?: string;
-        ID?: string;
-        IE?: string;
-        IL?: string;
-        IM?: string;
-        IN?: string;
-        IO?: string;
-        IQ?: string;
-        IR?: string;
-        IS?: string;
-        IT?: string;
-        JE?: string;
-        JM?: string;
-        JO?: string;
-        JP?: string;
-        KE?: string;
-        KG?: string;
-        KH?: string;
-        KI?: string;
-        KM?: string;
-        KN?: string;
-        KP?: string;
-        KR?: string;
-        KW?: string;
-        KY?: string;
-        KZ?: string;
-        LA?: string;
-        LB?: string;
-        LC?: string;
-        LI?: string;
-        LK?: string;
-        LR?: string;
-        LS?: string;
-        LT?: string;
-        LU?: string;
-        LV?: string;
-        LY?: string;
-        MA?: string;
-        MC?: string;
-        MD?: string;
-        ME?: string;
-        MF?: string;
-        MG?: string;
-        MH?: string;
-        MK?: string;
-        ML?: string;
-        MM?: string;
-        MN?: string;
-        MO?: string;
-        MP?: string;
-        MQ?: string;
-        MR?: string;
-        MS?: string;
-        MT?: string;
-        MU?: string;
-        MV?: string;
-        MW?: string;
-        MX?: string;
-        MY?: string;
-        MZ?: string;
-        NA?: string;
-        NC?: string;
-        NE?: string;
-        NF?: string;
-        NG?: string;
-        NI?: string;
-        NL?: string;
-        NO?: string;
-        NP?: string;
-        NR?: string;
-        NU?: string;
-        NZ?: string;
-        OM?: string;
-        PA?: string;
-        PE?: string;
-        PF?: string;
-        PG?: string;
-        PH?: string;
-        PK?: string;
-        PL?: string;
-        PM?: string;
-        PN?: string;
-        PR?: string;
-        PS?: string;
-        PT?: string;
-        PW?: string;
-        PY?: string;
-        QA?: string;
-        RE?: string;
-        RO?: string;
-        RS?: string;
-        RU?: string;
-        RW?: string;
-        SA?: string;
-        SB?: string;
-        SC?: string;
-        SD?: string;
-        SE?: string;
-        SG?: string;
-        SH?: string;
-        SI?: string;
-        SJ?: string;
-        SK?: string;
-        SL?: string;
-        SM?: string;
-        SN?: string;
-        SO?: string;
-        SR?: string;
-        SS?: string;
-        ST?: string;
-        SV?: string;
-        SX?: string;
-        SY?: string;
-        SZ?: string;
-        TC?: string;
-        TD?: string;
-        TF?: string;
-        TG?: string;
-        TH?: string;
-        TJ?: string;
-        TK?: string;
-        TL?: string;
-        TM?: string;
-        TN?: string;
-        TO?: string;
-        TR?: string;
-        TT?: string;
-        TV?: string;
-        TW?: string;
-        TZ?: string;
-        UA?: string;
-        UG?: string;
-        UM?: string;
-        US?: string;
-        UY?: string;
-        UZ?: string;
-        VA?: string;
-        VC?: string;
-        VE?: string;
-        VG?: string;
-        VI?: string;
-        VN?: string;
-        VU?: string;
-        WF?: string;
-        WS?: string;
-        XK?: string;
-        YE?: string;
-        YT?: string;
-        ZA?: string;
-        ZM?: string;
-        ZW?: string;
-    }
-}
-export interface LinkRetrieveInfoParams {
-    /**
-     * The domain of the link to be retrieved. For example, for `codeqr.link/github`,
-     * the domain is `codeqr.link`.
-     */
-    domain: string;
-    /**
-     * The key of the link to be retrieved. For example, for `codeqr.link/github`, the
-     * key is `github`.
-     */
-    key: string;
-    /**
-     * The slug of the project to which the link belongs. For example, for
-     * `app.codeqr.io/acme`, the projectSlug is `acme`.
-     */
-    projectSlug: string;
-    /**
-     * This is the ID of the link in your database. Must be prefixed with `ext_` when
-     * passed as a query parameter.
-     */
-    externalId?: string;
-    /**
-     * The unique ID of the short link.
+     * The unique ID of the short link.
      */
     linkId?: string;
 }
-export interface LinkUpsertParams {
-    /**
-     * The destination URL of the short link.
-     */
-    url: string;
-    /**
-     * The Android destination URL for the short link for Android device targeting.
-     */
-    android?: string | null;
-    /**
-     * Whether the short link is archived.
-     */
-    archived?: boolean;
-    /**
-     * The comments for the short link.
-     */
-    comments?: string | null;
-    /**
-     * The description of the short link generated via `api.codeqr.io/metatags`. Will
-     * be used for custom link preview if `proxy` is true.
-     */
-    description?: string | null;
-    /**
-     * Allow search engines to index your short link. Default is `false` if not
-     * provided. Learn more: https://codeqr.link/noindex
-     */
-    doIndex?: boolean;
-    /**
-     * The domain of the short link. If not provided, the main domain of the project
-     * will be used (or `codeqr.link` if the project has no domains).
-     */
-    domain?: string;
-    /**
-     * The URL to redirect to when the short link expires.
-     */
-    expiredUrl?: string | null;
-    /**
-     * The date and time when the short link will expire in ISO-8601 format. Must be in
-     * the future.
-     */
-    expiresAt?: string | null;
-    /**
-     * 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;
-    /**
-     * Whether the short link is flexible.
-     */
-    flexible?: boolean;
-    /**
-     * The unique ID existing folder to assign the short link to.
-     */
-    folderId?: string | null;
-    /**
-     * Geographic targeting information for the short link in JSON format
-     * `{[COUNTRY]: https://example.com }`.
-     */
-    geo?: LinkUpsertParams.Geo | null;
-    /**
-     * The image of the short link generated via `api.codeqr.io/metatags`. Will be used
-     * for custom link preview if `proxy` is true.
-     */
-    image?: string | null;
-    /**
-     * The iOS destination URL for the short link for iOS device targeting.
-     */
-    ios?: string | null;
-    /**
-     * If the form is mandatory for the page.
-     */
-    isFormMandatory?: boolean;
-    /**
-     * The slug of the short link. If not provided, a random 7-character slug will be
-     * generated.
-     */
-    key?: string;
-    /**
-     * The ID of the page to redirect to before the link destination.
-     */
-    pageId?: string | null;
-    /**
-     * The URL of the page to redirect to before the link destination.
-     */
-    pageUrl?: string | null;
-    /**
-     * The password required to access the short link destination URL.
-     */
-    password?: string | null;
-    /**
-     * The prefix of the short link slug for randomly generated keys (for example, if
-     * the prefix is `/c/`, the generated keys will be in the format `/c/:key`). Will
-     * be ignored if `key` is provided.
-     */
-    prefix?: string;
-    /**
-     * Whether the short link has pre-redirection.
-     */
-    preRedirection?: boolean;
-    /**
-     * Whether the short link uses the custom link preview feature.
-     */
-    proxy?: boolean;
-    /**
-     * Whether the short link statistics are publicly accessible.
-     */
-    publicStats?: boolean;
-    /**
-     * Whether the short link uses link cloaking.
-     */
-    rewrite?: boolean;
-    /**
-     * @deprecated The unique ID of the tag assigned to the short link. This field is
-     * deprecated – use `tagIds` instead.
-     */
-    tagId?: string | null;
-    /**
-     * The unique IDs of the tags assigned to the short link.
-     */
-    tagIds?: string | Array<string>;
-    /**
-     * The unique name of the tags assigned to the short link (case insensitive).
-     */
-    tagNames?: string | Array<string>;
-    /**
-     * The title of the short link generated via `api.codeqr.io/metatags`. Will be used
-     * for custom link preview if `proxy` is true.
-     */
-    title?: string | null;
-    /**
-     * Whether to track conversions for the short link.
-     */
-    trackConversion?: boolean;
-    /**
-     * The video of the short link.
-     */
-    video?: string | null;
-    /**
-     * An array of webhook IDs to trigger when the link is clicked. These webhooks will
-     * receive click event data.
-     */
-    webhookIds?: Array<string> | null;
-}
-export declare namespace LinkUpsertParams {
-    /**
-     * Geographic targeting information for the short link in JSON format
-     * `{[COUNTRY]: https://example.com }`.
-     */
-    interface Geo {
-        AD?: string;
-        AE?: string;
-        AF?: string;
-        AG?: string;
-        AI?: string;
-        AL?: string;
-        AM?: string;
-        AO?: string;
-        AQ?: string;
-        AR?: string;
-        AS?: string;
-        AT?: string;
-        AU?: string;
-        AW?: string;
-        AX?: string;
-        AZ?: string;
-        BA?: string;
-        BB?: string;
-        BD?: string;
-        BE?: string;
-        BF?: string;
-        BG?: string;
-        BH?: string;
-        BI?: string;
-        BJ?: string;
-        BL?: string;
-        BM?: string;
-        BN?: string;
-        BO?: string;
-        BQ?: string;
-        BR?: string;
-        BS?: string;
-        BT?: string;
-        BV?: string;
-        BW?: string;
-        BY?: string;
-        BZ?: string;
-        CA?: string;
-        CC?: string;
-        CD?: string;
-        CF?: string;
-        CG?: string;
-        CH?: string;
-        CI?: string;
-        CK?: string;
-        CL?: string;
-        CM?: string;
-        CN?: string;
-        CO?: string;
-        CR?: string;
-        CU?: string;
-        CV?: string;
-        CW?: string;
-        CX?: string;
-        CY?: string;
-        CZ?: string;
-        DE?: string;
-        DJ?: string;
-        DK?: string;
-        DM?: string;
-        DO?: string;
-        DZ?: string;
-        EC?: string;
-        EE?: string;
-        EG?: string;
-        EH?: string;
-        ER?: string;
-        ES?: string;
-        ET?: string;
-        FI?: string;
-        FJ?: string;
-        FK?: string;
-        FM?: string;
-        FO?: string;
-        FR?: string;
-        GA?: string;
-        GB?: string;
-        GD?: string;
-        GE?: string;
-        GF?: string;
-        GG?: string;
-        GH?: string;
-        GI?: string;
-        GL?: string;
-        GM?: string;
-        GN?: string;
-        GP?: string;
-        GQ?: string;
-        GR?: string;
-        GS?: string;
-        GT?: string;
-        GU?: string;
-        GW?: string;
-        GY?: string;
-        HK?: string;
-        HM?: string;
-        HN?: string;
-        HR?: string;
-        HT?: string;
-        HU?: string;
-        ID?: string;
-        IE?: string;
-        IL?: string;
-        IM?: string;
-        IN?: string;
-        IO?: string;
-        IQ?: string;
-        IR?: string;
-        IS?: string;
-        IT?: string;
-        JE?: string;
-        JM?: string;
-        JO?: string;
-        JP?: string;
-        KE?: string;
-        KG?: string;
-        KH?: string;
-        KI?: string;
-        KM?: string;
-        KN?: string;
-        KP?: string;
-        KR?: string;
-        KW?: string;
-        KY?: string;
-        KZ?: string;
-        LA?: string;
-        LB?: string;
-        LC?: string;
-        LI?: string;
-        LK?: string;
-        LR?: string;
-        LS?: string;
-        LT?: string;
-        LU?: string;
-        LV?: string;
-        LY?: string;
-        MA?: string;
-        MC?: string;
-        MD?: string;
-        ME?: string;
-        MF?: string;
-        MG?: string;
-        MH?: string;
-        MK?: string;
-        ML?: string;
-        MM?: string;
-        MN?: string;
-        MO?: string;
-        MP?: string;
-        MQ?: string;
-        MR?: string;
-        MS?: string;
-        MT?: string;
-        MU?: string;
-        MV?: string;
-        MW?: string;
-        MX?: string;
-        MY?: string;
-        MZ?: string;
-        NA?: string;
-        NC?: string;
-        NE?: string;
-        NF?: string;
-        NG?: string;
-        NI?: string;
-        NL?: string;
-        NO?: string;
-        NP?: string;
-        NR?: string;
-        NU?: string;
-        NZ?: string;
-        OM?: string;
-        PA?: string;
-        PE?: string;
-        PF?: string;
-        PG?: string;
-        PH?: string;
-        PK?: string;
-        PL?: string;
-        PM?: string;
-        PN?: string;
-        PR?: string;
-        PS?: string;
-        PT?: string;
-        PW?: string;
-        PY?: string;
-        QA?: string;
-        RE?: string;
-        RO?: string;
-        RS?: string;
-        RU?: string;
-        RW?: string;
-        SA?: string;
-        SB?: string;
-        SC?: string;
-        SD?: string;
-        SE?: string;
-        SG?: string;
-        SH?: string;
-        SI?: string;
-        SJ?: string;
-        SK?: string;
-        SL?: string;
-        SM?: string;
-        SN?: string;
-        SO?: string;
-        SR?: string;
-        SS?: string;
-        ST?: string;
-        SV?: string;
-        SX?: string;
-        SY?: string;
-        SZ?: string;
-        TC?: string;
-        TD?: string;
-        TF?: string;
-        TG?: string;
-        TH?: string;
-        TJ?: string;
-        TK?: string;
-        TL?: string;
-        TM?: string;
-        TN?: string;
-        TO?: string;
-        TR?: string;
-        TT?: string;
-        TV?: string;
-        TW?: string;
-        TZ?: string;
-        UA?: string;
-        UG?: string;
-        UM?: string;
-        US?: string;
-        UY?: string;
-        UZ?: string;
-        VA?: string;
-        VC?: string;
-        VE?: string;
-        VG?: string;
-        VI?: string;
-        VN?: string;
-        VU?: string;
-        WF?: string;
-        WS?: string;
-        XK?: string;
-        YE?: string;
-        YT?: string;
-        ZA?: string;
-        ZM?: string;
-        ZW?: string;
-    }
-}
 export declare namespace Links {
-    export { type Link as Link, type LinkListResponse as LinkListResponse, type LinkDeleteResponse as LinkDeleteResponse, type LinkCountResponse as LinkCountResponse, type LinkCreateParams as LinkCreateParams, type LinkUpdateParams as LinkUpdateParams, type LinkListParams as LinkListParams, type LinkCountParams as LinkCountParams, type LinkRetrieveInfoParams as LinkRetrieveInfoParams, type LinkUpsertParams as LinkUpsertParams, };
-    export { Bulk as Bulk, type BulkCreateResponse as BulkCreateResponse, type BulkDeleteResponse as BulkDeleteResponse, type BulkCreateParams as BulkCreateParams, type BulkDeleteParams as BulkDeleteParams, };
+    export { type Link as Link, type LinkListResponse as LinkListResponse, type LinkDeleteResponse as LinkDeleteResponse, type LinkCreateParams as LinkCreateParams, type LinkUpdateParams as LinkUpdateParams, type LinkListParams as LinkListParams, type LinkRetrieveInfoParams as LinkRetrieveInfoParams, };
+    export { Bulk as Bulk, type BulkCreateResponse as BulkCreateResponse, type BulkCreateParams as BulkCreateParams, };
 }
 //# sourceMappingURL=links.d.mts.map