@codeqr/ts-mcp 0.2.1

package/tools/links/upsert-links.mjs

@@ -0,0 +1,927 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { asTextContentResult } from '@codeqr/ts-mcp/tools/types';
+export const metadata = {
+    resource: 'links',
+    operation: 'write',
+    tags: [],
+    httpMethod: 'patch',
+    httpPath: '/links/update',
+    operationId: 'upsertLink',
+};
+export const tool = {
+    name: 'upsert_links',
+    description: '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.',
+    inputSchema: {
+        type: 'object',
+        properties: {
+            url: {
+                type: 'string',
+                description: 'The destination URL of the short link.',
+            },
+            android: {
+                type: 'string',
+                description: 'The Android destination URL for the short link for Android device targeting.',
+            },
+            archived: {
+                type: 'boolean',
+                description: 'Whether the short link is archived.',
+            },
+            comments: {
+                type: 'string',
+                description: 'The comments for the short link.',
+            },
+            description: {
+                type: 'string',
+                description: 'The description of the short link generated via `api.codeqr.io/metatags`. Will be used for custom link preview if `proxy` is true.',
+            },
+            doIndex: {
+                type: 'boolean',
+                description: 'Allow search engines to index your short link. Default is `false` if not provided. Learn more: https://codeqr.link/noindex',
+            },
+            domain: {
+                type: 'string',
+                description: '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).',
+            },
+            expiredUrl: {
+                type: 'string',
+                description: 'The URL to redirect to when the short link expires.',
+            },
+            expiresAt: {
+                type: 'string',
+                description: 'The date and time when the short link will expire in ISO-8601 format. Must be in the future.',
+                format: 'date-time',
+            },
+            externalId: {
+                type: 'string',
+                description: '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.',
+            },
+            flexible: {
+                type: 'boolean',
+                description: 'Whether the short link is flexible.',
+            },
+            geo: {
+                type: 'object',
+                description: 'Geographic targeting information for the short link in JSON format `{[COUNTRY]: https://example.com }`.',
+                properties: {
+                    AD: {
+                        type: 'string',
+                    },
+                    AE: {
+                        type: 'string',
+                    },
+                    AF: {
+                        type: 'string',
+                    },
+                    AG: {
+                        type: 'string',
+                    },
+                    AI: {
+                        type: 'string',
+                    },
+                    AL: {
+                        type: 'string',
+                    },
+                    AM: {
+                        type: 'string',
+                    },
+                    AO: {
+                        type: 'string',
+                    },
+                    AQ: {
+                        type: 'string',
+                    },
+                    AR: {
+                        type: 'string',
+                    },
+                    AS: {
+                        type: 'string',
+                    },
+                    AT: {
+                        type: 'string',
+                    },
+                    AU: {
+                        type: 'string',
+                    },
+                    AW: {
+                        type: 'string',
+                    },
+                    AX: {
+                        type: 'string',
+                    },
+                    AZ: {
+                        type: 'string',
+                    },
+                    BA: {
+                        type: 'string',
+                    },
+                    BB: {
+                        type: 'string',
+                    },
+                    BD: {
+                        type: 'string',
+                    },
+                    BE: {
+                        type: 'string',
+                    },
+                    BF: {
+                        type: 'string',
+                    },
+                    BG: {
+                        type: 'string',
+                    },
+                    BH: {
+                        type: 'string',
+                    },
+                    BI: {
+                        type: 'string',
+                    },
+                    BJ: {
+                        type: 'string',
+                    },
+                    BL: {
+                        type: 'string',
+                    },
+                    BM: {
+                        type: 'string',
+                    },
+                    BN: {
+                        type: 'string',
+                    },
+                    BO: {
+                        type: 'string',
+                    },
+                    BQ: {
+                        type: 'string',
+                    },
+                    BR: {
+                        type: 'string',
+                    },
+                    BS: {
+                        type: 'string',
+                    },
+                    BT: {
+                        type: 'string',
+                    },
+                    BV: {
+                        type: 'string',
+                    },
+                    BW: {
+                        type: 'string',
+                    },
+                    BY: {
+                        type: 'string',
+                    },
+                    BZ: {
+                        type: 'string',
+                    },
+                    CA: {
+                        type: 'string',
+                    },
+                    CC: {
+                        type: 'string',
+                    },
+                    CD: {
+                        type: 'string',
+                    },
+                    CF: {
+                        type: 'string',
+                    },
+                    CG: {
+                        type: 'string',
+                    },
+                    CH: {
+                        type: 'string',
+                    },
+                    CI: {
+                        type: 'string',
+                    },
+                    CK: {
+                        type: 'string',
+                    },
+                    CL: {
+                        type: 'string',
+                    },
+                    CM: {
+                        type: 'string',
+                    },
+                    CN: {
+                        type: 'string',
+                    },
+                    CO: {
+                        type: 'string',
+                    },
+                    CR: {
+                        type: 'string',
+                    },
+                    CU: {
+                        type: 'string',
+                    },
+                    CV: {
+                        type: 'string',
+                    },
+                    CW: {
+                        type: 'string',
+                    },
+                    CX: {
+                        type: 'string',
+                    },
+                    CY: {
+                        type: 'string',
+                    },
+                    CZ: {
+                        type: 'string',
+                    },
+                    DE: {
+                        type: 'string',
+                    },
+                    DJ: {
+                        type: 'string',
+                    },
+                    DK: {
+                        type: 'string',
+                    },
+                    DM: {
+                        type: 'string',
+                    },
+                    DO: {
+                        type: 'string',
+                    },
+                    DZ: {
+                        type: 'string',
+                    },
+                    EC: {
+                        type: 'string',
+                    },
+                    EE: {
+                        type: 'string',
+                    },
+                    EG: {
+                        type: 'string',
+                    },
+                    EH: {
+                        type: 'string',
+                    },
+                    ER: {
+                        type: 'string',
+                    },
+                    ES: {
+                        type: 'string',
+                    },
+                    ET: {
+                        type: 'string',
+                    },
+                    FI: {
+                        type: 'string',
+                    },
+                    FJ: {
+                        type: 'string',
+                    },
+                    FK: {
+                        type: 'string',
+                    },
+                    FM: {
+                        type: 'string',
+                    },
+                    FO: {
+                        type: 'string',
+                    },
+                    FR: {
+                        type: 'string',
+                    },
+                    GA: {
+                        type: 'string',
+                    },
+                    GB: {
+                        type: 'string',
+                    },
+                    GD: {
+                        type: 'string',
+                    },
+                    GE: {
+                        type: 'string',
+                    },
+                    GF: {
+                        type: 'string',
+                    },
+                    GG: {
+                        type: 'string',
+                    },
+                    GH: {
+                        type: 'string',
+                    },
+                    GI: {
+                        type: 'string',
+                    },
+                    GL: {
+                        type: 'string',
+                    },
+                    GM: {
+                        type: 'string',
+                    },
+                    GN: {
+                        type: 'string',
+                    },
+                    GP: {
+                        type: 'string',
+                    },
+                    GQ: {
+                        type: 'string',
+                    },
+                    GR: {
+                        type: 'string',
+                    },
+                    GS: {
+                        type: 'string',
+                    },
+                    GT: {
+                        type: 'string',
+                    },
+                    GU: {
+                        type: 'string',
+                    },
+                    GW: {
+                        type: 'string',
+                    },
+                    GY: {
+                        type: 'string',
+                    },
+                    HK: {
+                        type: 'string',
+                    },
+                    HM: {
+                        type: 'string',
+                    },
+                    HN: {
+                        type: 'string',
+                    },
+                    HR: {
+                        type: 'string',
+                    },
+                    HT: {
+                        type: 'string',
+                    },
+                    HU: {
+                        type: 'string',
+                    },
+                    ID: {
+                        type: 'string',
+                    },
+                    IE: {
+                        type: 'string',
+                    },
+                    IL: {
+                        type: 'string',
+                    },
+                    IM: {
+                        type: 'string',
+                    },
+                    IN: {
+                        type: 'string',
+                    },
+                    IO: {
+                        type: 'string',
+                    },
+                    IQ: {
+                        type: 'string',
+                    },
+                    IR: {
+                        type: 'string',
+                    },
+                    IS: {
+                        type: 'string',
+                    },
+                    IT: {
+                        type: 'string',
+                    },
+                    JE: {
+                        type: 'string',
+                    },
+                    JM: {
+                        type: 'string',
+                    },
+                    JO: {
+                        type: 'string',
+                    },
+                    JP: {
+                        type: 'string',
+                    },
+                    KE: {
+                        type: 'string',
+                    },
+                    KG: {
+                        type: 'string',
+                    },
+                    KH: {
+                        type: 'string',
+                    },
+                    KI: {
+                        type: 'string',
+                    },
+                    KM: {
+                        type: 'string',
+                    },
+                    KN: {
+                        type: 'string',
+                    },
+                    KP: {
+                        type: 'string',
+                    },
+                    KR: {
+                        type: 'string',
+                    },
+                    KW: {
+                        type: 'string',
+                    },
+                    KY: {
+                        type: 'string',
+                    },
+                    KZ: {
+                        type: 'string',
+                    },
+                    LA: {
+                        type: 'string',
+                    },
+                    LB: {
+                        type: 'string',
+                    },
+                    LC: {
+                        type: 'string',
+                    },
+                    LI: {
+                        type: 'string',
+                    },
+                    LK: {
+                        type: 'string',
+                    },
+                    LR: {
+                        type: 'string',
+                    },
+                    LS: {
+                        type: 'string',
+                    },
+                    LT: {
+                        type: 'string',
+                    },
+                    LU: {
+                        type: 'string',
+                    },
+                    LV: {
+                        type: 'string',
+                    },
+                    LY: {
+                        type: 'string',
+                    },
+                    MA: {
+                        type: 'string',
+                    },
+                    MC: {
+                        type: 'string',
+                    },
+                    MD: {
+                        type: 'string',
+                    },
+                    ME: {
+                        type: 'string',
+                    },
+                    MF: {
+                        type: 'string',
+                    },
+                    MG: {
+                        type: 'string',
+                    },
+                    MH: {
+                        type: 'string',
+                    },
+                    MK: {
+                        type: 'string',
+                    },
+                    ML: {
+                        type: 'string',
+                    },
+                    MM: {
+                        type: 'string',
+                    },
+                    MN: {
+                        type: 'string',
+                    },
+                    MO: {
+                        type: 'string',
+                    },
+                    MP: {
+                        type: 'string',
+                    },
+                    MQ: {
+                        type: 'string',
+                    },
+                    MR: {
+                        type: 'string',
+                    },
+                    MS: {
+                        type: 'string',
+                    },
+                    MT: {
+                        type: 'string',
+                    },
+                    MU: {
+                        type: 'string',
+                    },
+                    MV: {
+                        type: 'string',
+                    },
+                    MW: {
+                        type: 'string',
+                    },
+                    MX: {
+                        type: 'string',
+                    },
+                    MY: {
+                        type: 'string',
+                    },
+                    MZ: {
+                        type: 'string',
+                    },
+                    NA: {
+                        type: 'string',
+                    },
+                    NC: {
+                        type: 'string',
+                    },
+                    NE: {
+                        type: 'string',
+                    },
+                    NF: {
+                        type: 'string',
+                    },
+                    NG: {
+                        type: 'string',
+                    },
+                    NI: {
+                        type: 'string',
+                    },
+                    NL: {
+                        type: 'string',
+                    },
+                    NO: {
+                        type: 'string',
+                    },
+                    NP: {
+                        type: 'string',
+                    },
+                    NR: {
+                        type: 'string',
+                    },
+                    NU: {
+                        type: 'string',
+                    },
+                    NZ: {
+                        type: 'string',
+                    },
+                    OM: {
+                        type: 'string',
+                    },
+                    PA: {
+                        type: 'string',
+                    },
+                    PE: {
+                        type: 'string',
+                    },
+                    PF: {
+                        type: 'string',
+                    },
+                    PG: {
+                        type: 'string',
+                    },
+                    PH: {
+                        type: 'string',
+                    },
+                    PK: {
+                        type: 'string',
+                    },
+                    PL: {
+                        type: 'string',
+                    },
+                    PM: {
+                        type: 'string',
+                    },
+                    PN: {
+                        type: 'string',
+                    },
+                    PR: {
+                        type: 'string',
+                    },
+                    PS: {
+                        type: 'string',
+                    },
+                    PT: {
+                        type: 'string',
+                    },
+                    PW: {
+                        type: 'string',
+                    },
+                    PY: {
+                        type: 'string',
+                    },
+                    QA: {
+                        type: 'string',
+                    },
+                    RE: {
+                        type: 'string',
+                    },
+                    RO: {
+                        type: 'string',
+                    },
+                    RS: {
+                        type: 'string',
+                    },
+                    RU: {
+                        type: 'string',
+                    },
+                    RW: {
+                        type: 'string',
+                    },
+                    SA: {
+                        type: 'string',
+                    },
+                    SB: {
+                        type: 'string',
+                    },
+                    SC: {
+                        type: 'string',
+                    },
+                    SD: {
+                        type: 'string',
+                    },
+                    SE: {
+                        type: 'string',
+                    },
+                    SG: {
+                        type: 'string',
+                    },
+                    SH: {
+                        type: 'string',
+                    },
+                    SI: {
+                        type: 'string',
+                    },
+                    SJ: {
+                        type: 'string',
+                    },
+                    SK: {
+                        type: 'string',
+                    },
+                    SL: {
+                        type: 'string',
+                    },
+                    SM: {
+                        type: 'string',
+                    },
+                    SN: {
+                        type: 'string',
+                    },
+                    SO: {
+                        type: 'string',
+                    },
+                    SR: {
+                        type: 'string',
+                    },
+                    SS: {
+                        type: 'string',
+                    },
+                    ST: {
+                        type: 'string',
+                    },
+                    SV: {
+                        type: 'string',
+                    },
+                    SX: {
+                        type: 'string',
+                    },
+                    SY: {
+                        type: 'string',
+                    },
+                    SZ: {
+                        type: 'string',
+                    },
+                    TC: {
+                        type: 'string',
+                    },
+                    TD: {
+                        type: 'string',
+                    },
+                    TF: {
+                        type: 'string',
+                    },
+                    TG: {
+                        type: 'string',
+                    },
+                    TH: {
+                        type: 'string',
+                    },
+                    TJ: {
+                        type: 'string',
+                    },
+                    TK: {
+                        type: 'string',
+                    },
+                    TL: {
+                        type: 'string',
+                    },
+                    TM: {
+                        type: 'string',
+                    },
+                    TN: {
+                        type: 'string',
+                    },
+                    TO: {
+                        type: 'string',
+                    },
+                    TR: {
+                        type: 'string',
+                    },
+                    TT: {
+                        type: 'string',
+                    },
+                    TV: {
+                        type: 'string',
+                    },
+                    TW: {
+                        type: 'string',
+                    },
+                    TZ: {
+                        type: 'string',
+                    },
+                    UA: {
+                        type: 'string',
+                    },
+                    UG: {
+                        type: 'string',
+                    },
+                    UM: {
+                        type: 'string',
+                    },
+                    US: {
+                        type: 'string',
+                    },
+                    UY: {
+                        type: 'string',
+                    },
+                    UZ: {
+                        type: 'string',
+                    },
+                    VA: {
+                        type: 'string',
+                    },
+                    VC: {
+                        type: 'string',
+                    },
+                    VE: {
+                        type: 'string',
+                    },
+                    VG: {
+                        type: 'string',
+                    },
+                    VI: {
+                        type: 'string',
+                    },
+                    VN: {
+                        type: 'string',
+                    },
+                    VU: {
+                        type: 'string',
+                    },
+                    WF: {
+                        type: 'string',
+                    },
+                    WS: {
+                        type: 'string',
+                    },
+                    XK: {
+                        type: 'string',
+                    },
+                    YE: {
+                        type: 'string',
+                    },
+                    YT: {
+                        type: 'string',
+                    },
+                    ZA: {
+                        type: 'string',
+                    },
+                    ZM: {
+                        type: 'string',
+                    },
+                    ZW: {
+                        type: 'string',
+                    },
+                },
+            },
+            image: {
+                type: 'string',
+                description: 'The image of the short link generated via `api.codeqr.io/metatags`. Will be used for custom link preview if `proxy` is true.',
+            },
+            ios: {
+                type: 'string',
+                description: 'The iOS destination URL for the short link for iOS device targeting.',
+            },
+            isFormMandatory: {
+                type: 'boolean',
+                description: 'If the form is mandatory for the page.',
+            },
+            key: {
+                type: 'string',
+                description: 'The slug of the short link. If not provided, a random 7-character slug will be generated.',
+            },
+            pageId: {
+                type: 'string',
+                description: 'The ID of the page to redirect to before the link destination.',
+            },
+            pageUrl: {
+                type: 'string',
+                description: 'The URL of the page to redirect to before the link destination.',
+            },
+            password: {
+                type: 'string',
+                description: 'The password required to access the short link destination URL.',
+            },
+            prefix: {
+                type: 'string',
+                description: '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.',
+            },
+            preRedirection: {
+                type: 'boolean',
+                description: 'Whether the short link has pre-redirection.',
+            },
+            proxy: {
+                type: 'boolean',
+                description: 'Whether the short link uses the custom link preview feature.',
+            },
+            publicStats: {
+                type: 'boolean',
+                description: 'Whether the short link statistics are publicly accessible.',
+            },
+            rewrite: {
+                type: 'boolean',
+                description: 'Whether the short link uses link cloaking.',
+            },
+            tagId: {
+                type: 'string',
+                description: 'The unique ID of the tag assigned to the short link. This field is deprecated – use `tagIds` instead.',
+            },
+            tagIds: {
+                anyOf: [
+                    {
+                        type: 'string',
+                    },
+                    {
+                        type: 'array',
+                        items: {
+                            type: 'string',
+                        },
+                    },
+                ],
+                description: 'The unique IDs of the tags assigned to the short link.',
+            },
+            tagNames: {
+                anyOf: [
+                    {
+                        type: 'string',
+                    },
+                    {
+                        type: 'array',
+                        items: {
+                            type: 'string',
+                        },
+                    },
+                ],
+                description: 'The unique name of the tags assigned to the short link (case insensitive).',
+            },
+            title: {
+                type: 'string',
+                description: 'The title of the short link generated via `api.codeqr.io/metatags`. Will be used for custom link preview if `proxy` is true.',
+            },
+            trackConversion: {
+                type: 'boolean',
+                description: 'Whether to track conversions for the short link.',
+            },
+            video: {
+                type: 'string',
+                description: 'The video of the short link.',
+            },
+            webhookIds: {
+                type: 'array',
+                description: 'An array of webhook IDs to trigger when the link is clicked. These webhooks will receive click event data.',
+                items: {
+                    type: 'string',
+                },
+            },
+        },
+        required: ['url'],
+    },
+    annotations: {},
+};
+export const handler = async (client, args) => {
+    const body = args;
+    return asTextContentResult(await client.links.upsert(body));
+};
+export default { metadata, tool, handler };
+//# sourceMappingURL=upsert-links.mjs.map