dub 0.4.0 → 0.6.0

package/resources/qr.mjs

@@ -1,5 +1,13 @@
 // File generated from our OpenAPI spec by Stainless.
 import { APIResource } from 'dub/resource';
 export class Qr extends APIResource {
+    /**
+     * Retrieve a QR code for a link.
+     */
+    retrieve(query, options) {
+        return this._client.get('/qr', { query, ...options, __binaryResponse: true });
+    }
 }
+(function (Qr) {
+})(Qr || (Qr = {}));
 //# sourceMappingURL=qr.mjs.map

package/resources/qr.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"qr.mjs","sourceRoot":"","sources":["../src/resources/qr.ts"],"names":[],"mappings":"AAAA,qDAAqD;OAE9C,EAAE,WAAW,EAAE,MAAM,cAAc;AAE1C,MAAM,OAAO,EAAG,SAAQ,WAAW;CAAG"}
+{"version":3,"file":"qr.mjs","sourceRoot":"","sources":["../src/resources/qr.ts"],"names":[],"mappings":"AAAA,qDAAqD;OAG9C,EAAE,WAAW,EAAE,MAAM,cAAc;AAI1C,MAAM,OAAO,EAAG,SAAQ,WAAW;IACjC;;OAEG;IACH,QAAQ,CAAC,KAAuB,EAAE,OAA6B;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,gBAAgB,EAAE,IAAI,EAAE,CAAC,CAAC;IAChF,CAAC;CACF;AAsCD,WAAiB,EAAE;AAEnB,CAAC,EAFgB,EAAE,KAAF,EAAE,QAElB"}

package/src/index.ts

