@codeqr/ts 0.1.2

package/src/resources/qrcodes/bulk.ts

@@ -0,0 +1,908 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as QrcodesAPI from './qrcodes';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+
+export class Bulk extends APIResource {
+  /**
+   * Bulk create up to 100 QR Codes for the authenticated workspace.
+   *
+   * @example
+   * ```ts
+   * const bulks = await client.qrcodes.bulk.create();
+   * ```
+   */
+  create(
+    params: BulkCreateParams | null | undefined = undefined,
+    options?: RequestOptions,
+  ): APIPromise<BulkCreateResponse> {
+    const { body } = params ?? {};
+    return this._client.post('/qrcodes/bulk', { body: body, ...options });
+  }
+
+  /**
+   * Bulk delete up to 100 QR Codes for the authenticated workspace.
+   *
+   * @example
+   * ```ts
+   * const bulk = await client.qrcodes.bulk.delete({
+   *   linkIds: ['clux0rgak00011...', 'clux0rgak00022...'],
+   * });
+   * ```
+   */
+  delete(params: BulkDeleteParams, options?: RequestOptions): APIPromise<BulkDeleteResponse> {
+    const { linkIds } = params;
+    return this._client.delete('/qrcodes/bulk', { query: { linkIds }, ...options });
+  }
+}
+
+export type BulkCreateResponse = Array<QrcodesAPI.QrCode | BulkCreateResponse.QrCodeErrorSchema>;
+
+export namespace BulkCreateResponse {
+  export interface QrCodeErrorSchema {
+    /**
+     * The error code.
+     */
+    code:
+      | 'bad_request'
+      | 'not_found'
+      | 'internal_server_error'
+      | 'unauthorized'
+      | 'forbidden'
+      | 'rate_limit_exceeded'
+      | 'invite_expired'
+      | 'invite_pending'
+      | 'exceeded_limit'
+      | 'conflict'
+      | 'unprocessable_entity';
+
+    /**
+     * The error message.
+     */
+    error: string;
+
+    /**
+     * The QR Code that caused the error.
+     */
+    qrcode?: unknown;
+  }
+}
+
+export interface BulkDeleteResponse {
+  /**
+   * The number of QR Codes deleted.
+   */
+  deletedCount: number;
+}
+
+export interface BulkCreateParams {
+  body?: Array<BulkCreateParams.Body>;
+}
+
+export namespace BulkCreateParams {
+  export interface Body {
+    /**
+     * 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?: Body.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 Body {
+    /**
+     * 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 BulkDeleteParams {
+  /**
+   * Comma-separated list of QR Code IDs to delete. Maximum of 100 IDs. Non-existing
+   * IDs will be ignored.
+   */
+  linkIds: Array<string>;
+}
+
+export declare namespace Bulk {
+  export {
+    type BulkCreateResponse as BulkCreateResponse,
+    type BulkDeleteResponse as BulkDeleteResponse,
+    type BulkCreateParams as BulkCreateParams,
+    type BulkDeleteParams as BulkDeleteParams,
+  };
+}