@codeqr/ts 0.1.2

package/src/resources/qrcodes.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './qrcodes/index';

package/src/resources/tags.ts

@@ -0,0 +1,128 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+export class Tags extends APIResource {
+  /**
+   * Create a new tag for the authenticated project.
+   */
+  create(body: TagCreateParams, options?: RequestOptions): APIPromise<Tag> {
+    return this._client.post('/tags', { body, ...options });
+  }
+
+  /**
+   * Update a tag in the workspace.
+   */
+  update(id: string, body: TagUpdateParams, options?: RequestOptions): APIPromise<Tag> {
+    return this._client.put(path`/tags/${id}`, { body, ...options });
+  }
+
+  /**
+   * Retrieve a list of tags for the authenticated workspace.
+   */
+  list(query: TagListParams | null | undefined = {}, options?: RequestOptions): APIPromise<TagListResponse> {
+    return this._client.get('/tags', { query, ...options });
+  }
+
+  /**
+   * Delete a tag from the workspace. All existing links will still work, but they
+   * will no longer be associated with this tag.
+   */
+  delete(id: string, options?: RequestOptions): APIPromise<TagDeleteResponse> {
+    return this._client.delete(path`/tags/${id}`, options);
+  }
+}
+
+export interface Tag {
+  /**
+   * The unique ID of the tag.
+   */
+  id: string;
+
+  /**
+   * The color of the tag.
+   */
+  color: 'red' | 'yellow' | 'green' | 'blue' | 'purple' | 'pink' | 'brown';
+
+  /**
+   * The name of the tag.
+   */
+  name: string;
+}
+
+export type TagListResponse = Array<Tag>;
+
+export interface TagDeleteResponse {
+  /**
+   * The ID of the deleted tag.
+   */
+  id: string;
+}
+
+export interface TagCreateParams {
+  /**
+   * The name of the tag to create.
+   */
+  tag: string;
+
+  /**
+   * The color of the tag. If not provided, a random color will be used from the
+   * list: red, yellow, green, blue, purple, pink, brown.
+   */
+  color?: 'red' | 'yellow' | 'green' | 'blue' | 'purple' | 'pink' | 'brown';
+}
+
+export interface TagUpdateParams {
+  name: string;
+
+  /**
+   * The color of the tag
+   */
+  color?: 'red' | 'yellow' | 'green' | 'blue' | 'purple' | 'pink' | 'brown';
+}
+
+export interface TagListParams {
+  /**
+   * IDs of tags to filter by.
+   */
+  ids?: string | Array<string>;
+
+  /**
+   * The page number for pagination.
+   */
+  page?: number;
+
+  /**
+   * The number of items per page.
+   */
+  pageSize?: number;
+
+  /**
+   * The search term to filter the tags by.
+   */
+  search?: string;
+
+  /**
+   * The field to sort the tags by.
+   */
+  sortBy?: 'name' | 'createdAt';
+
+  /**
+   * The order to sort the tags by.
+   */
+  sortOrder?: 'asc' | 'desc';
+}
+
+export declare namespace Tags {
+  export {
+    type Tag as Tag,
+    type TagListResponse as TagListResponse,
+    type TagDeleteResponse as TagDeleteResponse,
+    type TagCreateParams as TagCreateParams,
+    type TagUpdateParams as TagUpdateParams,
+    type TagListParams as TagListParams,
+  };
+}

package/src/resources/track.ts

