postgrid-node 0.5.0 → 0.6.1

package/resources/print-mail/trackers.d.mts

@@ -0,0 +1,409 @@
+import { APIResource } from "../../core/resource.mjs";
+import { APIPromise } from "../../core/api-promise.mjs";
+import { PagePromise, SkipLimit, type SkipLimitParams } from "../../core/pagination.mjs";
+import { RequestOptions } from "../../internal/request-options.mjs";
+/**
+ *  Create and manage Trackers.
+ *
+ *  Trackers can be used to track interactions in your orders through
+ *  personalized URLs and QR codes.
+ *
+ *  As a brief introduction to using Trackers in your orders, a QR code can be
+ *  generated by using the Tracker's ID as a merge variable in your orders HTML
+ *  and Templates. The following example HTML uses Trackers to generate
+ *  personalized URLs (PURLs) in your orders.
+ *
+ *  See the following guide for more details: https://postgrid.readme.io/reference/trackers-1
+ */
+export declare class Trackers extends APIResource {
+    /**
+     * Create a Tracker.
+     *
+     * @example
+     * ```ts
+     * const tracker = await client.printMail.trackers.create({
+     *   redirectURLTemplate:
+     *     'https://postgrid.com?name={{to.firstName}}',
+     *   urlExpireAfterDays: 30,
+     * });
+     * ```
+     */
+    create(body: TrackerCreateParams, options?: RequestOptions): APIPromise<TrackerCreateResponse>;
+    /**
+     * Retrieve a Tracker by ID.
+     *
+     * @example
+     * ```ts
+     * const tracker = await client.printMail.trackers.retrieve(
+     *   'id',
+     * );
+     * ```
+     */
+    retrieve(id: string, options?: RequestOptions): APIPromise<TrackerRetrieveResponse>;
+    /**
+     * Update a Tracker by ID.
+     *
+     * @example
+     * ```ts
+     * const tracker = await client.printMail.trackers.update(
+     *   'id',
+     *   {
+     *     redirectURLTemplate:
+     *       'https://postgrid.com?firstName={{to.firstName}}',
+     *     urlExpireAfterDays: 90,
+     *   },
+     * );
+     * ```
+     */
+    update(id: string, body: TrackerUpdateParams, options?: RequestOptions): APIPromise<TrackerUpdateResponse>;
+    /**
+     * Retrieve a paginated list of Trackers.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const trackerListResponse of client.printMail.trackers.list()) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(query?: TrackerListParams | null | undefined, options?: RequestOptions): PagePromise<TrackerListResponsesSkipLimit, TrackerListResponse>;
+    /**
+     * Delete a Tracker by ID. Note that this operation cannot be undone.
+     *
+     * @example
+     * ```ts
+     * const tracker = await client.printMail.trackers.delete(
+     *   'id',
+     * );
+     * ```
+     */
+    delete(id: string, options?: RequestOptions): APIPromise<TrackerDeleteResponse>;
+    /**
+     * Retrieve a paginated list of visits for a Tracker.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const trackerRetrieveVisitsResponse of client.printMail.trackers.retrieveVisits(
+     *   'id',
+     * )) {
+     *   // ...
+     * }
+     * ```
+     */
+    retrieveVisits(id: string, query?: TrackerRetrieveVisitsParams | null | undefined, options?: RequestOptions): PagePromise<TrackerRetrieveVisitsResponsesSkipLimit, TrackerRetrieveVisitsResponse>;
+}
+export type TrackerListResponsesSkipLimit = SkipLimit<TrackerListResponse>;
+export type TrackerRetrieveVisitsResponsesSkipLimit = SkipLimit<TrackerRetrieveVisitsResponse>;
+export interface TrackerCreateResponse {
+    /**
+     * A unique ID prefixed with tracker\_
+     */
+    id: string;
+    /**
+     * The UTC time at which this resource was created.
+     */
+    createdAt: string;
+    /**
+     * `true` if this is a live mode resource else `false`.
+     */
+    live: boolean;
+    /**
+     * Always `tracker`.
+     */
+    object: 'tracker';
+    /**
+     * The base template for URLs generated by this Tracker.
+     */
+    redirectURLTemplate: string;
+    /**
+     * The unique number of interactions the Tracker has had.
+     */
+    uniqueVisitCount: number;
+    /**
+     * The UTC time at which this resource was last updated.
+     */
+    updatedAt: string;
+    /**
+     * The number of days generated Tracker URLs remain valid.
+     */
+    urlExpireAfterDays: 30 | 60 | 90 | 180 | 365;
+    /**
+     * The total number of interactions the Tracker has had.
+     */
+    visitCount: number;
+    /**
+     * An optional string describing this resource. Will be visible in the API and the
+     * dashboard.
+     */
+    description?: string;
+    /**
+     * See the section on Metadata.
+     */
+    metadata?: {
+        [key: string]: unknown;
+    };
+}
+export interface TrackerRetrieveResponse {
+    /**
+     * A unique ID prefixed with tracker\_
+     */
+    id: string;
+    /**
+     * The UTC time at which this resource was created.
+     */
+    createdAt: string;
+    /**
+     * `true` if this is a live mode resource else `false`.
+     */
+    live: boolean;
+    /**
+     * Always `tracker`.
+     */
+    object: 'tracker';
+    /**
+     * The base template for URLs generated by this Tracker.
+     */
+    redirectURLTemplate: string;
+    /**
+     * The unique number of interactions the Tracker has had.
+     */
+    uniqueVisitCount: number;
+    /**
+     * The UTC time at which this resource was last updated.
+     */
+    updatedAt: string;
+    /**
+     * The number of days generated Tracker URLs remain valid.
+     */
+    urlExpireAfterDays: 30 | 60 | 90 | 180 | 365;
+    /**
+     * The total number of interactions the Tracker has had.
+     */
+    visitCount: number;
+    /**
+     * An optional string describing this resource. Will be visible in the API and the
+     * dashboard.
+     */
+    description?: string;
+    /**
+     * See the section on Metadata.
+     */
+    metadata?: {
+        [key: string]: unknown;
+    };
+}
+export interface TrackerUpdateResponse {
+    /**
+     * A unique ID prefixed with tracker\_
+     */
+    id: string;
+    /**
+     * The UTC time at which this resource was created.
+     */
+    createdAt: string;
+    /**
+     * `true` if this is a live mode resource else `false`.
+     */
+    live: boolean;
+    /**
+     * Always `tracker`.
+     */
+    object: 'tracker';
+    /**
+     * The base template for URLs generated by this Tracker.
+     */
+    redirectURLTemplate: string;
+    /**
+     * The unique number of interactions the Tracker has had.
+     */
+    uniqueVisitCount: number;
+    /**
+     * The UTC time at which this resource was last updated.
+     */
+    updatedAt: string;
+    /**
+     * The number of days generated Tracker URLs remain valid.
+     */
+    urlExpireAfterDays: 30 | 60 | 90 | 180 | 365;
+    /**
+     * The total number of interactions the Tracker has had.
+     */
+    visitCount: number;
+    /**
+     * An optional string describing this resource. Will be visible in the API and the
+     * dashboard.
+     */
+    description?: string;
+    /**
+     * See the section on Metadata.
+     */
+    metadata?: {
+        [key: string]: unknown;
+    };
+}
+export interface TrackerListResponse {
+    /**
+     * A unique ID prefixed with tracker\_
+     */
+    id: string;
+    /**
+     * The UTC time at which this resource was created.
+     */
+    createdAt: string;
+    /**
+     * `true` if this is a live mode resource else `false`.
+     */
+    live: boolean;
+    /**
+     * Always `tracker`.
+     */
+    object: 'tracker';
+    /**
+     * The base template for URLs generated by this Tracker.
+     */
+    redirectURLTemplate: string;
+    /**
+     * The unique number of interactions the Tracker has had.
+     */
+    uniqueVisitCount: number;
+    /**
+     * The UTC time at which this resource was last updated.
+     */
+    updatedAt: string;
+    /**
+     * The number of days generated Tracker URLs remain valid.
+     */
+    urlExpireAfterDays: 30 | 60 | 90 | 180 | 365;
+    /**
+     * The total number of interactions the Tracker has had.
+     */
+    visitCount: number;
+    /**
+     * An optional string describing this resource. Will be visible in the API and the
+     * dashboard.
+     */
+    description?: string;
+    /**
+     * See the section on Metadata.
+     */
+    metadata?: {
+        [key: string]: unknown;
+    };
+}
+export interface TrackerDeleteResponse {
+    /**
+     * A unique ID prefixed with tracker\_
+     */
+    id: string;
+    deleted: true;
+    /**
+     * Always `tracker`.
+     */
+    object: 'tracker';
+}
+export interface TrackerRetrieveVisitsResponse {
+    /**
+     * A unique ID prefixed with `tracker_visit_`.
+     */
+    id: string;
+    /**
+     * The UTC time at which this visit was created.
+     */
+    createdAt: string;
+    /**
+     * The type of device associated with the visit.
+     */
+    device: string;
+    /**
+     * The IP address associated with the visit.
+     */
+    ipAddress: string;
+    /**
+     * Indicates if the visit was used in a live order or not.
+     */
+    live: boolean;
+    /**
+     * Always `tracker_visit`.
+     */
+    object: 'tracker_visit';
+    /**
+     * The ID of the order where the interaction occurred.
+     */
+    orderID: string;
+    /**
+     * The ID of the tracker related to this visit.
+     */
+    tracker: string;
+    /**
+     * The UTC time at which this visit was last updated.
+     */
+    updatedAt: string;
+}
+export interface TrackerCreateParams {
+    /**
+     * The base template for URLs generated by this Tracker.
+     */
+    redirectURLTemplate: string;
+    /**
+     * The number of days generated Tracker URLs remain valid.
+     */
+    urlExpireAfterDays: 30 | 60 | 90 | 180 | 365;
+    /**
+     * An optional string describing this resource. Will be visible in the API and the
+     * dashboard.
+     */
+    description?: string;
+    /**
+     * See the section on Metadata.
+     */
+    metadata?: {
+        [key: string]: unknown;
+    };
+}
+export interface TrackerUpdateParams {
+    /**
+     * The base template for URLs generated by this Tracker.
+     */
+    redirectURLTemplate: string;
+    /**
+     * The number of days generated Tracker URLs remain valid.
+     */
+    urlExpireAfterDays: 30 | 60 | 90 | 180 | 365;
+    /**
+     * An optional string describing this resource. Will be visible in the API and the
+     * dashboard.
+     */
+    description?: string;
+    /**
+     * See the section on Metadata.
+     */
+    metadata?: {
+        [key: string]: unknown;
+    };
+}
+export interface TrackerListParams extends SkipLimitParams {
+    /**
+     * You can supply any string to help narrow down the list of resources. For
+     * example, if you pass `"New York"` (quoted), it will return resources that have
+     * that string present somewhere in their response. Alternatively, you can supply a
+     * structured search query. See the documentation on `StructuredSearchQuery` for
+     * more details.
+     */
+    search?: string;
+}
+export interface TrackerRetrieveVisitsParams extends SkipLimitParams {
+    /**
+     * You can supply any string to help narrow down the list of resources. For
+     * example, if you pass `"New York"` (quoted), it will return resources that have
+     * that string present somewhere in their response. Alternatively, you can supply a
+     * structured search query. See the documentation on `StructuredSearchQuery` for
+     * more details.
+     */
+    search?: string;
+}
+export declare namespace Trackers {
+    export { type TrackerCreateResponse as TrackerCreateResponse, type TrackerRetrieveResponse as TrackerRetrieveResponse, type TrackerUpdateResponse as TrackerUpdateResponse, type TrackerListResponse as TrackerListResponse, type TrackerDeleteResponse as TrackerDeleteResponse, type TrackerRetrieveVisitsResponse as TrackerRetrieveVisitsResponse, type TrackerListResponsesSkipLimit as TrackerListResponsesSkipLimit, type TrackerRetrieveVisitsResponsesSkipLimit as TrackerRetrieveVisitsResponsesSkipLimit, type TrackerCreateParams as TrackerCreateParams, type TrackerUpdateParams as TrackerUpdateParams, type TrackerListParams as TrackerListParams, type TrackerRetrieveVisitsParams as TrackerRetrieveVisitsParams, };
+}
+//# sourceMappingURL=trackers.d.mts.map

