@codeqr/ts-mcp 0.9.0 → 0.24.0

package/src/tools/analytics/retrieve-analytics.ts

@@ -1,441 +0,0 @@
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
-import { Metadata, asErrorResult, asTextContentResult } from '@codeqr/ts-mcp/tools/types';
-
-import { Tool } from '@modelcontextprotocol/sdk/types.js';
-import Codeqr from '@codeqr/ts';
-
-export const metadata: Metadata = {
-  resource: 'analytics',
-  operation: 'read',
-  tags: [],
-  httpMethod: 'get',
-  httpPath: '/analytics',
-  operationId: 'retrieveAnalytics',
-};
-
-export const tool: Tool = {
-  name: 'retrieve_analytics',
-  description:
-    'Retrieve analytics for a link, a domain, or the authenticated workspace. The response type depends on the `event` and `type` query parameters.',
-  inputSchema: {
-    type: 'object',
-    properties: {
-      browser: {
-        type: 'string',
-        description: 'The browser to retrieve analytics for.',
-      },
-      city: {
-        type: 'string',
-        description: 'The city to retrieve analytics for.',
-      },
-      continent: {
-        $ref: '#/$defs/continent_code',
-      },
-      country: {
-        $ref: '#/$defs/country_code',
-      },
-      device: {
-        type: 'string',
-        description: 'The device to retrieve analytics for.',
-      },
-      domain: {
-        type: 'string',
-        description: 'The domain of the short link.',
-      },
-      end: {
-        type: 'string',
-        description:
-          'The end date and time when to retrieve analytics from. If not provided, defaults to the current date.',
-      },
-      event: {
-        type: 'string',
-        description: "The type of event to retrieve analytics for. Defaults to 'analytics'.",
-        enum: ['clicks', 'leads', 'sales', 'scans', 'views', 'composite'],
-      },
-      excludeRoot: {
-        type: 'boolean',
-        description: 'Whether to exclude the root link from the response.',
-      },
-      externalId: {
-        type: 'string',
-        description:
-          "This is the ID of the link in the your database. Must be prefixed with 'ext_' when passed as a query parameter.",
-      },
-      groupBy: {
-        type: 'string',
-        description: "The parameter to group the analytics data points by. Defaults to 'count' if undefined.",
-        enum: [
-          'timeseries',
-          'clicks',
-          'count',
-          'totals',
-          'top_urls',
-          'top_links',
-          'top_qrcodes',
-          'top_pages',
-          'top_events',
-          'scans',
-          'views',
-          'country',
-          'city',
-          'region',
-          'devices',
-          'browsers',
-          'os',
-          'referers',
-          'referer_urls',
-          'trend_live',
-          'kpis',
-          'analytics',
-          'continents',
-          'countries',
-          'cities',
-          'leads',
-          'sales',
-          'composite',
-        ],
-      },
-      interval: {
-        type: 'string',
-        description: 'The interval to retrieve analytics for. Takes precedence over start and end.',
-        enum: ['1h', '24h', '7d', '30d', '90d', 'ytd', '1y', 'all', 'all_unfiltered'],
-      },
-      key: {
-        type: 'string',
-        description: 'The short link slug.',
-      },
-      linkId: {
-        type: 'string',
-        description: 'The unique ID of the short link on CodeQR.',
-      },
-      os: {
-        type: 'string',
-        description: 'The OS to retrieve analytics for.',
-      },
-      pageId: {
-        type: 'string',
-        description: 'The unique ID of the page on CodeQR.',
-      },
-      qrcodeId: {
-        type: 'string',
-        description: 'The unique ID of the QR code on CodeQR.',
-      },
-      referer: {
-        type: 'string',
-        description: 'The referer to retrieve analytics for.',
-      },
-      root: {
-        type: 'boolean',
-        description:
-          'Filter for root domains. If true, filter for domains only. If false, filter for links only. If undefined, return both.',
-      },
-      start: {
-        type: 'string',
-        description: 'The start date and time when to retrieve analytics from.',
-      },
-      tagId: {
-        type: 'string',
-        description: 'The tag ID to retrieve analytics for.',
-      },
-      timezone: {
-        type: 'string',
-        description:
-          'The IANA time zone code for aligning timeseries granularity (e.g. America/New_York). Defaults to UTC.',
-      },
-      type: {
-        type: 'string',
-        description: 'The type of analytics to retrieve.',
-      },
-      types: {
-        type: 'string',
-        description: 'The types of analytics to retrieve.',
-      },
-      url: {
-        type: 'string',
-        description: 'The URL to retrieve analytics for.',
-      },
-    },
-    required: [],
-    $defs: {
-      continent_code: {
-        type: 'string',
-        description: 'The continent to retrieve analytics for.',
-        enum: ['AF', 'AN', 'AS', 'EU', 'NA', 'OC', 'SA'],
-      },
-      country_code: {
-        type: 'string',
-        description: 'The country to retrieve analytics for.',
-        enum: [
-          'AF',
-          'AL',
-          'DZ',
-          'AS',
-          'AD',
-          'AO',
-          'AI',
-          'AQ',
-          'AG',
-          'AR',
-          'AM',
-          'AW',
-          'AU',
-          'AT',
-          'AZ',
-          'BS',
-          'BH',
-          'BD',
-          'BB',
-          'BY',
-          'BE',
-          'BZ',
-          'BJ',
-          'BM',
-          'BT',
-          'BO',
-          'BA',
-          'BW',
-          'BV',
-          'BR',
-          'IO',
-          'BN',
-          'BG',
-          'BF',
-          'BI',
-          'KH',
-          'CM',
-          'CA',
-          'CV',
-          'KY',
-          'CF',
-          'TD',
-          'CL',
-          'CN',
-          'CX',
-          'CC',
-          'CO',
-          'KM',
-          'CG',
-          'CD',
-          'CK',
-          'CR',
-          'CI',
-          'HR',
-          'CU',
-          'CY',
-          'CZ',
-          'DK',
-          'DJ',
-          'DM',
-          'DO',
-          'EC',
-          'EG',
-          'SV',
-          'GQ',
-          'ER',
-          'EE',
-          'ET',
-          'FK',
-          'FO',
-          'FJ',
-          'FI',
-          'FR',
-          'GF',
-          'PF',
-          'TF',
-          'GA',
-          'GM',
-          'GE',
-          'DE',
-          'GH',
-          'GI',
-          'GR',
-          'GL',
-          'GD',
-          'GP',
-          'GU',
-          'GT',
-          'GN',
-          'GW',
-          'GY',
-          'HT',
-          'HM',
-          'VA',
-          'HN',
-          'HK',
-          'HU',
-          'IS',
-          'IN',
-          'ID',
-          'IR',
-          'IQ',
-          'IE',
-          'IL',
-          'IT',
-          'JM',
-          'JP',
-          'JO',
-          'KZ',
-          'KE',
-          'KI',
-          'KP',
-          'KR',
-          'KW',
-          'KG',
-          'LA',
-          'LV',
-          'LB',
-          'LS',
-          'LR',
-          'LY',
-          'LI',
-          'LT',
-          'LU',
-          'MO',
-          'MG',
-          'MW',
-          'MY',
-          'MV',
-          'ML',
-          'MT',
-          'MH',
-          'MQ',
-          'MR',
-          'MU',
-          'YT',
-          'MX',
-          'FM',
-          'MD',
-          'MC',
-          'MN',
-          'MS',
-          'MA',
-          'MZ',
-          'MM',
-          'NA',
-          'NR',
-          'NP',
-          'NL',
-          'NC',
-          'NZ',
-          'NI',
-          'NE',
-          'NG',
-          'NU',
-          'NF',
-          'MK',
-          'MP',
-          'NO',
-          'OM',
-          'PK',
-          'PW',
-          'PS',
-          'PA',
-          'PG',
-          'PY',
-          'PE',
-          'PH',
-          'PN',
-          'PL',
-          'PT',
-          'PR',
-          'QA',
-          'RE',
-          'RO',
-          'RU',
-          'RW',
-          'SH',
-          'KN',
-          'LC',
-          'PM',
-          'VC',
-          'WS',
-          'SM',
-          'ST',
-          'SA',
-          'SN',
-          'SC',
-          'SL',
-          'SG',
-          'SK',
-          'SI',
-          'SB',
-          'SO',
-          'ZA',
-          'GS',
-          'ES',
-          'LK',
-          'SD',
-          'SR',
-          'SJ',
-          'SZ',
-          'SE',
-          'CH',
-          'SY',
-          'TW',
-          'TJ',
-          'TZ',
-          'TH',
-          'TL',
-          'TG',
-          'TK',
-          'TO',
-          'TT',
-          'TN',
-          'TR',
-          'TM',
-          'TC',
-          'TV',
-          'UG',
-          'UA',
-          'AE',
-          'GB',
-          'US',
-          'UM',
-          'UY',
-          'UZ',
-          'VU',
-          'VE',
-          'VN',
-          'VG',
-          'VI',
-          'WF',
-          'EH',
-          'YE',
-          'ZM',
-          'ZW',
-          'AX',
-          'BQ',
-          'CW',
-          'GG',
-          'IM',
-          'JE',
-          'ME',
-          'BL',
-          'MF',
-          'RS',
-          'SX',
-          'SS',
-          'XK',
-        ],
-      },
-    },
-  },
-  annotations: {
-    readOnlyHint: true,
-  },
-};
-
-export const handler = async (client: Codeqr, args: Record<string, unknown> | undefined) => {
-  const body = args as any;
-  try {
-    return asTextContentResult(await client.analytics.retrieve(body));
-  } catch (error) {
-    if (error instanceof Codeqr.APIError) {
-      return asErrorResult(error.message);
-    }
-    throw error;
-  }
-};
-
-export default { metadata, tool, handler };