@@ -0,0 +1,163 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+
+export class Track extends APIResource {
+  /**
+   * Track a lead for a short link.
+   *
+   * @example
+   * ```ts
+   * const response = await client.track.trackLead({
+   *   clickId: 'x',
+   *   customerId: 'x',
+   *   eventName: 'Sign up',
+   * });
+   * ```
+   */
+  trackLead(body: TrackTrackLeadParams, options?: RequestOptions): APIPromise<TrackTrackLeadResponse> {
+    return this._client.post('/track/lead', { body, ...options });
+  }
+
+  /**
+   * Track a sale for a short link.
+   *
+   * @example
+   * ```ts
+   * const response = await client.track.trackSale({
+   *   amount: 1,
+   *   customerId: 'x',
+   *   paymentProcessor: 'stripe',
+   * });
+   * ```
+   */
+  trackSale(body: TrackTrackSaleParams, options?: RequestOptions): APIPromise<TrackTrackSaleResponse> {
+    return this._client.post('/track/sale', { body, ...options });
+  }
+}
+
+export interface TrackTrackLeadResponse {
+  click: TrackTrackLeadResponse.Click;
+
+  customer: TrackTrackLeadResponse.Customer;
+}
+
+export namespace TrackTrackLeadResponse {
+  export interface Click {
+    id: string;
+  }
+
+  export interface Customer {
+    id: string;
+
+    avatar?: string | null;
+
+    email?: string | null;
+
+    name?: string | null;
+  }
+}
+
+export interface TrackTrackSaleResponse {
+  amount: number;
+
+  currency: string;
+
+  customerId: string;
+
+  eventName: string;
+
+  invoiceId: string | null;
+
+  metadata: { [key: string]: unknown } | null;
+
+  paymentProcessor: string;
+}
+
+export interface TrackTrackLeadParams {
+  /**
+   * The ID of the click in th CodeQR. You can read this value from `cq_id` cookie.
+   */
+  clickId: string;
+
+  /**
+   * This is the unique identifier for the customer in the client's app. This is used
+   * to track the customer's journey.
+   */
+  customerId: string;
+
+  /**
+   * The name of the event to track.
+   */
+  eventName: string;
+
+  /**
+   * Avatar of the customer in the client's app.
+   */
+  customerAvatar?: string | null;
+
+  /**
+   * Email of the customer in the client's app.
+   */
+  customerEmail?: string | null;
+
+  /**
+   * Name of the customer in the client's app.
+   */
+  customerName?: string | null;
+
+  /**
+   * Additional metadata to be stored with the lead event
+   */
+  metadata?: { [key: string]: unknown } | null;
+}
+
+export interface TrackTrackSaleParams {
+  /**
+   * The amount of the sale. Should be passed in cents.
+   */
+  amount: number;
+
+  /**
+   * This is the unique identifier for the customer in the client's app. This is used
+   * to track the customer's journey.
+   */
+  customerId: string;
+
+  /**
+   * The payment processor via which the sale was made.
+   */
+  paymentProcessor: 'stripe' | 'shopify' | 'paddle';
+
+  /**
+   * The currency of the sale. Accepts ISO 4217 currency codes.
+   */
+  currency?: string;
+
+  /**
+   * The name of the sale event. It can be used to track different types of event for
+   * example 'Purchase', 'Upgrade', 'Payment', etc.
+   */
+  eventName?: string;
+
+  /**
+   * The invoice ID of the sale.
+   */
+  invoiceId?: string | null;
+
+  /**
+   * Additional metadata to be stored with the sale event.
+   */
+  metadata?: { [key: string]: unknown } | null;
+}
+
+export declare namespace Track {
+  export {
+    type TrackTrackLeadResponse as TrackTrackLeadResponse,
+    type TrackTrackSaleResponse as TrackTrackSaleResponse,
+    type TrackTrackLeadParams as TrackTrackLeadParams,
+    type TrackTrackSaleParams as TrackTrackSaleParams,
+  };
+}

package/src/resources.ts

@@ -0,0 +1 @@
+export * from './resources/index';

package/src/tsconfig.json

@@ -0,0 +1,11 @@
+{
+  // this config is included in the published src directory to prevent TS errors
+  // from appearing when users go to source, and VSCode opens the source .ts file
+  // via declaration maps
+  "include": ["index.ts"],
+  "compilerOptions": {
+    "target": "ES2015",
+    "lib": ["DOM", "DOM.Iterable", "ES2018"],
+    "moduleResolution": "node"
+  }
+}

package/src/uploads.ts

@@ -0,0 +1,2 @@
+/** @deprecated Import from ./core/uploads instead */
+export * from './core/uploads';

package/src/version.ts

@@ -0,0 +1 @@
+export const VERSION = '0.1.2'; // x-release-please-version

package/uploads.d.mts

@@ -0,0 +1,2 @@
+export * from "./core/uploads.mjs";
+//# sourceMappingURL=uploads.d.mts.map

package/uploads.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"uploads.d.mts","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":""}

package/uploads.d.ts

@@ -0,0 +1,2 @@
+export * from "./core/uploads.js";
+//# sourceMappingURL=uploads.d.ts.map

package/uploads.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"uploads.d.ts","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":""}

package/uploads.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("./internal/tslib.js");
+/** @deprecated Import from ./core/uploads instead */
+tslib_1.__exportStar(require("./core/uploads.js"), exports);
+//# sourceMappingURL=uploads.js.map

package/uploads.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"uploads.js","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":";;;AAAA,qDAAqD;AACrD,4DAA+B"}

package/uploads.mjs

@@ -0,0 +1,2 @@
+export * from "./core/uploads.mjs";
+//# sourceMappingURL=uploads.mjs.map

package/uploads.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"uploads.mjs","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":""}

package/version.d.mts

@@ -0,0 +1,2 @@
+export declare const VERSION = "0.1.2";
+//# sourceMappingURL=version.d.mts.map

package/version.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.d.mts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,UAAU,CAAC"}

package/version.d.ts

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

package/version.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,UAAU,CAAC"}

package/version.js

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

package/version.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.js","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":";;;AAAa,QAAA,OAAO,GAAG,OAAO,CAAC,CAAC,2BAA2B"}

package/version.mjs

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

package/version.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.mjs","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,OAAO,GAAG,OAAO,CAAC,CAAC,2BAA2B"}