@codeqr/ts-mcp 0.9.0 → 0.19.3

package/tools/links/list-links.mjs

@@ -1,966 +0,0 @@
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-import { asErrorResult, asTextContentResult } from '@codeqr/ts-mcp/tools/types';
-import Codeqr from '@codeqr/ts';
-export const metadata = {
-    resource: 'links',
-    operation: 'read',
-    tags: [],
-    httpMethod: 'get',
-    httpPath: '/links',
-    operationId: 'getLinks',
-};
-export const tool = {
-    name: 'list_links',
-    description: 'Retrieve a paginated list of links for the authenticated workspace.',
-    inputSchema: {
-        type: 'object',
-        properties: {
-            android: {
-                type: 'string',
-                description: 'The Android device to filter by.',
-            },
-            clicksMax: {
-                type: 'integer',
-                description: 'Maximum number of clicks',
-            },
-            clicksMin: {
-                type: 'integer',
-                description: 'Minimum number of clicks',
-            },
-            comments: {
-                type: 'string',
-                description: 'The comments to filter by.',
-            },
-            createdAfter: {
-                type: 'string',
-                description: 'Created after date (ISO string)',
-                format: 'date-time',
-            },
-            createdBefore: {
-                type: 'string',
-                description: 'Created before date (ISO string)',
-                format: 'date-time',
-            },
-            domain: {
-                type: 'string',
-                description: 'The domain to filter the links. For example, `ac.me`. If not provided, all links of the project will be returned.',
-            },
-            expiresAfter: {
-                type: 'string',
-                description: 'Expires after date (ISO string)',
-                format: 'date-time',
-            },
-            expiresAt: {
-                type: 'string',
-                description: 'The date and time the short link will expire in ISO-8601 format. Must be in the future.',
-                format: 'date-time',
-            },
-            expiresBefore: {
-                type: 'string',
-                description: 'Expires before date (ISO string)',
-                format: 'date-time',
-            },
-            folderId: {
-                type: 'string',
-                description: 'The folder ID to filter the links by.',
-            },
-            geo: {
-                type: 'object',
-                description: 'Geographic segmentation 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',
-                    },
-                },
-            },
-            hasComments: {
-                type: 'boolean',
-                description: 'Filter links that have comments (any comments)',
-            },
-            hasCustomSocial: {
-                type: 'boolean',
-                description: 'Filter links that have custom social media cards',
-            },
-            hasDevice: {
-                type: 'boolean',
-                description: 'Filter links that have device targeting',
-            },
-            hasExpiration: {
-                type: 'boolean',
-                description: 'Filter links that have expiration date (any expiration)',
-            },
-            hasGeo: {
-                type: 'boolean',
-                description: 'Filter links that have geo-targeting',
-            },
-            hasPassword: {
-                type: 'boolean',
-                description: 'Filter links that have password protection (any password)',
-            },
-            hasTags: {
-                type: 'boolean',
-                description: 'Filter links that have tags (any tags)',
-            },
-            hasUTM: {
-                type: 'boolean',
-                description: 'Filter links that have UTM parameters',
-            },
-            ios: {
-                type: 'string',
-                description: 'The iOS device to filter by.',
-            },
-            linkIds: {
-                anyOf: [
-                    {
-                        type: 'string',
-                    },
-                    {
-                        type: 'array',
-                        items: {
-                            type: 'string',
-                        },
-                    },
-                ],
-                description: 'Link IDs to filter by.',
-            },
-            page: {
-                type: 'number',
-                description: 'The page number for pagination.',
-            },
-            pageSize: {
-                type: 'number',
-                description: 'The number of items per page.',
-            },
-            password: {
-                type: 'string',
-                description: 'The password to filter by.',
-            },
-            projectSlug: {
-                type: 'string',
-                description: 'The slug of the project to which the link belongs. For example, for `app.codeqr.io/acme`, the projectSlug is `acme`.',
-            },
-            search: {
-                type: 'string',
-                description: 'The search term to filter the links. The search term will be matched against the short link slug and the destination URL.',
-            },
-            showArchived: {
-                type: 'boolean',
-                description: 'If should include archived links in the response. The default is `false` if not provided.',
-            },
-            sort: {
-                type: 'string',
-                description: 'The field to sort the links by. The default is `createdAt`, and sort order is always descending.',
-                enum: ['createdAt', 'clicks', 'lastClicked'],
-            },
-            tagId: {
-                type: 'string',
-                description: '[OBSOLETO (use tagIds em vez disso)]: The unique ID of the tag assigned to the short link.',
-            },
-            tagIds: {
-                anyOf: [
-                    {
-                        type: 'string',
-                    },
-                    {
-                        type: 'array',
-                        items: {
-                            type: 'string',
-                        },
-                    },
-                ],
-                description: 'The IDs of the tags to filter the links.',
-            },
-            tagNames: {
-                anyOf: [
-                    {
-                        type: 'string',
-                    },
-                    {
-                        type: 'array',
-                        items: {
-                            type: 'string',
-                        },
-                    },
-                ],
-                description: 'The unique name of the tags assigned to the short link (case insensitive).',
-            },
-            trackConversion: {
-                type: 'boolean',
-                description: 'If should include links with conversion tracking enabled. The default is `false` if not provided.',
-            },
-            userId: {
-                type: 'string',
-                description: 'The ID of the user to filter by.',
-            },
-            withTags: {
-                type: 'boolean',
-                description: 'If should include tags in the response. The default is `false` if not provided.',
-            },
-        },
-        required: [],
-    },
-    annotations: {
-        readOnlyHint: true,
-    },
-};
-export const handler = async (client, args) => {
-    const body = args;
-    try {
-        return asTextContentResult(await client.links.list(body));
-    }
-    catch (error) {
-        if (error instanceof Codeqr.APIError) {
-            return asErrorResult(error.message);
-        }
-        throw error;
-    }
-};
-export default { metadata, tool, handler };
-//# sourceMappingURL=list-links.mjs.map