package/src/tools/domains/create-domains.ts

@@ -1,75 +0,0 @@
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
-import { isJqError, maybeFilter } from '@codeqr/ts-mcp/filtering';
-import { Metadata, asErrorResult, asTextContentResult } from '@codeqr/ts-mcp/tools/types';
-
-import { Tool } from '@modelcontextprotocol/sdk/types.js';
-import Codeqr from '@codeqr/ts';
-
-export const metadata: Metadata = {
-  resource: 'domains',
-  operation: 'write',
-  tags: [],
-  httpMethod: 'post',
-  httpPath: '/domains',
-  operationId: 'createDomain',
-};
-
-export const tool: Tool = {
-  name: 'create_domains',
-  description:
-    "When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance.\n\nOnly omit if you're sure you don't need the data.\n\nCreate a domain for the authenticated workspace.\n\n# Response Schema\n```json\n{\n  $ref: '#/$defs/domain',\n  $defs: {\n    domain: {\n      type: 'object',\n      properties: {\n        id: {\n          type: 'string',\n          description: 'The unique identifier of the domain.'\n        },\n        archived: {\n          type: 'boolean',\n          description: 'Whether the domain is archived.'\n        },\n        createdAt: {\n          type: 'string',\n          description: 'The date the domain was created.'\n        },\n        expiredUrl: {\n          type: 'string',\n          description: 'The URL to redirect to when a link under this domain has expired.'\n        },\n        placeholder: {\n          type: 'string',\n          description: 'Provide context to your teammates in the link creation modal by showing them an example of a link to be shortened.'\n        },\n        primary: {\n          type: 'boolean',\n          description: 'Whether the domain is the primary domain for the project.'\n        },\n        slug: {\n          type: 'string',\n          description: 'The domain name.'\n        },\n        target: {\n          type: 'string',\n          description: 'The target URL to redirect to when accessing the domain root.'\n        },\n        type: {\n          type: 'string',\n          description: 'The behavior type for the domain root redirect.',\n          enum: [            'redirect',\n            'rewrite'\n          ]\n        },\n        updatedAt: {\n          type: 'string',\n          description: 'The date the domain was last updated.'\n        },\n        verified: {\n          type: 'boolean',\n          description: 'Whether the domain is verified.'\n        }\n      },\n      required: [        'id',\n        'archived',\n        'createdAt',\n        'expiredUrl',\n        'placeholder',\n        'primary',\n        'slug',\n        'target',\n        'type',\n        'updatedAt',\n        'verified'\n      ]\n    }\n  }\n}\n```",
-  inputSchema: {
-    type: 'object',
-    properties: {
-      slug: {
-        type: 'string',
-        description: 'Name of the domain.',
-      },
-      archived: {
-        type: 'boolean',
-        description: 'Whether to archive this domain. `false` will unarchive a previously archived domain.',
-      },
-      expiredUrl: {
-        type: 'string',
-        description: 'Redirect users to a specific URL when any link under this domain has expired.',
-      },
-      placeholder: {
-        type: 'string',
-        description:
-          'Provide context to your teammates in the link creation modal by showing them an example of a link to be shortened.',
-      },
-      target: {
-        type: 'string',
-        description: 'The target URL to redirect to when accessing the domain root.',
-      },
-      type: {
-        type: 'string',
-        description: 'The behavior type for the domain root redirect.',
-        enum: ['redirect', 'rewrite'],
-      },
-      jq_filter: {
-        type: 'string',
-        title: 'jq Filter',
-        description:
-          'A jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available.\n\nFor example: to include only the `name` field in every object of a results array, you can provide ".results[].name".\n\nFor more information, see the [jq documentation](https://jqlang.org/manual/).',
-      },
-    },
-    required: ['slug'],
-  },
-  annotations: {},
-};
-
-export const handler = async (client: Codeqr, args: Record<string, unknown> | undefined) => {
-  const { jq_filter, ...body } = args as any;
-  try {
-    return asTextContentResult(await maybeFilter(jq_filter, await client.domains.create(body)));
-  } catch (error) {
-    if (error instanceof Codeqr.APIError || isJqError(error)) {
-      return asErrorResult(error.message);
-    }
-    throw error;
-  }
-};
-
-export default { metadata, tool, handler };