@@ -7,6 +7,13 @@ import * as Uploads from './uploads';
 import * as API from "./resources/index";
 
 export interface ClientOptions {
+  /**
+   * Defaults to process.env['DUB_API_KEY'].
+   */
+  token?: string | undefined;
+
+  projectSlug?: string | null | undefined;
+
   /**
    * Override the default base URL for the API, e.g., "https://api.example.com/v2/"
    *
@@ -66,11 +73,16 @@ export interface ClientOptions {
 
 /** API Client for interfacing with the Dub API. */
 export class Dub extends Core.APIClient {
+  token: string;
+  projectSlug: string | null;
+
   private _options: ClientOptions;
 
   /**
    * API Client for interfacing with the Dub API.
    *
+   * @param {string | undefined} [opts.token=process.env['DUB_API_KEY'] ?? undefined]
+   * @param {string | null | undefined} [opts.projectSlug]
    * @param {string} [opts.baseURL=process.env['DUB_BASE_URL'] ?? https://api.dub.co] - Override the default base URL for the API.
    * @param {number} [opts.timeout=1 minute] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out.
    * @param {number} [opts.httpAgent] - An HTTP agent used to manage HTTP(s) connections.
@@ -79,8 +91,21 @@ export class Dub extends Core.APIClient {
    * @param {Core.Headers} opts.defaultHeaders - Default headers to include with every request to the API.
    * @param {Core.DefaultQuery} opts.defaultQuery - Default query parameters to include with every request to the API.
    */
-  constructor({ baseURL = Core.readEnv('DUB_BASE_URL'), ...opts }: ClientOptions = {}) {
+  constructor({
+    baseURL = Core.readEnv('DUB_BASE_URL'),
+    token = Core.readEnv('DUB_API_KEY'),
+    projectSlug = null,
+    ...opts
+  }: ClientOptions = {}) {
+    if (token === undefined) {
+      throw new Errors.DubError(
+        "The DUB_API_KEY environment variable is missing or empty; either provide it, or instantiate the Dub client with an token option, like new Dub({ token: 'My Token' }).",
+      );
+    }
+
     const options: ClientOptions = {
+      token,
+      projectSlug,
       ...opts,
       baseURL: baseURL || `https://api.dub.co`,
     };
@@ -93,6 +118,9 @@ export class Dub extends Core.APIClient {
       fetch: options.fetch,
     });
     this._options = options;
+
+    this.token = token;
+    this.projectSlug = projectSlug;
   }
 
   links: API.Links = new API.Links(this);
@@ -110,6 +138,10 @@ export class Dub extends Core.APIClient {
     };
   }
 
+  protected override authHeaders(opts: Core.FinalRequestOptions): Core.Headers {
+    return { Authorization: `Bearer ${this.token}` };
+  }
+
   static Dub = this;
 
   static DubError = Errors.DubError;
@@ -162,11 +194,13 @@ export namespace Dub {
   export import LinkDeleteLinkParams = API.LinkDeleteLinkParams;
 
   export import Qr = API.Qr;
+  export import QrRetrieveParams = API.QrRetrieveParams;
 
   export import Projects = API.Projects;
   export import Project = API.Project;
   export import ProjectDetails = API.ProjectDetails;
   export import ProjectListResponse = API.ProjectListResponse;
+  export import ProjectRetrieveParams = API.ProjectRetrieveParams;
 }
 
 export default Dub;

package/src/resources/index.ts

@@ -9,5 +9,11 @@ export {
   LinkDeleteLinkParams,
   Links,
 } from './links/links';
-export { Project, ProjectDetails, ProjectListResponse, Projects } from './projects/projects';
-export { Qr } from './qr';
+export {
+  Project,
+  ProjectDetails,
+  ProjectListResponse,
+  ProjectRetrieveParams,
+  Projects,
+} from './projects/projects';
+export { QrRetrieveParams, Qr } from './qr';

package/src/resources/links/bulk.ts

@@ -10,7 +10,7 @@ export class Bulk extends APIResource {
    * Bulk create up to 100 links for the authenticated project.
    */
   create(params: BulkCreateParams, options?: Core.RequestOptions): Core.APIPromise<BulkCreateResponse> {
-    const { projectSlug, ...body } = params;
+    const { projectSlug = this._client.projectSlug, ...body } = params;
     return this._client.post('/links/bulk', { query: { projectSlug }, body, ...options });
   }
 }
@@ -20,9 +20,9 @@ export type BulkCreateResponse = Array<LinksAPI.Link>;
 export interface BulkCreateParams {
   /**
    * Query param: The slug for the project to create links for. E.g. for
-   * app.dub.co/acme, the projectSlug is 'acme'.
+   * `app.dub.co/acme`, the projectSlug is `acme`.
    */
-  projectSlug: string;
+  projectSlug?: string;
 }
 
 export namespace BulkCreateParams {
@@ -43,13 +43,14 @@ export namespace BulkCreateParams {
     comments?: string | null;
 
     /**
-     * The description of the short link generated via api.dub.co/metatags. Will be
+     * The description of the short link generated via `api.dub.co/metatags`. Will be
      * used for Custom Social Media Cards if `proxy` is true.
      */
     description?: string | null;
 
     /**
-     * The domain of the short link.
+     * The domain of the short link. If not provided, the primary domain for the
+     * project will be used (or `dub.sh` if the project has no domains).
      */
     domain?: string;
 
@@ -61,13 +62,13 @@ export namespace BulkCreateParams {
 
     /**
      * Geo targeting information for the short link in JSON format {[COUNTRY]:
-     * "https://example.com" }. Learn more: https://dub.sh/geo
+     * `https://example.com` }. Learn more: `https://dub.sh/geo`
      */
     geo?: Record<string, string> | null;
 
     /**
-     * The image of the short link generated via api.dub.co/metatags. Will be used for
-     * Custom Social Media Cards if `proxy` is true.
+     * The image of the short link generated via `api.dub.co/metatags`. Will be used
+     * for Custom Social Media Cards if `proxy` is true.
      */
     image?: string | null;
 
@@ -108,8 +109,8 @@ export namespace BulkCreateParams {
     tagId?: string | null;
 
     /**
-     * The title of the short link generated via api.dub.co/metatags. Will be used for
-     * Custom Social Media Cards if `proxy` is true.
+     * The title of the short link generated via `api.dub.co/metatags`. Will be used
+     * for Custom Social Media Cards if `proxy` is true.
      */
     title?: string | null;
 

package/src/resources/links/info.ts

@@ -9,28 +9,29 @@ export class Info extends APIResource {
   /**
    * Retrieve the info for a link from their domain and key.
    */
-  retrieve(query: InfoRetrieveParams, options?: Core.RequestOptions): Core.APIPromise<LinksAPI.Link> {
-    return this._client.get('/links/info', { query, ...options });
+  retrieve(params: InfoRetrieveParams, options?: Core.RequestOptions): Core.APIPromise<LinksAPI.Link> {
+    const { projectSlug = this._client.projectSlug, ...query } = params;
+    return this._client.get('/links/info', { query: { projectSlug, ...query }, ...options });
   }
 }
 
 export interface InfoRetrieveParams {
   /**
-   * The domain of the link to retrieve. E.g. for dub.sh/github, the domain is
-   * 'dub.sh'.
+   * The domain of the link to retrieve. E.g. for `dub.sh/github`, the domain is
+   * `dub.sh`.
    */
   domain: string;
 
   /**
-   * The key of the link to retrieve. E.g. for dub.sh/github, the key is 'github'.
+   * The key of the link to retrieve. E.g. for `dub.sh/github`, the key is `github`.
    */
   key: string;
 
   /**
-   * The slug for the project that the link belongs to. E.g. for app.dub.co/acme, the
-   * projectSlug is 'acme'.
+   * The slug for the project that the link belongs to. E.g. for `app.dub.co/acme`,
+   * the projectSlug is `acme`.
    */
-  projectSlug: string;
+  projectSlug?: string;
 }
 
 export namespace Info {

package/src/resources/links/links.ts

@@ -14,7 +14,7 @@ export class Links extends APIResource {
    * Create a new link for the authenticated project.
    */
   create(params: LinkCreateParams, options?: Core.RequestOptions): Core.APIPromise<Link> {
-    const { projectSlug, ...body } = params;
+    const { projectSlug = this._client.projectSlug, ...body } = params;
     return this._client.post('/links', { query: { projectSlug }, body, ...options });
   }
 
@@ -22,7 +22,7 @@ export class Links extends APIResource {
    * Edit a link for the authenticated project.
    */
   update(linkId: string, params: LinkUpdateParams, options?: Core.RequestOptions): Core.APIPromise<Link> {
-    const { projectSlug, ...body } = params;
+    const { projectSlug = this._client.projectSlug, ...body } = params;
     return this._client.put(`/links/${linkId}`, { query: { projectSlug }, body, ...options });
   }
 
@@ -30,8 +30,9 @@ export class Links extends APIResource {
    * Retrieve a list of links for the authenticated project. The list will be
    * paginated and the provided query parameters allow filtering the returned links.
    */
-  list(query: LinkListParams, options?: Core.RequestOptions): Core.APIPromise<LinkListResponse> {
-    return this._client.get('/links', { query, ...options });
+  list(params: LinkListParams, options?: Core.RequestOptions): Core.APIPromise<LinkListResponse> {
+    const { projectSlug = this._client.projectSlug, ...query } = params;
+    return this._client.get('/links', { query: { projectSlug, ...query }, ...options });
   }
 
   /**
@@ -42,7 +43,7 @@ export class Links extends APIResource {
     params: LinkDeleteLinkParams,
     options?: Core.RequestOptions,
   ): Core.APIPromise<Link> {
-    const { projectSlug } = params;
+    const { projectSlug = this._client.projectSlug } = params;
     return this._client.delete(`/links/${linkId}`, { query: { projectSlug }, ...options });
   }
 }
@@ -79,13 +80,14 @@ export interface Link {
   createdAt?: string;
 
   /**
-   * The description of the short link generated via api.dub.co/metatags. Will be
+   * The description of the short link generated via `api.dub.co/metatags`. Will be
    * used for Custom Social Media Cards if `proxy` is true.
    */
   description?: string | null;
 
   /**
-   * The domain of the short link.
+   * The domain of the short link. If not provided, the primary domain for the
+   * project will be used (or `dub.sh` if the project has no domains).
    */
   domain?: string;
 
@@ -97,13 +99,13 @@ export interface Link {
 
   /**
    * Geo targeting information for the short link in JSON format {[COUNTRY]:
-   * "https://example.com" }. Learn more: https://dub.sh/geo
+   * `https://example.com` }. Learn more: `https://dub.sh/geo`
    */
   geo?: Record<string, string> | null;
 
   /**
-   * The image of the short link generated via api.dub.co/metatags. Will be used for
-   * Custom Social Media Cards if `proxy` is true.
+   * The image of the short link generated via `api.dub.co/metatags`. Will be used
+   * for Custom Social Media Cards if `proxy` is true.
    */
   image?: string | null;
 
@@ -143,19 +145,31 @@ export interface Link {
    */
   publicStats?: boolean;
 
+  /**
+   * The full URL of the QR code for the short link (e.g.
+   * `https://api.dub.co/qr?url=https://dub.sh/try`).
+   */
+  qrCode?: string;
+
   /**
    * Whether the short link uses link cloaking.
    */
   rewrite?: boolean;
 
+  /**
+   * The full URL of the short link, including the https protocol (e.g.
+   * `https://dub.sh/try`).
+   */
+  shortLink?: string;
+
   /**
    * The unique id of the tag assigned to the short link.
    */
   tagId?: string | null;
 
   /**
-   * The title of the short link generated via api.dub.co/metatags. Will be used for
-   * Custom Social Media Cards if `proxy` is true.
+   * The title of the short link generated via `api.dub.co/metatags`. Will be used
+   * for Custom Social Media Cards if `proxy` is true.
    */
   title?: string | null;
 
@@ -205,14 +219,9 @@ export type LinkListResponse = Array<Link>;
 export interface LinkCreateParams {
   /**
    * Query param: The slug for the project to create links for. E.g. for
-   * app.dub.co/acme, the projectSlug is 'acme'.
+   * `app.dub.co/acme`, the projectSlug is `acme`.
    */
-  projectSlug: string;
-
-  /**
-   * Body param: The domain of the short link.
-   */
-  domain: string;
+  projectSlug?: string;
 
   /**
    * Body param: The destination URL of the short link.
@@ -236,11 +245,18 @@ export interface LinkCreateParams {
   comments?: string | null;
 
   /**
-   * Body param: The description of the short link generated via api.dub.co/metatags.
-   * Will be used for Custom Social Media Cards if `proxy` is true.
+   * Body param: The description of the short link generated via
+   * `api.dub.co/metatags`. Will be used for Custom Social Media Cards if `proxy` is
+   * true.
    */
   description?: string | null;
 
+  /**
+   * Body param: The domain of the short link. If not provided, the primary domain
+   * for the project will be used (or `dub.sh` if the project has no domains).
+   */
+  domain?: string;
+
   /**
    * Body param: The date and time when the short link will expire in ISO-8601
    * format. Must be in the future.
@@ -249,13 +265,13 @@ export interface LinkCreateParams {
 
   /**
    * Body param: Geo targeting information for the short link in JSON format
-   * {[COUNTRY]: "https://example.com" }. Learn more: https://dub.sh/geo
+   * {[COUNTRY]: `https://example.com` }. Learn more: `https://dub.sh/geo`
    */
   geo?: Record<string, string> | null;
 
   /**
-   * Body param: The image of the short link generated via api.dub.co/metatags. Will
-   * be used for Custom Social Media Cards if `proxy` is true.
+   * Body param: The image of the short link generated via `api.dub.co/metatags`.
+   * Will be used for Custom Social Media Cards if `proxy` is true.
    */
   image?: string | null;
 
@@ -297,8 +313,8 @@ export interface LinkCreateParams {
   tagId?: string | null;
 
   /**
-   * Body param: The title of the short link generated via api.dub.co/metatags. Will
-   * be used for Custom Social Media Cards if `proxy` is true.
+   * Body param: The title of the short link generated via `api.dub.co/metatags`.
+   * Will be used for Custom Social Media Cards if `proxy` is true.
    */
   title?: string | null;
 }
@@ -306,9 +322,9 @@ export interface LinkCreateParams {
 export interface LinkUpdateParams {
   /**
    * Query param: The slug for the project that the link belongs to. E.g. for
-   * app.dub.co/acme, the projectSlug is 'acme'.
+   * `app.dub.co/acme`, the projectSlug is `acme`.
    */
-  projectSlug: string;
+  projectSlug?: string;
 
   /**
    * Body param: The Android destination URL for the short link for Android device
@@ -327,13 +343,15 @@ export interface LinkUpdateParams {
   comments?: string | null;
 
   /**
-   * Body param: The description of the short link generated via api.dub.co/metatags.
-   * Will be used for Custom Social Media Cards if `proxy` is true.
+   * Body param: The description of the short link generated via
+   * `api.dub.co/metatags`. Will be used for Custom Social Media Cards if `proxy` is
+   * true.
    */
   description?: string | null;
 
   /**
-   * Body param: The domain of the short link.
+   * Body param: The domain of the short link. If not provided, the primary domain
+   * for the project will be used (or `dub.sh` if the project has no domains).
    */
   domain?: string;
 
@@ -345,13 +363,13 @@ export interface LinkUpdateParams {
 
   /**
    * Body param: Geo targeting information for the short link in JSON format
-   * {[COUNTRY]: "https://example.com" }. Learn more: https://dub.sh/geo
+   * {[COUNTRY]: `https://example.com` }. Learn more: `https://dub.sh/geo`
    */
   geo?: Record<string, string> | null;
 
   /**
-   * Body param: The image of the short link generated via api.dub.co/metatags. Will
-   * be used for Custom Social Media Cards if `proxy` is true.
+   * Body param: The image of the short link generated via `api.dub.co/metatags`.
+   * Will be used for Custom Social Media Cards if `proxy` is true.
    */
   image?: string | null;
 
@@ -393,8 +411,8 @@ export interface LinkUpdateParams {
   tagId?: string | null;
 
   /**
-   * Body param: The title of the short link generated via api.dub.co/metatags. Will
-   * be used for Custom Social Media Cards if `proxy` is true.
+   * Body param: The title of the short link generated via `api.dub.co/metatags`.
+   * Will be used for Custom Social Media Cards if `proxy` is true.
    */
   title?: string | null;
 
@@ -406,13 +424,13 @@ export interface LinkUpdateParams {
 
 export interface LinkListParams {
   /**
-   * The slug for the project to retrieve links for. E.g. for app.dub.co/acme, the
-   * projectSlug is 'acme'.
+   * The slug for the project to retrieve links for. E.g. for `app.dub.co/acme`, the
+   * projectSlug is `acme`.
    */
-  projectSlug: string;
+  projectSlug?: string;
 
   /**
-   * The domain to filter the links by. E.g. 'ac.me'. If not provided, all links for
+   * The domain to filter the links by. E.g. `ac.me`. If not provided, all links for
    * the project will be returned.
    */
   domain?: string;
@@ -429,13 +447,13 @@ export interface LinkListParams {
   search?: string;
 
   /**
-   * Whether to include archived links in the response. Defaults to false if not
+   * Whether to include archived links in the response. Defaults to `false` if not
    * provided.
    */
   showArchived?: true | false;
 
   /**
-   * The field to sort the links by. The default is 'createdAt', and sort order is
+   * The field to sort the links by. The default is `createdAt`, and sort order is
    * always descending.
    */
   sort?: 'createdAt' | 'clicks' | 'lastClicked';
@@ -453,10 +471,10 @@ export interface LinkListParams {
 
 export interface LinkDeleteLinkParams {
   /**
-   * The slug for the project that the link belongs to. E.g. for app.dub.co/acme, the
-   * projectSlug is 'acme'.
+   * The slug for the project that the link belongs to. E.g. for `app.dub.co/acme`,
+   * the projectSlug is `acme`.
    */
-  projectSlug: string;
+  projectSlug?: string;
 }
 
 export namespace Links {

package/src/resources/projects/index.ts

@@ -1,4 +1,4 @@
 // File generated from our OpenAPI spec by Stainless.
 
-export { Project, ProjectDetails, ProjectListResponse, Projects } from './projects';
-export { Tag, TagListResponse, TagCreateParams, Tags } from './tags';
+export { Project, ProjectDetails, ProjectListResponse, ProjectRetrieveParams, Projects } from './projects';
+export { Tag, TagListResponse, TagCreateParams, TagListParams, Tags } from './tags';

package/src/resources/projects/projects.ts

@@ -11,7 +11,8 @@ export class Projects extends APIResource {
   /**
    * Retrieve a project for the authenticated user.
    */
-  retrieve(projectSlug: string, options?: Core.RequestOptions): Core.APIPromise<ProjectDetails> {
+  retrieve(params: ProjectRetrieveParams, options?: Core.RequestOptions): Core.APIPromise<ProjectDetails> {
+    const { projectSlug = this._client.projectSlug } = params;
     return this._client.get(`/projects/${projectSlug}`, options);
   }
 
@@ -111,12 +112,22 @@ export namespace ProjectDetails {
 
 export type ProjectListResponse = Array<Project>;
 
+export interface ProjectRetrieveParams {
+  /**
+   * The slug for the project to retrieve. E.g. for `app.dub.co/acme`, the
+   * projectSlug is `acme`.
+   */
+  projectSlug?: string;
+}
+
 export namespace Projects {
   export import Project = ProjectsAPI.Project;
   export import ProjectDetails = ProjectsAPI.ProjectDetails;
   export import ProjectListResponse = ProjectsAPI.ProjectListResponse;
+  export import ProjectRetrieveParams = ProjectsAPI.ProjectRetrieveParams;
   export import Tags = TagsAPI.Tags;
   export import Tag = TagsAPI.Tag;
   export import TagListResponse = TagsAPI.TagListResponse;
   export import TagCreateParams = TagsAPI.TagCreateParams;
+  export import TagListParams = TagsAPI.TagListParams;
 }

package/src/resources/projects/tags.ts

@@ -8,14 +8,16 @@ export class Tags extends APIResource {
   /**
    * Create a new tag for the authenticated project.
    */
-  create(projectSlug: string, body: TagCreateParams, options?: Core.RequestOptions): Core.APIPromise<Tag> {
+  create(params: TagCreateParams, options?: Core.RequestOptions): Core.APIPromise<Tag> {
+    const { projectSlug = this._client.projectSlug, ...body } = params;
     return this._client.post(`/projects/${projectSlug}/tags`, { body, ...options });
   }
 
   /**
    * Retrieve a list of tags for the authenticated project.
    */
-  list(projectSlug: string, options?: Core.RequestOptions): Core.APIPromise<TagListResponse> {
+  list(params: TagListParams, options?: Core.RequestOptions): Core.APIPromise<TagListResponse> {
+    const { projectSlug = this._client.projectSlug } = params;
     return this._client.get(`/projects/${projectSlug}/tags`, options);
   }
 }
@@ -41,13 +43,28 @@ export type TagListResponse = Array<Tag>;
 
 export interface TagCreateParams {
   /**
-   * The name of the tag to create.
+   * Path param: The slug for the project to create tags for. E.g. for
+   * `app.dub.co/acme`, the projectSlug is `acme`.
+   */
+  projectSlug?: string;
+
+  /**
+   * Body param: The name of the tag to create.
    */
   tag?: string;
 }
 
+export interface TagListParams {
+  /**
+   * The slug for the project to retrieve tags for. E.g. for `app.dub.co/acme`, the
+   * projectSlug is `acme`.
+   */
+  projectSlug?: string;
+}
+
 export namespace Tags {
   export import Tag = TagsAPI.Tag;
   export import TagListResponse = TagsAPI.TagListResponse;
   export import TagCreateParams = TagsAPI.TagCreateParams;
+  export import TagListParams = TagsAPI.TagListParams;
 }

package/src/resources/qr.ts

@@ -1,5 +1,55 @@
 // File generated from our OpenAPI spec by Stainless.
 
+import * as Core from "../core";
 import { APIResource } from "../resource";
+import { type Response } from "../_shims/index";
+import * as QrAPI from "./qr";
 
-export class Qr extends APIResource {}
+export class Qr extends APIResource {
+  /**
+   * Retrieve a QR code for a link.
+   */
+  retrieve(query: QrRetrieveParams, options?: Core.RequestOptions): Core.APIPromise<Response> {
+    return this._client.get('/qr', { query, ...options, __binaryResponse: true });
+  }
+}
+
+export interface QrRetrieveParams {
+  /**
+   * The URL to generate a QR code for. Defaults to `https://dub.co` if not provided.
+   */
+  url: string;
+
+  /**
+   * The background color of the QR code in hex format. Defaults to `#ffffff` if not
+   * provided.
+   */
+  bgColor?: string;
+
+  /**
+   * The foreground color of the QR code in hex format. Defaults to `#000000` if not
+   * provided.
+   */
+  fgColor?: string;
+
+  /**
+   * Whether to include a margin around the QR code. Defaults to `false` if not
+   * provided.
+   */
+  includeMargin?: true | false;
+
+  /**
+   * The level of error correction to use for the QR code. Defaults to `L` if not
+   * provided.
+   */
+  level?: 'L' | 'M' | 'Q' | 'H';
+
+  /**
+   * The size of the QR code in pixels. Defaults to `600` if not provided.
+   */
+  size?: number;
+}
+
+export namespace Qr {
+  export import QrRetrieveParams = QrAPI.QrRetrieveParams;
+}

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.4.0'; // x-release-please-version
+export const VERSION = '0.6.0'; // x-release-please-version

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.4.0";
+export declare const VERSION = "0.6.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.4.0'; // x-release-please-version
+exports.VERSION = '0.6.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '0.4.0'; // x-release-please-version
+export const VERSION = '0.6.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map