package/resources/print-mail/trackers.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"trackers.d.mts","sourceRoot":"","sources":["../../src/resources/print-mail/trackers.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,WAAW,EAAE,SAAS,EAAE,KAAK,eAAe,EAAE;OAChD,EAAE,cAAc,EAAE;AAGzB;;;;;;;;;;;;GAYG;AACH,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAI9F;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;IAInF;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAI1G;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAK,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,6BAA6B,EAAE,mBAAmB,CAAC;IAOlE;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAI/E;;;;;;;;;;;;OAYG;IACH,cAAc,CACZ,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,2BAA2B,GAAG,IAAI,GAAG,SAAc,EAC1D,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,uCAAuC,EAAE,6BAA6B,CAAC;CAOvF;AAED,MAAM,MAAM,6BAA6B,GAAG,SAAS,CAAC,mBAAmB,CAAC,CAAC;AAE3E,MAAM,MAAM,uCAAuC,GAAG,SAAS,CAAC,6BAA6B,CAAC,CAAC;AAE/F,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,SAAS,CAAC;IAElB;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,kBAAkB,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,GAAG,GAAG,GAAG,CAAC;IAE7C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;CACvC;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,SAAS,CAAC;IAElB;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,kBAAkB,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,GAAG,GAAG,GAAG,CAAC;IAE7C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;CACvC;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,SAAS,CAAC;IAElB;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,kBAAkB,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,GAAG,GAAG,GAAG,CAAC;IAE7C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;CACvC;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,SAAS,CAAC;IAElB;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,kBAAkB,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,GAAG,GAAG,GAAG,CAAC;IAE7C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;CACvC;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX,OAAO,EAAE,IAAI,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,SAAS,CAAC;CACnB;AAED,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,eAAe,CAAC;IAExB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,kBAAkB,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,GAAG,GAAG,GAAG,CAAC;IAE7C;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;CACvC;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,kBAAkB,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,GAAG,GAAG,GAAG,CAAC;IAE7C;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;CACvC;AAED,MAAM,WAAW,iBAAkB,SAAQ,eAAe;IACxD;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,2BAA4B,SAAQ,eAAe;IAClE;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,uCAAuC,IAAI,uCAAuC,EACvF,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,2BAA2B,IAAI,2BAA2B,GAChE,CAAC;CACH"}