package/src/tools/domains/delete-domains.ts

@@ -1,55 +0,0 @@
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
-import { isJqError, maybeFilter } from '@codeqr/ts-mcp/filtering';
-import { Metadata, asErrorResult, asTextContentResult } from '@codeqr/ts-mcp/tools/types';
-
-import { Tool } from '@modelcontextprotocol/sdk/types.js';
-import Codeqr from '@codeqr/ts';
-
-export const metadata: Metadata = {
-  resource: 'domains',
-  operation: 'write',
-  tags: [],
-  httpMethod: 'delete',
-  httpPath: '/domains/{slug}',
-  operationId: 'deleteDomain',
-};
-
-export const tool: Tool = {
-  name: 'delete_domains',
-  description:
-    "When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance.\n\nOnly omit if you're sure you don't need the data.\n\nDelete a domain from a workspace. It cannot be undone. This will also delete all the links associated with the domain.\n\n# Response Schema\n```json\n{\n  $ref: '#/$defs/domain_delete_response',\n  $defs: {\n    domain_delete_response: {\n      type: 'object',\n      properties: {\n        slug: {\n          type: 'string',\n          description: 'The domain name.'\n        }\n      },\n      required: [        'slug'\n      ]\n    }\n  }\n}\n```",
-  inputSchema: {
-    type: 'object',
-    properties: {
-      slug: {
-        type: 'string',
-        description: 'The domain name.',
-      },
-      jq_filter: {
-        type: 'string',
-        title: 'jq Filter',
-        description:
-          'A jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available.\n\nFor example: to include only the `name` field in every object of a results array, you can provide ".results[].name".\n\nFor more information, see the [jq documentation](https://jqlang.org/manual/).',
-      },
-    },
-    required: ['slug'],
-  },
-  annotations: {
-    idempotentHint: true,
-  },
-};
-
-export const handler = async (client: Codeqr, args: Record<string, unknown> | undefined) => {
-  const { slug, jq_filter, ...body } = args as any;
-  try {
-    return asTextContentResult(await maybeFilter(jq_filter, await client.domains.delete(slug)));
-  } catch (error) {
-    if (error instanceof Codeqr.APIError || isJqError(error)) {
-      return asErrorResult(error.message);
-    }
-    throw error;
-  }
-};
-
-export default { metadata, tool, handler };

