@codeqr/ts 0.1.2

package/src/resources/qrcodes/qrcodes.ts

@@ -0,0 +1,3307 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as TagsAPI from '../tags';
+import * as BulkAPI from './bulk';
+import { Bulk, BulkCreateParams, BulkCreateResponse, BulkDeleteParams, BulkDeleteResponse } from './bulk';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class Qrcodes extends APIResource {
+  bulk: BulkAPI.Bulk = new BulkAPI.Bulk(this._client);
+
+  /**
+   * Create a new QR Code for the authenticated workspace.
+   *
+   * @example
+   * ```ts
+   * const qrCode = await client.qrcodes.create({ type: 'url' });
+   * ```
+   */
+  create(body: QrcodeCreateParams, options?: RequestOptions): APIPromise<QrCode> {
+    return this._client.post('/qrcodes', { body, ...options });
+  }
+
+  /**
+   * Retrieve the info for a QR Code.
+   *
+   * @example
+   * ```ts
+   * const qrCode = await client.qrcodes.retrieve({
+   *   domain: 'x',
+   *   key: 'x',
+   *   projectSlug: 'x',
+   * });
+   * ```
+   */
+  retrieve(query: QrcodeRetrieveParams, options?: RequestOptions): APIPromise<QrCode> {
+    return this._client.get('/qrcodes/info', { query, ...options });
+  }
+
+  /**
+   * Update a QR Code for the authenticated workspace. If there's no change, returns
+   * it as it is.
+   *
+   * @example
+   * ```ts
+   * const qrCode = await client.qrcodes.update('qrcodeId');
+   * ```
+   */
+  update(
+    qrcodeID: string,
+    body: QrcodeUpdateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<QrCode> {
+    return this._client.put(path`/qrcodes/${qrcodeID}`, { body, ...options });
+  }
+
+  /**
+   * Retrieve a paginated list of QR Codes for the authenticated workspace.
+   *
+   * @example
+   * ```ts
+   * const qrCodes = await client.qrcodes.list();
+   * ```
+   */
+  list(
+    query: QrcodeListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<QrcodeListResponse> {
+    return this._client.get('/qrcodes', { query, ...options });
+  }
+
+  /**
+   * Delete a QR Code for the authenticated workspace.
+   *
+   * @example
+   * ```ts
+   * const qrcode = await client.qrcodes.delete('qrcodeId');
+   * ```
+   */
+  delete(qrcodeID: string, options?: RequestOptions): APIPromise<QrcodeDeleteResponse> {
+    return this._client.delete(path`/qrcodes/${qrcodeID}`, options);
+  }
+
+  /**
+   * Retrieve the number of QR Codes for the authenticated workspace.
+   *
+   * @example
+   * ```ts
+   * const response = await client.qrcodes.count();
+   * ```
+   */
+  count(
+    query: QrcodeCountParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<QrcodeCountResponse> {
+    return this._client.get('/qrcodes/count', { query, ...options });
+  }
+
+  /**
+   * Upsert a QR Code for the authenticated workspace by its URL. If a QR Code with
+   * the same URL already exists, return it (or update it if there are any changes).
+   * Otherwise, a new QR Code will be created.
+   *
+   * @example
+   * ```ts
+   * const qrCode = await client.qrcodes.upsert({ type: 'url' });
+   * ```
+   */
+  upsert(body: QrcodeUpsertParams, options?: RequestOptions): APIPromise<QrCode> {
+    return this._client.patch('/qrcodes/upsert', { body, ...options });
+  }
+}
+
+export interface QrCode {
+  /**
+   * The unique ID of the QR code.
+   */
+  id: string;
+
+  /**
+   * The destination URL for Android for the QR code for device targeting Android.
+   */
+  android: string | null;
+
+  /**
+   * If the QR code is archived.
+   */
+  archived: boolean;
+
+  /**
+   * The background color of the QR code.
+   */
+  bgColor: string;
+
+  /**
+   * The comments for the QR code.
+   */
+  comments: string | null;
+
+  /**
+   * The static content of the QR code.
+   */
+  contentStatic: string | null;
+
+  /**
+   * The date and time the QR code was created.
+   */
+  createdAt: string;
+
+  /**
+   * The cryptocurrency information of the QR code.
+   */
+  crypto: { [key: string]: string } | null;
+
+  /**
+   * The description of the QR code generated via `api.codeqr.io/metatags`. Will be
+   * used for custom link preview if `proxy` is true.
+   */
+  description: string | null;
+
+  /**
+   * If the QR code should be indexed.
+   */
+  doIndex: boolean;
+
+  /**
+   * 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).
+   */
+  domain: string;
+
+  /**
+   * The email information of the QR code.
+   */
+  email: { [key: string]: string } | null;
+
+  /**
+   * If the QR code should be excavated.
+   */
+  excavate: boolean;
+
+  /**
+   * The destination URL when the QR code expires.
+   */
+  expiredUrl: string | null;
+
+  /**
+   * The date and time the QR code will expire in ISO-8601 format. Must be in the
+   * future.
+   */
+  expiresAt: string | null;
+
+  /**
+   * The external ID associated with the QR code.
+   */
+  externalId: string | null;
+
+  /**
+   * The FaceTime information of the QR code.
+   */
+  facetime: { [key: string]: string } | null;
+
+  /**
+   * The foreground color of the QR code.
+   */
+  fgColor: string;
+
+  /**
+   * If the QR code is filled.
+   */
+  filled: boolean;
+
+  /**
+   * If the QR code is flexible.
+   */
+  flexible: boolean;
+
+  /**
+   * Geographic segmentation information for the QR code in the JSON format
+   * `{[COUNTRY]: https://example.com }`. Learn more: https://codeqr.link/geo
+   */
+  geo: { [key: string]: string } | null;
+
+  /**
+   * The height of the QR code.
+   */
+  height: number;
+
+  /**
+   * The image of the QR code generated via `api.codeqr.io/metatags`. Will be used
+   * for custom link preview if `proxy` is true.
+   */
+  image: string | null;
+
+  /**
+   * The destination URL for iOS for the QR code for device targeting iOS.
+   */
+  ios: string | null;
+
+  /**
+   * If the form is mandatory for the page.
+   */
+  isFormMandatory: boolean;
+
+  /**
+   * The slug of the QR code. If not provided, a random slug of 7 characters will be
+   * generated.
+   */
+  key: string;
+
+  /**
+   * The date and time the QR code was scanned last.
+   */
+  lastClicked: string | null;
+
+  /**
+   * The latitude and longitude information of the QR code.
+   */
+  latlog: { [key: string]: string } | null;
+
+  /**
+   * The number of leads generated by the QR code.
+   */
+  leads: number;
+
+  /**
+   * The level of error correction of the QR code.
+   */
+  level: string;
+
+  /**
+   * The logo of the QR code.
+   */
+  logo: string | null;
+
+  /**
+   * The notification token of the QR code.
+   */
+  notificationToken: string | null;
+
+  /**
+   * The password required to access the destination URL of the QR code.
+   */
+  password: string | null;
+
+  /**
+   * The phone number of the QR code.
+   */
+  phone: string | null;
+
+  /**
+   * If the QR code has pre-redirection.
+   */
+  preRedirection: boolean;
+
+  /**
+   * The ID of the project of the QR code.
+   */
+  projectId: string | null;
+
+  /**
+   * If the QR code uses the custom link preview feature.
+   */
+  proxy: boolean;
+
+  /**
+   * If the statistics of the QR code are publicly accessible.
+   */
+  publicStats: boolean;
+
+  /**
+   * If the QR code uses link cloaking.
+   */
+  rewrite: boolean;
+
+  /**
+   * The amount of the sale generated by the link.
+   */
+  saleAmount: number;
+
+  /**
+   * The number of sales generated by the QR code.
+   */
+  sales: number;
+
+  /**
+   * The number of scans of the QR code.
+   */
+  scans: number;
+
+  /**
+   * If the logo should be displayed in the QR code.
+   */
+  showLogo: boolean;
+
+  /**
+   * The size of the QR code.
+   */
+  size: number;
+
+  /**
+   * The SMS information of the QR code.
+   */
+  sms: { [key: string]: string } | null;
+
+  /**
+   * The source of the QR code.
+   */
+  src: string | null;
+
+  /**
+   * If the QR code is static.
+   */
+  static: boolean;
+
+  /**
+   * @deprecated [DEPRECATED (use `tags` instead)]: The unique ID of the tag assigned
+   * to the QR code.
+   */
+  tagId: string | null;
+
+  /**
+   * The tags assigned to the QR code.
+   */
+  tags: Array<TagsAPI.Tag> | null;
+
+  /**
+   * The text of the QR code.
+   */
+  text: string | null;
+
+  /**
+   * The title of the QR code generated via `api.codeqr.io/metatags`. Will be used
+   * for custom link preview if `proxy` is true.
+   */
+  title: string | null;
+
+  /**
+   * [BETA] If should track conversions for the QR code.
+   */
+  trackConversion: boolean;
+
+  /**
+   * The type of the QR code.
+   */
+  type:
+    | 'url'
+    | 'text'
+    | 'email'
+    | 'wifi'
+    | 'phone'
+    | 'vcard'
+    | 'crypto'
+    | 'sms'
+    | 'facetime'
+    | 'latlog'
+    | 'pix';
+
+  /**
+   * The date and time the QR code was updated last.
+   */
+  updatedAt: string;
+
+  /**
+   * The URL of the QR code.
+   */
+  url: string | null;
+
+  /**
+   * The ID of the user that created the QR code.
+   */
+  userId: string | null;
+
+  /**
+   * The campaign UTM of the QR code.
+   */
+  utm_campaign: string | null;
+
+  /**
+   * The content UTM of the QR code.
+   */
+  utm_content: string | null;
+
+  /**
+   * The medium UTM of the QR code.
+   */
+  utm_medium: string | null;
+
+  /**
+   * The source UTM of the QR code.
+   */
+  utm_source: string | null;
+
+  /**
+   * The term UTM of the QR code.
+   */
+  utm_term: string | null;
+
+  /**
+   * The vCard information of the QR code.
+   */
+  vcard: { [key: string]: string } | null;
+
+  /**
+   * The width of the QR code.
+   */
+  width: number;
+
+  /**
+   * The WiFi information of the QR code.
+   */
+  wifi: { [key: string]: string } | null;
+
+  /**
+   * The ID of the page to redirect to before the QR code destination.
+   */
+  pageId?: string | null;
+
+  /**
+   * The URL of the page to redirect to before the QR code destination.
+   */
+  pageUrl?: string | null;
+}
+
+export type QrcodeListResponse = Array<QrCode>;
+
+export interface QrcodeDeleteResponse {
+  /**
+   * The ID of the QR Code.
+   */
+  id: string;
+}
+
+/**
+ * The number of QR Codes matching the query.
+ */
+export type QrcodeCountResponse = number;
+
+export interface QrcodeCreateParams {
+  /**
+   * The type of content of the QR code.
+   */
+  type: 'url' | 'text' | 'email' | 'wifi' | 'phone' | 'vcard' | 'crypto' | 'sms' | 'facetime' | 'latlog';
+
+  /**
+   * The destination URL for Android for the QR code for device targeting Android.
+   */
+  android?: string | null;
+
+  /**
+   * If the QR code is archived.
+   */
+  archived?: boolean;
+
+  /**
+   * The background color of the QR code.
+   */
+  bgColor?: string;
+
+  /**
+   * The comments for the QR code.
+   */
+  comments?: string | null;
+
+  /**
+   * The static content of the QR code.
+   */
+  contentStatic?: string | null;
+
+  /**
+   * The cryptocurrency information of the QR code.
+   */
+  crypto?: { [key: string]: string } | null;
+
+  /**
+   * The description of the QR code generated via `api.codeqr.io/metatags`. Will be
+   * used for custom link preview if `proxy` is true.
+   */
+  description?: string | null;
+
+  /**
+   * Allow search engines to index your QR code. The default is `false` if not
+   * provided. Learn more: https://codeqr.link/noindex
+   */
+  doIndex?: boolean;
+
+  /**
+   * 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).
+   */
+  domain?: string;
+
+  /**
+   * The email information of the QR code.
+   */
+  email?: { [key: string]: string } | null;
+
+  /**
+   * If the QR code should have excavated areas.
+   */
+  excavate?: boolean;
+
+  /**
+   * The URL to redirect when the QR code expires.
+   */
+  expiredUrl?: string | null;
+
+  /**
+   * The date and time the QR code will expire in ISO-8601 format. Must be in the
+   * future.
+   */
+  expiresAt?: string | null;
+
+  /**
+   * 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.
+   */
+  externalId?: string | null;
+
+  /**
+   * The FaceTime information of the QR code.
+   */
+  facetime?: { [key: string]: string } | null;
+
+  /**
+   * The foreground color of the QR code.
+   */
+  fgColor?: string;
+
+  /**
+   * If the QR code is filled.
+   */
+  filled?: boolean;
+
+  /**
+   * If the QR code is flexible.
+   */
+  flexible?: boolean;
+
+  /**
+   * The type of frame of the QR code.
+   */
+  frame?: string;
+
+  /**
+   * The color of the frame of the QR code.
+   */
+  frameColor?: string;
+
+  /**
+   * The text of the frame of the QR code.
+   */
+  frameText?: string;
+
+  /**
+   * Geographic segmentation information for the QR code in the JSON format
+   * `{[COUNTRY]: https://example.com }`.
+   */
+  geo?: QrcodeCreateParams.Geo | null;
+
+  /**
+   * The height of the QR code.
+   */
+  height?: number;
+
+  /**
+   * The image of the QR code generated via `api.codeqr.io/metatags`. Will be used
+   * for custom link preview if `proxy` is true.
+   */
+  image?: string | null;
+
+  /**
+   * The destination URL for iOS for the QR code for device targeting iOS.
+   */
+  ios?: string | null;
+
+  /**
+   * If the form is mandatory for the page.
+   */
+  isFormMandatory?: boolean;
+
+  /**
+   * The slug of the QR code. If not provided, a random slug of 7 characters will be
+   * generated.
+   */
+  key?: string;
+
+  /**
+   * The latitude and longitude information of the QR code.
+   */
+  latlog?: { [key: string]: string } | null;
+
+  /**
+   * The level of error correction of the QR code.
+   */
+  level?: string;
+
+  /**
+   * The logo of the QR code.
+   */
+  logo?: string | null;
+
+  /**
+   * The ID of the page to redirect to before the QR code destination.
+   */
+  pageId?: string | null;
+
+  /**
+   * The URL of the page to redirect to before the QR code destination.
+   */
+  pageUrl?: string | null;
+
+  /**
+   * The password required to access the destination URL of the QR code.
+   */
+  password?: string | null;
+
+  /**
+   * The pattern of the modules of the QR code.
+   */
+  pattern?: string;
+
+  /**
+   * The phone number of the QR code.
+   */
+  phone?: string | null;
+
+  /**
+   * If the QR code has pre-redirection.
+   */
+  preRedirection?: boolean;
+
+  /**
+   * If the QR code uses the custom link preview feature.
+   */
+  proxy?: boolean;
+
+  /**
+   * If the statistics of the QR code are publicly accessible.
+   */
+  publicStats?: boolean;
+
+  /**
+   * If the QR code uses link cloaking.
+   */
+  rewrite?: boolean;
+
+  /**
+   * The shape of the design around the QR code (none, square, circle).
+   */
+  shape?: string;
+
+  /**
+   * If the logo should be displayed in the QR code.
+   */
+  showLogo?: boolean;
+
+  /**
+   * The size of the QR code.
+   */
+  size?: number;
+
+  /**
+   * The SMS information of the QR code.
+   */
+  sms?: { [key: string]: string } | null;
+
+  /**
+   * The image URL of the QR code.
+   */
+  src?: string | null;
+
+  /**
+   * If the QR code is static.
+   */
+  static?: boolean;
+
+  /**
+   * @deprecated The unique ID of the tag assigned to the QR code. This field is
+   * deprecated – use `tagIds` instead.
+   */
+  tagId?: string | null;
+
+  /**
+   * The unique IDs of the tags assigned to the QR code.
+   */
+  tagIds?: string | Array<string>;
+
+  /**
+   * The unique name of the tags assigned to the QR code (case insensitive).
+   */
+  tagNames?: string | Array<string>;
+
+  /**
+   * The text of the QR code.
+   */
+  text?: string | null;
+
+  /**
+   * The title of the QR code generated via `api.codeqr.io/metatags`. Will be used
+   * for custom link preview if `proxy` is true.
+   */
+  title?: string | null;
+
+  /**
+   * If should track conversions for the QR code.
+   */
+  trackConversion?: boolean;
+
+  /**
+   * The destination URL of the QR code.
+   */
+  url?: string | null;
+
+  /**
+   * The vCard information of the QR code.
+   */
+  vcard?: { [key: string]: string } | null;
+
+  /**
+   * An array of webhook IDs to trigger when the link is clicked. These webhooks will
+   * receive click event data.
+   */
+  webhookIds?: Array<string> | null;
+
+  /**
+   * The width of the QR code.
+   */
+  width?: number;
+
+  /**
+   * The WiFi information of the QR code.
+   */
+  wifi?: { [key: string]: string } | null;
+}
+
+export namespace QrcodeCreateParams {
+  /**
+   * Geographic segmentation information for the QR code in the JSON format
+   * `{[COUNTRY]: https://example.com }`.
+   */
+  export interface Geo {
+    AD?: string;
+
+    AE?: string;
+
+    AF?: string;
+
+    AG?: string;
+
+    AI?: string;
+
+    AL?: string;
+
+    AM?: string;
+
+    AO?: string;
+
+    AQ?: string;
+
+    AR?: string;
+
+    AS?: string;
+
+    AT?: string;
+
+    AU?: string;
+
+    AW?: string;
+
+    AX?: string;
+
+    AZ?: string;
+
+    BA?: string;
+
+    BB?: string;
+
+    BD?: string;
+
+    BE?: string;
+
+    BF?: string;
+
+    BG?: string;
+
+    BH?: string;
+
+    BI?: string;
+
+    BJ?: string;
+
+    BL?: string;
+
+    BM?: string;
+
+    BN?: string;
+
+    BO?: string;
+
+    BQ?: string;
+
+    BR?: string;
+
+    BS?: string;
+
+    BT?: string;
+
+    BV?: string;
+
+    BW?: string;
+
+    BY?: string;
+
+    BZ?: string;
+
+    CA?: string;
+
+    CC?: string;
+
+    CD?: string;
+
+    CF?: string;
+
+    CG?: string;
+
+    CH?: string;
+
+    CI?: string;
+
+    CK?: string;
+
+    CL?: string;
+
+    CM?: string;
+
+    CN?: string;
+
+    CO?: string;
+
+    CR?: string;
+
+    CU?: string;
+
+    CV?: string;
+
+    CW?: string;
+
+    CX?: string;
+
+    CY?: string;
+
+    CZ?: string;
+
+    DE?: string;
+
+    DJ?: string;
+
+    DK?: string;
+
+    DM?: string;
+
+    DO?: string;
+
+    DZ?: string;
+
+    EC?: string;
+
+    EE?: string;
+
+    EG?: string;
+
+    EH?: string;
+
+    ER?: string;
+
+    ES?: string;
+
+    ET?: string;
+
+    FI?: string;
+
+    FJ?: string;
+
+    FK?: string;
+
+    FM?: string;
+
+    FO?: string;
+
+    FR?: string;
+
+    GA?: string;
+
+    GB?: string;
+
+    GD?: string;
+
+    GE?: string;
+
+    GF?: string;
+
+    GG?: string;
+
+    GH?: string;
+
+    GI?: string;
+
+    GL?: string;
+
+    GM?: string;
+
+    GN?: string;
+
+    GP?: string;
+
+    GQ?: string;
+
+    GR?: string;
+
+    GS?: string;
+
+    GT?: string;
+
+    GU?: string;
+
+    GW?: string;
+
+    GY?: string;
+
+    HK?: string;
+
+    HM?: string;
+
+    HN?: string;
+
+    HR?: string;
+
+    HT?: string;
+
+    HU?: string;
+
+    ID?: string;
+
+    IE?: string;
+
+    IL?: string;
+
+    IM?: string;
+
+    IN?: string;
+
+    IO?: string;
+
+    IQ?: string;
+
+    IR?: string;
+
+    IS?: string;
+
+    IT?: string;
+
+    JE?: string;
+
+    JM?: string;
+
+    JO?: string;
+
+    JP?: string;
+
+    KE?: string;
+
+    KG?: string;
+
+    KH?: string;
+
+    KI?: string;
+
+    KM?: string;
+
+    KN?: string;
+
+    KP?: string;
+
+    KR?: string;
+
+    KW?: string;
+
+    KY?: string;
+
+    KZ?: string;
+
+    LA?: string;
+
+    LB?: string;
+
+    LC?: string;
+
+    LI?: string;
+
+    LK?: string;
+
+    LR?: string;
+
+    LS?: string;
+
+    LT?: string;
+
+    LU?: string;
+
+    LV?: string;
+
+    LY?: string;
+
+    MA?: string;
+
+    MC?: string;
+
+    MD?: string;
+
+    ME?: string;
+
+    MF?: string;
+
+    MG?: string;
+
+    MH?: string;
+
+    MK?: string;
+
+    ML?: string;
+
+    MM?: string;
+
+    MN?: string;
+
+    MO?: string;
+
+    MP?: string;
+
+    MQ?: string;
+
+    MR?: string;
+
+    MS?: string;
+
+    MT?: string;
+
+    MU?: string;
+
+    MV?: string;
+
+    MW?: string;
+
+    MX?: string;
+
+    MY?: string;
+
+    MZ?: string;
+
+    NA?: string;
+
+    NC?: string;
+
+    NE?: string;
+
+    NF?: string;
+
+    NG?: string;
+
+    NI?: string;
+
+    NL?: string;
+
+    NO?: string;
+
+    NP?: string;
+
+    NR?: string;
+
+    NU?: string;
+
+    NZ?: string;
+
+    OM?: string;
+
+    PA?: string;
+
+    PE?: string;
+
+    PF?: string;
+
+    PG?: string;
+
+    PH?: string;
+
+    PK?: string;
+
+    PL?: string;
+
+    PM?: string;
+
+    PN?: string;
+
+    PR?: string;
+
+    PS?: string;
+
+    PT?: string;
+
+    PW?: string;
+
+    PY?: string;
+
+    QA?: string;
+
+    RE?: string;
+
+    RO?: string;
+
+    RS?: string;
+
+    RU?: string;
+
+    RW?: string;
+
+    SA?: string;
+
+    SB?: string;
+
+    SC?: string;
+
+    SD?: string;
+
+    SE?: string;
+
+    SG?: string;
+
+    SH?: string;
+
+    SI?: string;
+
+    SJ?: string;
+
+    SK?: string;
+
+    SL?: string;
+
+    SM?: string;
+
+    SN?: string;
+
+    SO?: string;
+
+    SR?: string;
+
+    SS?: string;
+
+    ST?: string;
+
+    SV?: string;
+
+    SX?: string;
+
+    SY?: string;
+
+    SZ?: string;
+
+    TC?: string;
+
+    TD?: string;
+
+    TF?: string;
+
+    TG?: string;
+
+    TH?: string;
+
+    TJ?: string;
+
+    TK?: string;
+
+    TL?: string;
+
+    TM?: string;
+
+    TN?: string;
+
+    TO?: string;
+
+    TR?: string;
+
+    TT?: string;
+
+    TV?: string;
+
+    TW?: string;
+
+    TZ?: string;
+
+    UA?: string;
+
+    UG?: string;
+
+    UM?: string;
+
+    US?: string;
+
+    UY?: string;
+
+    UZ?: string;
+
+    VA?: string;
+
+    VC?: string;
+
+    VE?: string;
+
+    VG?: string;
+
+    VI?: string;
+
+    VN?: string;
+
+    VU?: string;
+
+    WF?: string;
+
+    WS?: string;
+
+    XK?: string;
+
+    YE?: string;
+
+    YT?: string;
+
+    ZA?: string;
+
+    ZM?: string;
+
+    ZW?: string;
+  }
+}
+
+export interface QrcodeRetrieveParams {
+  /**
+   * The domain of the QR code to be retrieved. For example, for
+   * `codeqr.link/github`, the domain is `codeqr.link`.
+   */
+  domain: string;
+
+  /**
+   * The key of the QR code to be retrieved. For example, for `codeqr.link/github`,
+   * the key is `github`.
+   */
+  key: string;
+
+  /**
+   * The slug of the project to which the QR code belongs. For example, for
+   * `app.codeqr.io/acme`, the projectSlug is `acme`.
+   */
+  projectSlug: string;
+
+  /**
+   * This is the ID of the QR code in your database. It must be prefixed with `ext_`
+   * when passed as a query parameter.
+   */
+  externalId?: string;
+
+  /**
+   * The unique ID of the QR code.
+   */
+  qrCodeId?: string;
+}
+
+export interface QrcodeUpdateParams {
+  /**
+   * The destination URL for Android for the QR code for device targeting Android.
+   */
+  android?: string | null;
+
+  /**
+   * If the QR code is archived.
+   */
+  archived?: boolean;
+
+  /**
+   * The background color of the QR code.
+   */
+  bgColor?: string;
+
+  /**
+   * The comments for the QR code.
+   */
+  comments?: string | null;
+
+  /**
+   * The static content of the QR code.
+   */
+  contentStatic?: string | null;
+
+  /**
+   * The cryptocurrency information of the QR code.
+   */
+  crypto?: { [key: string]: string } | null;
+
+  /**
+   * The description of the QR code generated via `api.codeqr.io/metatags`. Will be
+   * used for custom link preview if `proxy` is true.
+   */
+  description?: string | null;
+
+  /**
+   * Allow search engines to index your QR code. The default is `false` if not
+   * provided. Learn more: https://codeqr.link/noindex
+   */
+  doIndex?: boolean;
+
+  /**
+   * 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).
+   */
+  domain?: string;
+
+  /**
+   * The email information of the QR code.
+   */
+  email?: { [key: string]: string } | null;
+
+  /**
+   * If the QR code should have excavated areas.
+   */
+  excavate?: boolean;
+
+  /**
+   * The URL to redirect when the QR code expires.
+   */
+  expiredUrl?: string | null;
+
+  /**
+   * The date and time the QR code will expire in ISO-8601 format. Must be in the
+   * future.
+   */
+  expiresAt?: string | null;
+
+  /**
+   * 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.
+   */
+  externalId?: string | null;
+
+  /**
+   * The FaceTime information of the QR code.
+   */
+  facetime?: { [key: string]: string } | null;
+
+  /**
+   * The foreground color of the QR code.
+   */
+  fgColor?: string;
+
+  /**
+   * If the QR code is filled.
+   */
+  filled?: boolean;
+
+  /**
+   * If the QR code is flexible.
+   */
+  flexible?: boolean;
+
+  /**
+   * The type of frame of the QR code.
+   */
+  frame?: string;
+
+  /**
+   * The color of the frame of the QR code.
+   */
+  frameColor?: string;
+
+  /**
+   * The text of the frame of the QR code.
+   */
+  frameText?: string;
+
+  /**
+   * Geographic segmentation information for the QR code in the JSON format
+   * `{[COUNTRY]: https://example.com }`.
+   */
+  geo?: QrcodeUpdateParams.Geo | null;
+
+  /**
+   * The height of the QR code.
+   */
+  height?: number;
+
+  /**
+   * The image of the QR code generated via `api.codeqr.io/metatags`. Will be used
+   * for custom link preview if `proxy` is true.
+   */
+  image?: string | null;
+
+  /**
+   * The destination URL for iOS for the QR code for device targeting iOS.
+   */
+  ios?: string | null;
+
+  /**
+   * If the form is mandatory for the page.
+   */
+  isFormMandatory?: boolean;
+
+  /**
+   * The slug of the QR code. If not provided, a random slug of 7 characters will be
+   * generated.
+   */
+  key?: string;
+
+  /**
+   * The latitude and longitude information of the QR code.
+   */
+  latlog?: { [key: string]: string } | null;
+
+  /**
+   * The level of error correction of the QR code.
+   */
+  level?: string;
+
+  /**
+   * The logo of the QR code.
+   */
+  logo?: string | null;
+
+  /**
+   * The ID of the page to redirect to before the QR code destination.
+   */
+  pageId?: string | null;
+
+  /**
+   * The URL of the page to redirect to before the QR code destination.
+   */
+  pageUrl?: string | null;
+
+  /**
+   * The password required to access the destination URL of the QR code.
+   */
+  password?: string | null;
+
+  /**
+   * The pattern of the modules of the QR code.
+   */
+  pattern?: string;
+
+  /**
+   * The phone number of the QR code.
+   */
+  phone?: string | null;
+
+  /**
+   * If the QR code has pre-redirection.
+   */
+  preRedirection?: boolean;
+
+  /**
+   * If the QR code uses the custom link preview feature.
+   */
+  proxy?: boolean;
+
+  /**
+   * If the statistics of the QR code are publicly accessible.
+   */
+  publicStats?: boolean;
+
+  /**
+   * If the QR code uses link cloaking.
+   */
+  rewrite?: boolean;
+
+  /**
+   * The shape of the design around the QR code (none, square, circle).
+   */
+  shape?: string;
+
+  /**
+   * If the logo should be displayed in the QR code.
+   */
+  showLogo?: boolean;
+
+  /**
+   * The size of the QR code.
+   */
+  size?: number;
+
+  /**
+   * The SMS information of the QR code.
+   */
+  sms?: { [key: string]: string } | null;
+
+  /**
+   * The image URL of the QR code.
+   */
+  src?: string | null;
+
+  /**
+   * If the QR code is static.
+   */
+  static?: boolean;
+
+  /**
+   * @deprecated The unique ID of the tag assigned to the QR code. This field is
+   * deprecated – use `tagIds` instead.
+   */
+  tagId?: string | null;
+
+  /**
+   * The unique IDs of the tags assigned to the QR code.
+   */
+  tagIds?: string | Array<string>;
+
+  /**
+   * The unique name of the tags assigned to the QR code (case insensitive).
+   */
+  tagNames?: string | Array<string>;
+
+  /**
+   * The text of the QR code.
+   */
+  text?: string | null;
+
+  /**
+   * The title of the QR code generated via `api.codeqr.io/metatags`. Will be used
+   * for custom link preview if `proxy` is true.
+   */
+  title?: string | null;
+
+  /**
+   * If should track conversions for the QR code.
+   */
+  trackConversion?: boolean;
+
+  /**
+   * The type of content of the QR code.
+   */
+  type?: 'url' | 'text' | 'email' | 'wifi' | 'phone' | 'vcard' | 'crypto' | 'sms' | 'facetime' | 'latlog';
+
+  /**
+   * The destination URL of the QR code.
+   */
+  url?: string | null;
+
+  /**
+   * The vCard information of the QR code.
+   */
+  vcard?: { [key: string]: string } | null;
+
+  /**
+   * An array of webhook IDs to trigger when the link is clicked. These webhooks will
+   * receive click event data.
+   */
+  webhookIds?: Array<string> | null;
+
+  /**
+   * The width of the QR code.
+   */
+  width?: number;
+
+  /**
+   * The WiFi information of the QR code.
+   */
+  wifi?: { [key: string]: string } | null;
+}
+
+export namespace QrcodeUpdateParams {
+  /**
+   * Geographic segmentation information for the QR code in the JSON format
+   * `{[COUNTRY]: https://example.com }`.
+   */
+  export interface Geo {
+    AD?: string;
+
+    AE?: string;
+
+    AF?: string;
+
+    AG?: string;
+
+    AI?: string;
+
+    AL?: string;
+
+    AM?: string;
+
+    AO?: string;
+
+    AQ?: string;
+
+    AR?: string;
+
+    AS?: string;
+
+    AT?: string;
+
+    AU?: string;
+
+    AW?: string;
+
+    AX?: string;
+
+    AZ?: string;
+
+    BA?: string;
+
+    BB?: string;
+
+    BD?: string;
+
+    BE?: string;
+
+    BF?: string;
+
+    BG?: string;
+
+    BH?: string;
+
+    BI?: string;
+
+    BJ?: string;
+
+    BL?: string;
+
+    BM?: string;
+
+    BN?: string;
+
+    BO?: string;
+
+    BQ?: string;
+
+    BR?: string;
+
+    BS?: string;
+
+    BT?: string;
+
+    BV?: string;
+
+    BW?: string;
+
+    BY?: string;
+
+    BZ?: string;
+
+    CA?: string;
+
+    CC?: string;
+
+    CD?: string;
+
+    CF?: string;
+
+    CG?: string;
+
+    CH?: string;
+
+    CI?: string;
+
+    CK?: string;
+
+    CL?: string;
+
+    CM?: string;
+
+    CN?: string;
+
+    CO?: string;
+
+    CR?: string;
+
+    CU?: string;
+
+    CV?: string;
+
+    CW?: string;
+
+    CX?: string;
+
+    CY?: string;
+
+    CZ?: string;
+
+    DE?: string;
+
+    DJ?: string;
+
+    DK?: string;
+
+    DM?: string;
+
+    DO?: string;
+
+    DZ?: string;
+
+    EC?: string;
+
+    EE?: string;
+
+    EG?: string;
+
+    EH?: string;
+
+    ER?: string;
+
+    ES?: string;
+
+    ET?: string;
+
+    FI?: string;
+
+    FJ?: string;
+
+    FK?: string;
+
+    FM?: string;
+
+    FO?: string;
+
+    FR?: string;
+
+    GA?: string;
+
+    GB?: string;
+
+    GD?: string;
+
+    GE?: string;
+
+    GF?: string;
+
+    GG?: string;
+
+    GH?: string;
+
+    GI?: string;
+
+    GL?: string;
+
+    GM?: string;
+
+    GN?: string;
+
+    GP?: string;
+
+    GQ?: string;
+
+    GR?: string;
+
+    GS?: string;
+
+    GT?: string;
+
+    GU?: string;
+
+    GW?: string;
+
+    GY?: string;
+
+    HK?: string;
+
+    HM?: string;
+
+    HN?: string;
+
+    HR?: string;
+
+    HT?: string;
+
+    HU?: string;
+
+    ID?: string;
+
+    IE?: string;
+
+    IL?: string;
+
+    IM?: string;
+
+    IN?: string;
+
+    IO?: string;
+
+    IQ?: string;
+
+    IR?: string;
+
+    IS?: string;
+
+    IT?: string;
+
+    JE?: string;
+
+    JM?: string;
+
+    JO?: string;
+
+    JP?: string;
+
+    KE?: string;
+
+    KG?: string;
+
+    KH?: string;
+
+    KI?: string;
+
+    KM?: string;
+
+    KN?: string;
+
+    KP?: string;
+
+    KR?: string;
+
+    KW?: string;
+
+    KY?: string;
+
+    KZ?: string;
+
+    LA?: string;
+
+    LB?: string;
+
+    LC?: string;
+
+    LI?: string;
+
+    LK?: string;
+
+    LR?: string;
+
+    LS?: string;
+
+    LT?: string;
+
+    LU?: string;
+
+    LV?: string;
+
+    LY?: string;
+
+    MA?: string;
+
+    MC?: string;
+
+    MD?: string;
+
+    ME?: string;
+
+    MF?: string;
+
+    MG?: string;
+
+    MH?: string;
+
+    MK?: string;
+
+    ML?: string;
+
+    MM?: string;
+
+    MN?: string;
+
+    MO?: string;
+
+    MP?: string;
+
+    MQ?: string;
+
+    MR?: string;
+
+    MS?: string;
+
+    MT?: string;
+
+    MU?: string;
+
+    MV?: string;
+
+    MW?: string;
+
+    MX?: string;
+
+    MY?: string;
+
+    MZ?: string;
+
+    NA?: string;
+
+    NC?: string;
+
+    NE?: string;
+
+    NF?: string;
+
+    NG?: string;
+
+    NI?: string;
+
+    NL?: string;
+
+    NO?: string;
+
+    NP?: string;
+
+    NR?: string;
+
+    NU?: string;
+
+    NZ?: string;
+
+    OM?: string;
+
+    PA?: string;
+
+    PE?: string;
+
+    PF?: string;
+
+    PG?: string;
+
+    PH?: string;
+
+    PK?: string;
+
+    PL?: string;
+
+    PM?: string;
+
+    PN?: string;
+
+    PR?: string;
+
+    PS?: string;
+
+    PT?: string;
+
+    PW?: string;
+
+    PY?: string;
+
+    QA?: string;
+
+    RE?: string;
+
+    RO?: string;
+
+    RS?: string;
+
+    RU?: string;
+
+    RW?: string;
+
+    SA?: string;
+
+    SB?: string;
+
+    SC?: string;
+
+    SD?: string;
+
+    SE?: string;
+
+    SG?: string;
+
+    SH?: string;
+
+    SI?: string;
+
+    SJ?: string;
+
+    SK?: string;
+
+    SL?: string;
+
+    SM?: string;
+
+    SN?: string;
+
+    SO?: string;
+
+    SR?: string;
+
+    SS?: string;
+
+    ST?: string;
+
+    SV?: string;
+
+    SX?: string;
+
+    SY?: string;
+
+    SZ?: string;
+
+    TC?: string;
+
+    TD?: string;
+
+    TF?: string;
+
+    TG?: string;
+
+    TH?: string;
+
+    TJ?: string;
+
+    TK?: string;
+
+    TL?: string;
+
+    TM?: string;
+
+    TN?: string;
+
+    TO?: string;
+
+    TR?: string;
+
+    TT?: string;
+
+    TV?: string;
+
+    TW?: string;
+
+    TZ?: string;
+
+    UA?: string;
+
+    UG?: string;
+
+    UM?: string;
+
+    US?: string;
+
+    UY?: string;
+
+    UZ?: string;
+
+    VA?: string;
+
+    VC?: string;
+
+    VE?: string;
+
+    VG?: string;
+
+    VI?: string;
+
+    VN?: string;
+
+    VU?: string;
+
+    WF?: string;
+
+    WS?: string;
+
+    XK?: string;
+
+    YE?: string;
+
+    YT?: string;
+
+    ZA?: string;
+
+    ZM?: string;
+
+    ZW?: string;
+  }
+}
+
+export interface QrcodeListParams {
+  /**
+   * The comments to filter by.
+   */
+  comments?: string;
+
+  /**
+   * Filter QR codes created after this date
+   */
+  createdAfter?: string;
+
+  /**
+   * Filter QR codes created before this date
+   */
+  createdBefore?: string;
+
+  /**
+   * The domain to filter the QR codes. For example, `ac.me`. If not provided, all QR
+   * codes of the project will be returned.
+   */
+  domain?: string;
+
+  /**
+   * Filter QR codes expiring after this date
+   */
+  expiresAfter?: string;
+
+  /**
+   * The date and time the QR code will expire in ISO-8601 format. Must be in the
+   * future.
+   */
+  expiresAt?: string | null;
+
+  /**
+   * Filter QR codes expiring before this date
+   */
+  expiresBefore?: string;
+
+  /**
+   * Filter by QR code format - static or dynamic
+   */
+  format?: 'static' | 'dynamic';
+
+  /**
+   * Filter QR codes with/without comments
+   */
+  hasComments?: boolean;
+
+  /**
+   * Filter QR codes with/without custom social media cards
+   */
+  hasCustomSocial?: boolean;
+
+  /**
+   * Filter QR codes with/without device targeting
+   */
+  hasDevice?: boolean;
+
+  /**
+   * Filter QR codes with/without expiration date
+   */
+  hasExpiration?: boolean;
+
+  /**
+   * Filter QR codes with/without geo-targeting
+   */
+  hasGeo?: boolean;
+
+  /**
+   * Filter QR codes with/without password protection
+   */
+  hasPassword?: boolean;
+
+  /**
+   * Filter QR codes with/without tags
+   */
+  hasTags?: boolean;
+
+  /**
+   * Filter QR codes with/without UTM parameters
+   */
+  hasUTM?: boolean;
+
+  /**
+   * The page number for pagination.
+   */
+  page?: number;
+
+  /**
+   * The number of items per page.
+   */
+  pageSize?: number;
+
+  /**
+   * The password to filter by.
+   */
+  password?: string;
+
+  /**
+   * The slug of the project to which the QR code belongs. For example, for
+   * `app.codeqr.io/acme`, the projectSlug is `acme`.
+   */
+  projectSlug?: string;
+
+  /**
+   * Maximum number of scans
+   */
+  scansMax?: number;
+
+  /**
+   * Minimum number of scans
+   */
+  scansMin?: number;
+
+  /**
+   * The search term to filter the QR codes. The search term will be matched against
+   * the QR code slug and the destination URL.
+   */
+  search?: string;
+
+  /**
+   * If should include archived QR codes in the response. The default is `false` if
+   * not provided.
+   */
+  showArchived?: boolean;
+
+  /**
+   * The field to order the QR codes. The default is `createdAt`, and the order of
+   * sorting is always descending.
+   */
+  sort?: 'createdAt' | 'scans' | 'lastClicked';
+
+  /**
+   * @deprecated [DEPRECATED (use tagIds instead)]: The unique ID of the tag assigned
+   * to the QR code.
+   */
+  tagId?: string;
+
+  /**
+   * The IDs of the tags to filter the QR codes.
+   */
+  tagIds?: string | Array<string>;
+
+  /**
+   * The unique name of the tags assigned to the QR code (case insensitive).
+   */
+  tagNames?: string | Array<string>;
+
+  /**
+   * If should include QR codes with conversion tracking enabled. The default is
+   * `false` if not provided.
+   */
+  trackConversion?: boolean;
+
+  /**
+   * Filter by QR code type
+   */
+  type?:
+    | 'url'
+    | 'text'
+    | 'email'
+    | 'wifi'
+    | 'phone'
+    | 'vcard'
+    | 'crypto'
+    | 'sms'
+    | 'facetime'
+    | 'latlog'
+    | 'pix';
+
+  /**
+   * The ID of the user to filter by.
+   */
+  userId?: string;
+
+  /**
+   * If should include tags in the response. The default is `false` if not provided.
+   */
+  withTags?: boolean;
+}
+
+export interface QrcodeCountParams {
+  /**
+   * The comments to filter by.
+   */
+  comments?: string;
+
+  /**
+   * Filter QR codes created after this date
+   */
+  createdAfter?: string;
+
+  /**
+   * Filter QR codes created before this date
+   */
+  createdBefore?: string;
+
+  /**
+   * The domain to filter the QR codes. For example, `ac.me`. If not provided, all QR
+   * codes of the project will be returned.
+   */
+  domain?: string;
+
+  /**
+   * Filter QR codes expiring after this date
+   */
+  expiresAfter?: string;
+
+  /**
+   * The date and time the QR code will expire in ISO-8601 format. Must be in the
+   * future.
+   */
+  expiresAt?: string | null;
+
+  /**
+   * Filter QR codes expiring before this date
+   */
+  expiresBefore?: string;
+
+  /**
+   * Filter by QR code format - static or dynamic
+   */
+  format?: 'static' | 'dynamic';
+
+  /**
+   * The field to group the QR codes.
+   */
+  groupBy?: 'domain' | 'tagId' | 'userId';
+
+  /**
+   * Filter QR codes with/without comments
+   */
+  hasComments?: boolean;
+
+  /**
+   * Filter QR codes with/without custom social media cards
+   */
+  hasCustomSocial?: boolean;
+
+  /**
+   * Filter QR codes with/without device targeting
+   */
+  hasDevice?: boolean;
+
+  /**
+   * Filter QR codes with/without expiration date
+   */
+  hasExpiration?: boolean;
+
+  /**
+   * Filter QR codes with/without geo-targeting
+   */
+  hasGeo?: boolean;
+
+  /**
+   * Filter QR codes with/without password protection
+   */
+  hasPassword?: boolean;
+
+  /**
+   * Filter QR codes with/without tags
+   */
+  hasTags?: boolean;
+
+  /**
+   * Filter QR codes with/without UTM parameters
+   */
+  hasUTM?: boolean;
+
+  /**
+   * The password to filter by.
+   */
+  password?: string;
+
+  /**
+   * The slug of the project to which the QR code belongs. For example, for
+   * `app.codeqr.io/acme`, the projectSlug is `acme`.
+   */
+  projectSlug?: string;
+
+  /**
+   * Maximum number of scans
+   */
+  scansMax?: number;
+
+  /**
+   * Minimum number of scans
+   */
+  scansMin?: number;
+
+  /**
+   * The search term to filter the QR codes. The search term will be matched against
+   * the QR code slug and the destination URL.
+   */
+  search?: string;
+
+  /**
+   * If should include archived QR codes in the response. The default is `false` if
+   * not provided.
+   */
+  showArchived?: boolean;
+
+  /**
+   * @deprecated [DEPRECATED (use tagIds instead)]: The unique ID of the tag assigned
+   * to the QR code.
+   */
+  tagId?: string;
+
+  /**
+   * The IDs of the tags to filter the QR codes.
+   */
+  tagIds?: string | Array<string>;
+
+  /**
+   * The unique name of the tags assigned to the QR code (case insensitive).
+   */
+  tagNames?: string | Array<string>;
+
+  /**
+   * If should include QR codes with conversion tracking enabled. The default is
+   * `false` if not provided.
+   */
+  trackConversion?: boolean;
+
+  /**
+   * Filter by QR code type
+   */
+  type?:
+    | 'url'
+    | 'text'
+    | 'email'
+    | 'wifi'
+    | 'phone'
+    | 'vcard'
+    | 'crypto'
+    | 'sms'
+    | 'facetime'
+    | 'latlog'
+    | 'pix';
+
+  /**
+   * The ID of the user to filter by.
+   */
+  userId?: string;
+
+  /**
+   * If should include tags in the response. The default is `false` if not provided.
+   */
+  withTags?: boolean;
+}
+
+export interface QrcodeUpsertParams {
+  /**
+   * The type of content of the QR code.
+   */
+  type: 'url' | 'text' | 'email' | 'wifi' | 'phone' | 'vcard' | 'crypto' | 'sms' | 'facetime' | 'latlog';
+
+  /**
+   * The destination URL for Android for the QR code for device targeting Android.
+   */
+  android?: string | null;
+
+  /**
+   * If the QR code is archived.
+   */
+  archived?: boolean;
+
+  /**
+   * The background color of the QR code.
+   */
+  bgColor?: string;
+
+  /**
+   * The comments for the QR code.
+   */
+  comments?: string | null;
+
+  /**
+   * The static content of the QR code.
+   */
+  contentStatic?: string | null;
+
+  /**
+   * The cryptocurrency information of the QR code.
+   */
+  crypto?: { [key: string]: string } | null;
+
+  /**
+   * The description of the QR code generated via `api.codeqr.io/metatags`. Will be
+   * used for custom link preview if `proxy` is true.
+   */
+  description?: string | null;
+
+  /**
+   * Allow search engines to index your QR code. The default is `false` if not
+   * provided. Learn more: https://codeqr.link/noindex
+   */
+  doIndex?: boolean;
+
+  /**
+   * 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).
+   */
+  domain?: string;
+
+  /**
+   * The email information of the QR code.
+   */
+  email?: { [key: string]: string } | null;
+
+  /**
+   * If the QR code should have excavated areas.
+   */
+  excavate?: boolean;
+
+  /**
+   * The URL to redirect when the QR code expires.
+   */
+  expiredUrl?: string | null;
+
+  /**
+   * The date and time the QR code will expire in ISO-8601 format. Must be in the
+   * future.
+   */
+  expiresAt?: string | null;
+
+  /**
+   * 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.
+   */
+  externalId?: string | null;
+
+  /**
+   * The FaceTime information of the QR code.
+   */
+  facetime?: { [key: string]: string } | null;
+
+  /**
+   * The foreground color of the QR code.
+   */
+  fgColor?: string;
+
+  /**
+   * If the QR code is filled.
+   */
+  filled?: boolean;
+
+  /**
+   * If the QR code is flexible.
+   */
+  flexible?: boolean;
+
+  /**
+   * The type of frame of the QR code.
+   */
+  frame?: string;
+
+  /**
+   * The color of the frame of the QR code.
+   */
+  frameColor?: string;
+
+  /**
+   * The text of the frame of the QR code.
+   */
+  frameText?: string;
+
+  /**
+   * Geographic segmentation information for the QR code in the JSON format
+   * `{[COUNTRY]: https://example.com }`.
+   */
+  geo?: QrcodeUpsertParams.Geo | null;
+
+  /**
+   * The height of the QR code.
+   */
+  height?: number;
+
+  /**
+   * The image of the QR code generated via `api.codeqr.io/metatags`. Will be used
+   * for custom link preview if `proxy` is true.
+   */
+  image?: string | null;
+
+  /**
+   * The destination URL for iOS for the QR code for device targeting iOS.
+   */
+  ios?: string | null;
+
+  /**
+   * If the form is mandatory for the page.
+   */
+  isFormMandatory?: boolean;
+
+  /**
+   * The slug of the QR code. If not provided, a random slug of 7 characters will be
+   * generated.
+   */
+  key?: string;
+
+  /**
+   * The latitude and longitude information of the QR code.
+   */
+  latlog?: { [key: string]: string } | null;
+
+  /**
+   * The level of error correction of the QR code.
+   */
+  level?: string;
+
+  /**
+   * The logo of the QR code.
+   */
+  logo?: string | null;
+
+  /**
+   * The ID of the page to redirect to before the QR code destination.
+   */
+  pageId?: string | null;
+
+  /**
+   * The URL of the page to redirect to before the QR code destination.
+   */
+  pageUrl?: string | null;
+
+  /**
+   * The password required to access the destination URL of the QR code.
+   */
+  password?: string | null;
+
+  /**
+   * The pattern of the modules of the QR code.
+   */
+  pattern?: string;
+
+  /**
+   * The phone number of the QR code.
+   */
+  phone?: string | null;
+
+  /**
+   * If the QR code has pre-redirection.
+   */
+  preRedirection?: boolean;
+
+  /**
+   * If the QR code uses the custom link preview feature.
+   */
+  proxy?: boolean;
+
+  /**
+   * If the statistics of the QR code are publicly accessible.
+   */
+  publicStats?: boolean;
+
+  /**
+   * If the QR code uses link cloaking.
+   */
+  rewrite?: boolean;
+
+  /**
+   * The shape of the design around the QR code (none, square, circle).
+   */
+  shape?: string;
+
+  /**
+   * If the logo should be displayed in the QR code.
+   */
+  showLogo?: boolean;
+
+  /**
+   * The size of the QR code.
+   */
+  size?: number;
+
+  /**
+   * The SMS information of the QR code.
+   */
+  sms?: { [key: string]: string } | null;
+
+  /**
+   * The image URL of the QR code.
+   */
+  src?: string | null;
+
+  /**
+   * If the QR code is static.
+   */
+  static?: boolean;
+
+  /**
+   * @deprecated The unique ID of the tag assigned to the QR code. This field is
+   * deprecated – use `tagIds` instead.
+   */
+  tagId?: string | null;
+
+  /**
+   * The unique IDs of the tags assigned to the QR code.
+   */
+  tagIds?: string | Array<string>;
+
+  /**
+   * The unique name of the tags assigned to the QR code (case insensitive).
+   */
+  tagNames?: string | Array<string>;
+
+  /**
+   * The text of the QR code.
+   */
+  text?: string | null;
+
+  /**
+   * The title of the QR code generated via `api.codeqr.io/metatags`. Will be used
+   * for custom link preview if `proxy` is true.
+   */
+  title?: string | null;
+
+  /**
+   * If should track conversions for the QR code.
+   */
+  trackConversion?: boolean;
+
+  /**
+   * The destination URL of the QR code.
+   */
+  url?: string | null;
+
+  /**
+   * The vCard information of the QR code.
+   */
+  vcard?: { [key: string]: string } | null;
+
+  /**
+   * An array of webhook IDs to trigger when the link is clicked. These webhooks will
+   * receive click event data.
+   */
+  webhookIds?: Array<string> | null;
+
+  /**
+   * The width of the QR code.
+   */
+  width?: number;
+
+  /**
+   * The WiFi information of the QR code.
+   */
+  wifi?: { [key: string]: string } | null;
+}
+
+export namespace QrcodeUpsertParams {
+  /**
+   * Geographic segmentation information for the QR code in the JSON format
+   * `{[COUNTRY]: https://example.com }`.
+   */
+  export interface Geo {
+    AD?: string;
+
+    AE?: string;
+
+    AF?: string;
+
+    AG?: string;
+
+    AI?: string;
+
+    AL?: string;
+
+    AM?: string;
+
+    AO?: string;
+
+    AQ?: string;
+
+    AR?: string;
+
+    AS?: string;
+
+    AT?: string;
+
+    AU?: string;
+
+    AW?: string;
+
+    AX?: string;
+
+    AZ?: string;
+
+    BA?: string;
+
+    BB?: string;
+
+    BD?: string;
+
+    BE?: string;
+
+    BF?: string;
+
+    BG?: string;
+
+    BH?: string;
+
+    BI?: string;
+
+    BJ?: string;
+
+    BL?: string;
+
+    BM?: string;
+
+    BN?: string;
+
+    BO?: string;
+
+    BQ?: string;
+
+    BR?: string;
+
+    BS?: string;
+
+    BT?: string;
+
+    BV?: string;
+
+    BW?: string;
+
+    BY?: string;
+
+    BZ?: string;
+
+    CA?: string;
+
+    CC?: string;
+
+    CD?: string;
+
+    CF?: string;
+
+    CG?: string;
+
+    CH?: string;
+
+    CI?: string;
+
+    CK?: string;
+
+    CL?: string;
+
+    CM?: string;
+
+    CN?: string;
+
+    CO?: string;
+
+    CR?: string;
+
+    CU?: string;
+
+    CV?: string;
+
+    CW?: string;
+
+    CX?: string;
+
+    CY?: string;
+
+    CZ?: string;
+
+    DE?: string;
+
+    DJ?: string;
+
+    DK?: string;
+
+    DM?: string;
+
+    DO?: string;
+
+    DZ?: string;
+
+    EC?: string;
+
+    EE?: string;
+
+    EG?: string;
+
+    EH?: string;
+
+    ER?: string;
+
+    ES?: string;
+
+    ET?: string;
+
+    FI?: string;
+
+    FJ?: string;
+
+    FK?: string;
+
+    FM?: string;
+
+    FO?: string;
+
+    FR?: string;
+
+    GA?: string;
+
+    GB?: string;
+
+    GD?: string;
+
+    GE?: string;
+
+    GF?: string;
+
+    GG?: string;
+
+    GH?: string;
+
+    GI?: string;
+
+    GL?: string;
+
+    GM?: string;
+
+    GN?: string;
+
+    GP?: string;
+
+    GQ?: string;
+
+    GR?: string;
+
+    GS?: string;
+
+    GT?: string;
+
+    GU?: string;
+
+    GW?: string;
+
+    GY?: string;
+
+    HK?: string;
+
+    HM?: string;
+
+    HN?: string;
+
+    HR?: string;
+
+    HT?: string;
+
+    HU?: string;
+
+    ID?: string;
+
+    IE?: string;
+
+    IL?: string;
+
+    IM?: string;
+
+    IN?: string;
+
+    IO?: string;
+
+    IQ?: string;
+
+    IR?: string;
+
+    IS?: string;
+
+    IT?: string;
+
+    JE?: string;
+
+    JM?: string;
+
+    JO?: string;
+
+    JP?: string;
+
+    KE?: string;
+
+    KG?: string;
+
+    KH?: string;
+
+    KI?: string;
+
+    KM?: string;
+
+    KN?: string;
+
+    KP?: string;
+
+    KR?: string;
+
+    KW?: string;
+
+    KY?: string;
+
+    KZ?: string;
+
+    LA?: string;
+
+    LB?: string;
+
+    LC?: string;
+
+    LI?: string;
+
+    LK?: string;
+
+    LR?: string;
+
+    LS?: string;
+
+    LT?: string;
+
+    LU?: string;
+
+    LV?: string;
+
+    LY?: string;
+
+    MA?: string;
+
+    MC?: string;
+
+    MD?: string;
+
+    ME?: string;
+
+    MF?: string;
+
+    MG?: string;
+
+    MH?: string;
+
+    MK?: string;
+
+    ML?: string;
+
+    MM?: string;
+
+    MN?: string;
+
+    MO?: string;
+
+    MP?: string;
+
+    MQ?: string;
+
+    MR?: string;
+
+    MS?: string;
+
+    MT?: string;
+
+    MU?: string;
+
+    MV?: string;
+
+    MW?: string;
+
+    MX?: string;
+
+    MY?: string;
+
+    MZ?: string;
+
+    NA?: string;
+
+    NC?: string;
+
+    NE?: string;
+
+    NF?: string;
+
+    NG?: string;
+
+    NI?: string;
+
+    NL?: string;
+
+    NO?: string;
+
+    NP?: string;
+
+    NR?: string;
+
+    NU?: string;
+
+    NZ?: string;
+
+    OM?: string;
+
+    PA?: string;
+
+    PE?: string;
+
+    PF?: string;
+
+    PG?: string;
+
+    PH?: string;
+
+    PK?: string;
+
+    PL?: string;
+
+    PM?: string;
+
+    PN?: string;
+
+    PR?: string;
+
+    PS?: string;
+
+    PT?: string;
+
+    PW?: string;
+
+    PY?: string;
+
+    QA?: string;
+
+    RE?: string;
+
+    RO?: string;
+
+    RS?: string;
+
+    RU?: string;
+
+    RW?: string;
+
+    SA?: string;
+
+    SB?: string;
+
+    SC?: string;
+
+    SD?: string;
+
+    SE?: string;
+
+    SG?: string;
+
+    SH?: string;
+
+    SI?: string;
+
+    SJ?: string;
+
+    SK?: string;
+
+    SL?: string;
+
+    SM?: string;
+
+    SN?: string;
+
+    SO?: string;
+
+    SR?: string;
+
+    SS?: string;
+
+    ST?: string;
+
+    SV?: string;
+
+    SX?: string;
+
+    SY?: string;
+
+    SZ?: string;
+
+    TC?: string;
+
+    TD?: string;
+
+    TF?: string;
+
+    TG?: string;
+
+    TH?: string;
+
+    TJ?: string;
+
+    TK?: string;
+
+    TL?: string;
+
+    TM?: string;
+
+    TN?: string;
+
+    TO?: string;
+
+    TR?: string;
+
+    TT?: string;
+
+    TV?: string;
+
+    TW?: string;
+
+    TZ?: string;
+
+    UA?: string;
+
+    UG?: string;
+
+    UM?: string;
+
+    US?: string;
+
+    UY?: string;
+
+    UZ?: string;
+
+    VA?: string;
+
+    VC?: string;
+
+    VE?: string;
+
+    VG?: string;
+
+    VI?: string;
+
+    VN?: string;
+
+    VU?: string;
+
+    WF?: string;
+
+    WS?: string;
+
+    XK?: string;
+
+    YE?: string;
+
+    YT?: string;
+
+    ZA?: string;
+
+    ZM?: string;
+
+    ZW?: string;
+  }
+}
+
+Qrcodes.Bulk = Bulk;
+
+export declare namespace Qrcodes {
+  export {
+    type QrCode as QrCode,
+    type QrcodeListResponse as QrcodeListResponse,
+    type QrcodeDeleteResponse as QrcodeDeleteResponse,
+    type QrcodeCountResponse as QrcodeCountResponse,
+    type QrcodeCreateParams as QrcodeCreateParams,
+    type QrcodeRetrieveParams as QrcodeRetrieveParams,
+    type QrcodeUpdateParams as QrcodeUpdateParams,
+    type QrcodeListParams as QrcodeListParams,
+    type QrcodeCountParams as QrcodeCountParams,
+    type QrcodeUpsertParams as QrcodeUpsertParams,
+  };
+
+  export {
+    Bulk as Bulk,
+    type BulkCreateResponse as BulkCreateResponse,
+    type BulkDeleteResponse as BulkDeleteResponse,
+    type BulkCreateParams as BulkCreateParams,
+    type BulkDeleteParams as BulkDeleteParams,
+  };
+}