@codeqr/ts-mcp 0.2.1

package/tools/qrcodes/update-qrcodes.mjs

@@ -0,0 +1,1045 @@
+// 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: 'qrcodes',
+    operation: 'write',
+    tags: [],
+    httpMethod: 'put',
+    httpPath: '/qrcodes/{qrcodeId}',
+    operationId: 'updateQRCode',
+};
+export const tool = {
+    name: 'update_qrcodes',
+    description: "Update a QR Code for the authenticated workspace. If there's no change, returns it as it is.",
+    inputSchema: {
+        type: 'object',
+        properties: {
+            qrcodeId: {
+                type: 'string',
+                description: 'The id of the QR Code to update. You may use either `qrcodeId` (obtained via `/qrcodes/info` endpoint) or `externalId` prefixed with `ext_`.',
+            },
+            android: {
+                type: 'string',
+                description: 'The destination URL for Android for the QR code for device targeting Android.',
+            },
+            archived: {
+                type: 'boolean',
+                description: 'If the QR code is archived.',
+            },
+            bgColor: {
+                type: 'string',
+                description: 'The background color of the QR code.',
+            },
+            comments: {
+                type: 'string',
+                description: 'The comments for the QR code.',
+            },
+            contentStatic: {
+                type: 'string',
+                description: 'The static content of the QR code.',
+            },
+            crypto: {
+                type: 'object',
+                description: 'The cryptocurrency information of the QR code.',
+                additionalProperties: true,
+            },
+            description: {
+                type: 'string',
+                description: 'The description of the QR code 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 QR code. The default is `false` if not provided. Learn more: https://codeqr.link/noindex',
+            },
+            domain: {
+                type: 'string',
+                description: 'The domain of the QR code. If not provided, the main domain of the project will be used (or `codeqr.link` if the project does not have domains).',
+            },
+            email: {
+                type: 'object',
+                description: 'The email information of the QR code.',
+                additionalProperties: true,
+            },
+            excavate: {
+                type: 'boolean',
+                description: 'If the QR code should have excavated areas.',
+            },
+            expiredUrl: {
+                type: 'string',
+                description: 'The URL to redirect when the QR code expires.',
+            },
+            expiresAt: {
+                type: 'string',
+                description: 'The date and time the QR code will expire in ISO-8601 format. Must be in the future.',
+                format: 'date-time',
+            },
+            externalId: {
+                type: 'string',
+                description: 'This is the ID of the QR code in your database. If defined, it can be used to identify the QR code in the future. It must be prefixed with `ext_` when passed as a query parameter.',
+            },
+            facetime: {
+                type: 'object',
+                description: 'The FaceTime information of the QR code.',
+                additionalProperties: true,
+            },
+            fgColor: {
+                type: 'string',
+                description: 'The foreground color of the QR code.',
+            },
+            filled: {
+                type: 'boolean',
+                description: 'If the QR code is filled.',
+            },
+            flexible: {
+                type: 'boolean',
+                description: 'If the QR code is flexible.',
+            },
+            frame: {
+                type: 'string',
+                description: 'The type of frame of the QR code.',
+            },
+            frameColor: {
+                type: 'string',
+                description: 'The color of the frame of the QR code.',
+            },
+            frameText: {
+                type: 'string',
+                description: 'The text of the frame of the QR code.',
+            },
+            geo: {
+                type: 'object',
+                description: 'Geographic segmentation information for the QR code in the 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',
+                    },
+                },
+            },
+            height: {
+                type: 'number',
+                description: 'The height of the QR code.',
+            },
+            image: {
+                type: 'string',
+                description: 'The image of the QR code generated via `api.codeqr.io/metatags`. Will be used for custom link preview if `proxy` is true.',
+            },
+            ios: {
+                type: 'string',
+                description: 'The destination URL for iOS for the QR code for device targeting iOS.',
+            },
+            isFormMandatory: {
+                type: 'boolean',
+                description: 'If the form is mandatory for the page.',
+            },
+            key: {
+                type: 'string',
+                description: 'The slug of the QR code. If not provided, a random slug of 7 characters will be generated.',
+            },
+            latlog: {
+                type: 'object',
+                description: 'The latitude and longitude information of the QR code.',
+                additionalProperties: true,
+            },
+            level: {
+                type: 'string',
+                description: 'The level of error correction of the QR code.',
+            },
+            logo: {
+                type: 'string',
+                description: 'The logo of the QR code.',
+            },
+            pageId: {
+                type: 'string',
+                description: 'The ID of the page to redirect to before the QR code destination.',
+            },
+            pageUrl: {
+                type: 'string',
+                description: 'The URL of the page to redirect to before the QR code destination.',
+            },
+            password: {
+                type: 'string',
+                description: 'The password required to access the destination URL of the QR code.',
+            },
+            pattern: {
+                type: 'string',
+                description: 'The pattern of the modules of the QR code.',
+            },
+            phone: {
+                type: 'string',
+                description: 'The phone number of the QR code.',
+            },
+            preRedirection: {
+                type: 'boolean',
+                description: 'If the QR code has pre-redirection.',
+            },
+            proxy: {
+                type: 'boolean',
+                description: 'If the QR code uses the custom link preview feature.',
+            },
+            publicStats: {
+                type: 'boolean',
+                description: 'If the statistics of the QR code are publicly accessible.',
+            },
+            rewrite: {
+                type: 'boolean',
+                description: 'If the QR code uses link cloaking.',
+            },
+            shape: {
+                type: 'string',
+                description: 'The shape of the design around the QR code (none, square, circle).',
+            },
+            showLogo: {
+                type: 'boolean',
+                description: 'If the logo should be displayed in the QR code.',
+            },
+            size: {
+                type: 'number',
+                description: 'The size of the QR code.',
+            },
+            sms: {
+                type: 'object',
+                description: 'The SMS information of the QR code.',
+                additionalProperties: true,
+            },
+            src: {
+                type: 'string',
+                description: 'The image URL of the QR code.',
+            },
+            static: {
+                type: 'boolean',
+                description: 'If the QR code is static.',
+            },
+            tagId: {
+                type: 'string',
+                description: 'The unique ID of the tag assigned to the QR code. 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 QR code.',
+            },
+            tagNames: {
+                anyOf: [
+                    {
+                        type: 'string',
+                    },
+                    {
+                        type: 'array',
+                        items: {
+                            type: 'string',
+                        },
+                    },
+                ],
+                description: 'The unique name of the tags assigned to the QR code (case insensitive).',
+            },
+            text: {
+                type: 'string',
+                description: 'The text of the QR code.',
+            },
+            title: {
+                type: 'string',
+                description: 'The title of the QR code generated via `api.codeqr.io/metatags`. Will be used for custom link preview if `proxy` is true.',
+            },
+            trackConversion: {
+                type: 'boolean',
+                description: 'If should track conversions for the QR code.',
+            },
+            type: {
+                type: 'string',
+                description: 'The type of content of the QR code.',
+                enum: ['url', 'text', 'email', 'wifi', 'phone', 'vcard', 'crypto', 'sms', 'facetime', 'latlog'],
+            },
+            url: {
+                type: 'string',
+                description: 'The destination URL of the QR code.',
+            },
+            vcard: {
+                type: 'object',
+                description: 'The vCard information of the QR code.',
+                additionalProperties: true,
+            },
+            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',
+                },
+            },
+            width: {
+                type: 'number',
+                description: 'The width of the QR code.',
+            },
+            wifi: {
+                type: 'object',
+                description: 'The WiFi information of the QR code.',
+                additionalProperties: true,
+            },
+        },
+        required: ['qrcodeId'],
+    },
+    annotations: {
+        idempotentHint: true,
+    },
+};
+export const handler = async (client, args) => {
+    const { qrcodeId, ...body } = args;
+    return asTextContentResult(await client.qrcodes.update(qrcodeId, body));
+};
+export default { metadata, tool, handler };
+//# sourceMappingURL=update-qrcodes.mjs.map