package/src/tools/domains/list-domains.ts

@@ -1,68 +0,0 @@
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
-import { isJqError, maybeFilter } from '@codeqr/ts-mcp/filtering';
-import { Metadata, asErrorResult, asTextContentResult } from '@codeqr/ts-mcp/tools/types';
-
-import { Tool } from '@modelcontextprotocol/sdk/types.js';
-import Codeqr from '@codeqr/ts';
-
-export const metadata: Metadata = {
-  resource: 'domains',
-  operation: 'read',
-  tags: [],
-  httpMethod: 'get',
-  httpPath: '/domains',
-  operationId: 'listDomains',
-};
-
-export const tool: Tool = {
-  name: 'list_domains',
-  description:
-    "When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance.\n\nOnly omit if you're sure you don't need the data.\n\nRetrieve a list of domains associated with the authenticated workspace.\n\n# Response Schema\n```json\n{\n  $ref: '#/$defs/domain_list_response',\n  $defs: {\n    domain_list_response: {\n      type: 'array',\n      items: {\n        $ref: '#/$defs/domain'\n      }\n    },\n    domain: {\n      type: 'object',\n      properties: {\n        id: {\n          type: 'string',\n          description: 'The unique identifier of the domain.'\n        },\n        archived: {\n          type: 'boolean',\n          description: 'Whether the domain is archived.'\n        },\n        createdAt: {\n          type: 'string',\n          description: 'The date the domain was created.'\n        },\n        expiredUrl: {\n          type: 'string',\n          description: 'The URL to redirect to when a link under this domain has expired.'\n        },\n        placeholder: {\n          type: 'string',\n          description: 'Provide context to your teammates in the link creation modal by showing them an example of a link to be shortened.'\n        },\n        primary: {\n          type: 'boolean',\n          description: 'Whether the domain is the primary domain for the project.'\n        },\n        slug: {\n          type: 'string',\n          description: 'The domain name.'\n        },\n        target: {\n          type: 'string',\n          description: 'The target URL to redirect to when accessing the domain root.'\n        },\n        type: {\n          type: 'string',\n          description: 'The behavior type for the domain root redirect.',\n          enum: [            'redirect',\n            'rewrite'\n          ]\n        },\n        updatedAt: {\n          type: 'string',\n          description: 'The date the domain was last updated.'\n        },\n        verified: {\n          type: 'boolean',\n          description: 'Whether the domain is verified.'\n        }\n      },\n      required: [        'id',\n        'archived',\n        'createdAt',\n        'expiredUrl',\n        'placeholder',\n        'primary',\n        'slug',\n        'target',\n        'type',\n        'updatedAt',\n        'verified'\n      ]\n    }\n  }\n}\n```",
-  inputSchema: {
-    type: 'object',
-    properties: {
-      archived: {
-        type: 'boolean',
-        description:
-          'Whether to include archived domains in the response. Defaults to `false` if not provided.',
-      },
-      page: {
-        type: 'number',
-        description: 'The page number for pagination.',
-      },
-      pageSize: {
-        type: 'number',
-        description: 'The number of items per page.',
-      },
-      search: {
-        type: 'string',
-        description: 'The search term to filter the domains by.',
-      },
-      jq_filter: {
-        type: 'string',
-        title: 'jq Filter',
-        description:
-          'A jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available.\n\nFor example: to include only the `name` field in every object of a results array, you can provide ".results[].name".\n\nFor more information, see the [jq documentation](https://jqlang.org/manual/).',
-      },
-    },
-    required: [],
-  },
-  annotations: {
-    readOnlyHint: true,
-  },
-};
-
-export const handler = async (client: Codeqr, args: Record<string, unknown> | undefined) => {
-  const { jq_filter, ...body } = args as any;
-  try {
-    return asTextContentResult(await maybeFilter(jq_filter, await client.domains.list(body)));
-  } catch (error) {
-    if (error instanceof Codeqr.APIError || isJqError(error)) {
-      return asErrorResult(error.message);
-    }
-    throw error;
-  }
-};
-
-export default { metadata, tool, handler };