@codeqr/ts 0.1.2

package/resources/track.d.mts

@@ -0,0 +1,128 @@
+import { APIResource } from "../core/resource.mjs";
+import { APIPromise } from "../core/api-promise.mjs";
+import { RequestOptions } from "../internal/request-options.mjs";
+export declare 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>;
+    /**
+     * 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>;
+}
+export interface TrackTrackLeadResponse {
+    click: TrackTrackLeadResponse.Click;
+    customer: TrackTrackLeadResponse.Customer;
+}
+export declare namespace TrackTrackLeadResponse {
+    interface Click {
+        id: string;
+    }
+    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, };
+}
+//# sourceMappingURL=track.d.mts.map

package/resources/track.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"track.d.mts","sourceRoot":"","sources":["../src/resources/track.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;;OAWG;IACH,SAAS,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;IAInG;;;;;;;;;;;OAWG;IACH,SAAS,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;CAGpG;AAED,MAAM,WAAW,sBAAsB;IACrC,KAAK,EAAE,sBAAsB,CAAC,KAAK,CAAC;IAEpC,QAAQ,EAAE,sBAAsB,CAAC,QAAQ,CAAC;CAC3C;AAED,yBAAiB,sBAAsB,CAAC;IACtC,UAAiB,KAAK;QACpB,EAAE,EAAE,MAAM,CAAC;KACZ;IAED,UAAiB,QAAQ;QACvB,EAAE,EAAE,MAAM,CAAC;QAEX,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACtB;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC,MAAM,EAAE,MAAM,CAAC;IAEf,QAAQ,EAAE,MAAM,CAAC;IAEjB,UAAU,EAAE,MAAM,CAAC;IAEnB,SAAS,EAAE,MAAM,CAAC;IAElB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAE5C,gBAAgB,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;CAC9C;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,gBAAgB,EAAE,QAAQ,GAAG,SAAS,GAAG,QAAQ,CAAC;IAElD;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;CAC9C;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}

package/resources/track.d.ts

@@ -0,0 +1,128 @@
+import { APIResource } from "../core/resource.js";
+import { APIPromise } from "../core/api-promise.js";
+import { RequestOptions } from "../internal/request-options.js";
+export declare 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>;
+    /**
+     * 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>;
+}
+export interface TrackTrackLeadResponse {
+    click: TrackTrackLeadResponse.Click;
+    customer: TrackTrackLeadResponse.Customer;
+}
+export declare namespace TrackTrackLeadResponse {
+    interface Click {
+        id: string;
+    }
+    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, };
+}
+//# sourceMappingURL=track.d.ts.map

package/resources/track.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"track.d.ts","sourceRoot":"","sources":["../src/resources/track.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;;OAWG;IACH,SAAS,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;IAInG;;;;;;;;;;;OAWG;IACH,SAAS,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;CAGpG;AAED,MAAM,WAAW,sBAAsB;IACrC,KAAK,EAAE,sBAAsB,CAAC,KAAK,CAAC;IAEpC,QAAQ,EAAE,sBAAsB,CAAC,QAAQ,CAAC;CAC3C;AAED,yBAAiB,sBAAsB,CAAC;IACtC,UAAiB,KAAK;QACpB,EAAE,EAAE,MAAM,CAAC;KACZ;IAED,UAAiB,QAAQ;QACvB,EAAE,EAAE,MAAM,CAAC;QAEX,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACtB;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC,MAAM,EAAE,MAAM,CAAC;IAEf,QAAQ,EAAE,MAAM,CAAC;IAEjB,UAAU,EAAE,MAAM,CAAC;IAEnB,SAAS,EAAE,MAAM,CAAC;IAElB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAE5C,gBAAgB,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;CAC9C;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,gBAAgB,EAAE,QAAQ,GAAG,SAAS,GAAG,QAAQ,CAAC;IAElD;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;CAC9C;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}

package/resources/track.js

@@ -0,0 +1,39 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Track = void 0;
+const resource_1 = require("../core/resource.js");
+class Track extends resource_1.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, options) {
+        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, options) {
+        return this._client.post('/track/sale', { body, ...options });
+    }
+}
+exports.Track = Track;
+//# sourceMappingURL=track.js.map

package/resources/track.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"track.js","sourceRoot":"","sources":["../src/resources/track.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C,MAAa,KAAM,SAAQ,sBAAW;IACpC;;;;;;;;;;;OAWG;IACH,SAAS,CAAC,IAA0B,EAAE,OAAwB;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;;;;;;OAWG;IACH,SAAS,CAAC,IAA0B,EAAE,OAAwB;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChE,CAAC;CACF;AAhCD,sBAgCC"}

package/resources/track.mjs

@@ -0,0 +1,35 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../core/resource.mjs";
+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, options) {
+        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, options) {
+        return this._client.post('/track/sale', { body, ...options });
+    }
+}
+//# sourceMappingURL=track.mjs.map

package/resources/track.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"track.mjs","sourceRoot":"","sources":["../src/resources/track.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAItB,MAAM,OAAO,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;;OAWG;IACH,SAAS,CAAC,IAA0B,EAAE,OAAwB;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;;;;;;OAWG;IACH,SAAS,CAAC,IAA0B,EAAE,OAAwB;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChE,CAAC;CACF"}

package/resources.d.mts

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

package/resources.d.mts.map

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

package/resources.d.ts

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

package/resources.d.ts.map

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

package/resources.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("./internal/tslib.js");
+tslib_1.__exportStar(require("./resources/index.js"), exports);
+//# sourceMappingURL=resources.js.map

package/resources.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resources.js","sourceRoot":"","sources":["src/resources.ts"],"names":[],"mappings":";;;AAAA,+DAAkC"}

package/resources.mjs

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

package/resources.mjs.map

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

package/src/api-promise.ts

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