postgrid-node 0.1.0-alpha.5 → 0.2.0

package/resources/print-mail/campaigns.d.ts

@@ -0,0 +1,317 @@
+import { APIResource } from "../../core/resource.js";
+import { APIPromise } from "../../core/api-promise.js";
+import { RequestOptions } from "../../internal/request-options.js";
+export declare class Campaigns extends APIResource {
+    /**
+     * Create a new campaign.
+     *
+     * A campaign links a mailing list with a specific mail piece profile (letter,
+     * postcard, cheque, or self-mailer) to send bulk mail. Upon creation, the campaign
+     * enters the `drafting` status while assets are validated.
+     *
+     * @example
+     * ```ts
+     * const campaign = await client.printMail.campaigns.create({
+     *   mailingList: 'mailingList',
+     * });
+     * ```
+     */
+    create(params: CampaignCreateParams, options?: RequestOptions): APIPromise<Campaign>;
+    /**
+     * Retrieve a specific campaign by its ID.
+     *
+     * @example
+     * ```ts
+     * const campaign = await client.printMail.campaigns.retrieve(
+     *   'id',
+     * );
+     * ```
+     */
+    retrieve(id: string, options?: RequestOptions): APIPromise<Campaign>;
+    /**
+     * Update an existing campaign.
+     *
+     * Campaigns can only be updated if they are in the `draft` or `changes_required`
+     * status. Updating a campaign will trigger reprocessing and set its status back to
+     * `drafting`.
+     *
+     * @example
+     * ```ts
+     * const campaign = await client.printMail.campaigns.update(
+     *   'id',
+     * );
+     * ```
+     */
+    update(id: string, body: CampaignUpdateParams, options?: RequestOptions): APIPromise<Campaign>;
+    /**
+     * Retrieve a list of campaigns.
+     *
+     * Returns a paginated list of campaigns associated with the authenticated
+     * organization, filterable by various parameters.
+     *
+     * @example
+     * ```ts
+     * const campaigns = await client.printMail.campaigns.list();
+     * ```
+     */
+    list(query?: CampaignListParams | null | undefined, options?: RequestOptions): APIPromise<CampaignListResponse>;
+    /**
+     * Delete a campaign.
+     *
+     * Campaigns can only be deleted if they are in `draft`, `changes_required`, or
+     * `ready` status. This also permanently deletes associated resources. This
+     * operation cannot be undone.
+     *
+     * @example
+     * ```ts
+     * const campaign = await client.printMail.campaigns.delete(
+     *   'id',
+     * );
+     * ```
+     */
+    delete(id: string, options?: RequestOptions): APIPromise<CampaignDeleteResponse>;
+    /**
+     * Send a campaign for processing.
+     *
+     * This action transitions a campaign from the `draft` status to `creating_orders`.
+     * You can optionally specify a future `sendDate`. Once sent, the campaign cannot
+     * be updated.
+     *
+     * @example
+     * ```ts
+     * const campaign = await client.printMail.campaigns.send(
+     *   'id',
+     * );
+     * ```
+     */
+    send(id: string, body: CampaignSendParams, options?: RequestOptions): APIPromise<Campaign>;
+}
+/**
+ * Represents a bulk mail campaign.
+ */
+export interface Campaign {
+    /**
+     * A unique ID prefixed with campaign\_
+     */
+    id: string;
+    /**
+     * The UTC time at which this resource was created.
+     */
+    createdAt: string;
+    /**
+     * The number of orders successfully created for this campaign.
+     */
+    createdCount: number;
+    /**
+     * `true` if this is a live mode resource else `false`.
+     */
+    live: boolean;
+    /**
+     * The ID of the mailing list associated with this campaign.
+     */
+    mailingList: string;
+    /**
+     * Status of the campaign lifecycle.
+     */
+    status: 'drafting' | 'changes_required' | 'creating_orders' | 'draft' | 'ready' | 'printing' | 'processed_for_delivery';
+    /**
+     * The UTC time at which this resource was last updated.
+     */
+    updatedAt: string;
+    /**
+     * The ID of the cheque profile used for this campaign, if applicable.
+     */
+    chequeProfile?: string;
+    /**
+     * The ID of the default sender contact to use for orders if not specified per
+     * recipient.
+     */
+    defaultSenderContact?: string;
+    /**
+     * An optional string describing this resource. Will be visible in the API and the
+     * dashboard.
+     */
+    description?: string;
+    /**
+     * A list of processing errors encountered, if any. Present when status is
+     * 'changes_required'.
+     */
+    errors?: Array<Campaign.Error>;
+    /**
+     * The ID of the letter profile used for this campaign, if applicable.
+     */
+    letterProfile?: string;
+    /**
+     * See the section on Metadata.
+     */
+    metadata?: {
+        [key: string]: unknown;
+    };
+    /**
+     * A temporary URL to preview the first rendered order, available once the campaign
+     * status is 'draft' or later.
+     */
+    orderPreviewURL?: string;
+    /**
+     * The ID of the postcard profile used for this campaign, if applicable.
+     */
+    postcardProfile?: string;
+    /**
+     * A temporary URL to download the processing report, available once the campaign
+     * is in the `ready` status.
+     */
+    reportURL?: string;
+    /**
+     * The ID of the self-mailer profile used for this campaign, if applicable.
+     */
+    selfMailerProfile?: string;
+    /**
+     * The scheduled date and time for the campaign to be sent.
+     */
+    sendDate?: string;
+}
+export declare namespace Campaign {
+    /**
+     * Details of a specific error encountered during campaign processing.
+     */
+    interface Error {
+        /**
+         * A human-readable message describing the error.
+         */
+        message: string;
+        /**
+         * Type of error encountered during campaign processing.
+         */
+        type: 'processing_error' | 'internal_error';
+    }
+}
+/**
+ * A list of campaigns.
+ */
+export interface CampaignListResponse {
+    data: Array<Campaign>;
+    limit: number;
+    object: 'list';
+    skip: number;
+    totalCount: number;
+}
+export interface CampaignDeleteResponse {
+    /**
+     * A unique ID prefixed with campaign\_
+     */
+    id: string;
+    deleted: true;
+}
+export interface CampaignCreateParams {
+    /**
+     * Body param: The ID of the mailing list associated with this campaign.
+     */
+    mailingList: string;
+    /**
+     * Body param: The ID of the cheque profile used for this campaign, if applicable.
+     */
+    chequeProfile?: string;
+    /**
+     * Body param: The ID of the default sender contact to use for orders if not
+     * specified per recipient.
+     */
+    defaultSenderContact?: string;
+    /**
+     * Body param: An optional string describing this resource. Will be visible in the
+     * API and the dashboard.
+     */
+    description?: string;
+    /**
+     * Body param: The ID of the letter profile used for this campaign, if applicable.
+     */
+    letterProfile?: string;
+    /**
+     * Body param: See the section on Metadata.
+     */
+    metadata?: {
+        [key: string]: unknown;
+    };
+    /**
+     * Body param: The ID of the postcard profile used for this campaign, if
+     * applicable.
+     */
+    postcardProfile?: string;
+    /**
+     * Body param: The ID of the self-mailer profile used for this campaign, if
+     * applicable.
+     */
+    selfMailerProfile?: string;
+    /**
+     * Body param: The scheduled date and time for the campaign to be sent.
+     */
+    sendDate?: string;
+    /**
+     * Header param:
+     */
+    'idempotency-key'?: string;
+}
+export interface CampaignUpdateParams {
+    /**
+     * The ID of the cheque profile to use. Setting this will remove other profile
+     * types. Set to `null` to remove.
+     */
+    chequeProfile?: string | null;
+    /**
+     * The ID of the default sender contact. Set to `null` to remove.
+     */
+    defaultSenderContact?: string | null;
+    /**
+     * An optional description for the campaign. Set to `null` to remove the existing
+     * description.
+     */
+    description?: string | null;
+    /**
+     * The ID of the letter profile to use. Setting this will remove other profile
+     * types. Set to `null` to remove.
+     */
+    letterProfile?: string | null;
+    /**
+     * The ID of the mailing list to associate with this campaign.
+     */
+    mailingList?: string;
+    /**
+     * Optional key-value data associated with the campaign. Set to `null` to remove
+     * existing metadata.
+     */
+    metadata?: {
+        [key: string]: string;
+    } | null;
+    /**
+     * The ID of the postcard profile to use. Setting this will remove other profile
+     * types. Set to `null` to remove.
+     */
+    postcardProfile?: string | null;
+    /**
+     * The ID of the self-mailer profile to use. Setting this will remove other profile
+     * types. Set to `null` to remove.
+     */
+    selfMailerProfile?: string | null;
+}
+export interface CampaignListParams {
+    limit?: number;
+    /**
+     * 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;
+    skip?: number;
+}
+export interface CampaignSendParams {
+    /**
+     * The date and time the campaign should be sent. Must be in the future. If
+     * omitted, defaults to the earliest possible processing date.
+     */
+    sendDate?: (string & {}) | string;
+}
+export declare namespace Campaigns {
+    export { type Campaign as Campaign, type CampaignListResponse as CampaignListResponse, type CampaignDeleteResponse as CampaignDeleteResponse, type CampaignCreateParams as CampaignCreateParams, type CampaignUpdateParams as CampaignUpdateParams, type CampaignListParams as CampaignListParams, type CampaignSendParams as CampaignSendParams, };
+}
+//# sourceMappingURL=campaigns.d.ts.map

package/resources/print-mail/campaigns.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"campaigns.d.ts","sourceRoot":"","sources":["../../src/resources/print-mail/campaigns.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,MAAM,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;IAYpF;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;IAIpE;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;IAI9F;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAK,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oBAAoB,CAAC;IAInC;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;IAIhF;;;;;;;;;;;;;OAaG;IACH,IAAI,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;CAG3F;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,MAAM,EACF,UAAU,GACV,kBAAkB,GAClB,iBAAiB,GACjB,OAAO,GACP,OAAO,GACP,UAAU,GACV,wBAAwB,CAAC;IAE7B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IAE/B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEtC;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,yBAAiB,QAAQ,CAAC;IACxB;;OAEG;IACH,UAAiB,KAAK;QACpB;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,IAAI,EAAE,kBAAkB,GAAG,gBAAgB,CAAC;KAC7C;CACF;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;IAEtB,KAAK,EAAE,MAAM,CAAC;IAEd,MAAM,EAAE,MAAM,CAAC;IAEf,IAAI,EAAE,MAAM,CAAC;IAEb,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX,OAAO,EAAE,IAAI,CAAC;CACf;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEtC;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC;IAE5C;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACnC;AAED,MAAM,WAAW,kBAAkB;IACjC,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,QAAQ,CAAC,EAAE,CAAC,MAAM,GAAG,EAAE,CAAC,GAAG,MAAM,CAAC;CACnC;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;CACH"}

package/resources/print-mail/campaigns.js

@@ -0,0 +1,114 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Campaigns = void 0;
+const resource_1 = require("../../core/resource.js");
+const headers_1 = require("../../internal/headers.js");
+const path_1 = require("../../internal/utils/path.js");
+class Campaigns extends resource_1.APIResource {
+    /**
+     * Create a new campaign.
+     *
+     * A campaign links a mailing list with a specific mail piece profile (letter,
+     * postcard, cheque, or self-mailer) to send bulk mail. Upon creation, the campaign
+     * enters the `drafting` status while assets are validated.
+     *
+     * @example
+     * ```ts
+     * const campaign = await client.printMail.campaigns.create({
+     *   mailingList: 'mailingList',
+     * });
+     * ```
+     */
+    create(params, options) {
+        const { 'idempotency-key': idempotencyKey, ...body } = params;
+        return this._client.post('/print-mail/v1/campaigns', {
+            body,
+            ...options,
+            headers: (0, headers_1.buildHeaders)([
+                { ...(idempotencyKey != null ? { 'idempotency-key': idempotencyKey } : undefined) },
+                options?.headers,
+            ]),
+        });
+    }
+    /**
+     * Retrieve a specific campaign by its ID.
+     *
+     * @example
+     * ```ts
+     * const campaign = await client.printMail.campaigns.retrieve(
+     *   'id',
+     * );
+     * ```
+     */
+    retrieve(id, options) {
+        return this._client.get((0, path_1.path) `/print-mail/v1/campaigns/${id}`, options);
+    }
+    /**
+     * Update an existing campaign.
+     *
+     * Campaigns can only be updated if they are in the `draft` or `changes_required`
+     * status. Updating a campaign will trigger reprocessing and set its status back to
+     * `drafting`.
+     *
+     * @example
+     * ```ts
+     * const campaign = await client.printMail.campaigns.update(
+     *   'id',
+     * );
+     * ```
+     */
+    update(id, body, options) {
+        return this._client.post((0, path_1.path) `/print-mail/v1/campaigns/${id}`, { body, ...options });
+    }
+    /**
+     * Retrieve a list of campaigns.
+     *
+     * Returns a paginated list of campaigns associated with the authenticated
+     * organization, filterable by various parameters.
+     *
+     * @example
+     * ```ts
+     * const campaigns = await client.printMail.campaigns.list();
+     * ```
+     */
+    list(query = {}, options) {
+        return this._client.get('/print-mail/v1/campaigns', { query, ...options });
+    }
+    /**
+     * Delete a campaign.
+     *
+     * Campaigns can only be deleted if they are in `draft`, `changes_required`, or
+     * `ready` status. This also permanently deletes associated resources. This
+     * operation cannot be undone.
+     *
+     * @example
+     * ```ts
+     * const campaign = await client.printMail.campaigns.delete(
+     *   'id',
+     * );
+     * ```
+     */
+    delete(id, options) {
+        return this._client.delete((0, path_1.path) `/print-mail/v1/campaigns/${id}`, options);
+    }
+    /**
+     * Send a campaign for processing.
+     *
+     * This action transitions a campaign from the `draft` status to `creating_orders`.
+     * You can optionally specify a future `sendDate`. Once sent, the campaign cannot
+     * be updated.
+     *
+     * @example
+     * ```ts
+     * const campaign = await client.printMail.campaigns.send(
+     *   'id',
+     * );
+     * ```
+     */
+    send(id, body, options) {
+        return this._client.post((0, path_1.path) `/print-mail/v1/campaigns/${id}/send`, { body, ...options });
+    }
+}
+exports.Campaigns = Campaigns;
+//# sourceMappingURL=campaigns.js.map

package/resources/print-mail/campaigns.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"campaigns.js","sourceRoot":"","sources":["../../src/resources/print-mail/campaigns.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAElD,uDAAsD;AAEtD,uDAAiD;AAEjD,MAAa,SAAU,SAAQ,sBAAW;IACxC;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,MAA4B,EAAE,OAAwB;QAC3D,MAAM,EAAE,iBAAiB,EAAE,cAAc,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,0BAA0B,EAAE;YACnD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB,EAAE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBACnF,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,4BAA4B,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,EAAU,EAAE,IAA0B,EAAE,OAAwB;QACrE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,4BAA4B,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvF,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CACF,QAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,0BAA0B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,4BAA4B,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,IAAI,CAAC,EAAU,EAAE,IAAwB,EAAE,OAAwB;QACjE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,4BAA4B,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5F,CAAC;CACF;AAhHD,8BAgHC"}

package/resources/print-mail/campaigns.mjs

@@ -0,0 +1,110 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../core/resource.mjs";
+import { buildHeaders } from "../../internal/headers.mjs";
+import { path } from "../../internal/utils/path.mjs";
+export class Campaigns extends APIResource {
+    /**
+     * Create a new campaign.
+     *
+     * A campaign links a mailing list with a specific mail piece profile (letter,
+     * postcard, cheque, or self-mailer) to send bulk mail. Upon creation, the campaign
+     * enters the `drafting` status while assets are validated.
+     *
+     * @example
+     * ```ts
+     * const campaign = await client.printMail.campaigns.create({
+     *   mailingList: 'mailingList',
+     * });
+     * ```
+     */
+    create(params, options) {
+        const { 'idempotency-key': idempotencyKey, ...body } = params;
+        return this._client.post('/print-mail/v1/campaigns', {
+            body,
+            ...options,
+            headers: buildHeaders([
+                { ...(idempotencyKey != null ? { 'idempotency-key': idempotencyKey } : undefined) },
+                options?.headers,
+            ]),
+        });
+    }
+    /**
+     * Retrieve a specific campaign by its ID.
+     *
+     * @example
+     * ```ts
+     * const campaign = await client.printMail.campaigns.retrieve(
+     *   'id',
+     * );
+     * ```
+     */
+    retrieve(id, options) {
+        return this._client.get(path `/print-mail/v1/campaigns/${id}`, options);
+    }
+    /**
+     * Update an existing campaign.
+     *
+     * Campaigns can only be updated if they are in the `draft` or `changes_required`
+     * status. Updating a campaign will trigger reprocessing and set its status back to
+     * `drafting`.
+     *
+     * @example
+     * ```ts
+     * const campaign = await client.printMail.campaigns.update(
+     *   'id',
+     * );
+     * ```
+     */
+    update(id, body, options) {
+        return this._client.post(path `/print-mail/v1/campaigns/${id}`, { body, ...options });
+    }
+    /**
+     * Retrieve a list of campaigns.
+     *
+     * Returns a paginated list of campaigns associated with the authenticated
+     * organization, filterable by various parameters.
+     *
+     * @example
+     * ```ts
+     * const campaigns = await client.printMail.campaigns.list();
+     * ```
+     */
+    list(query = {}, options) {
+        return this._client.get('/print-mail/v1/campaigns', { query, ...options });
+    }
+    /**
+     * Delete a campaign.
+     *
+     * Campaigns can only be deleted if they are in `draft`, `changes_required`, or
+     * `ready` status. This also permanently deletes associated resources. This
+     * operation cannot be undone.
+     *
+     * @example
+     * ```ts
+     * const campaign = await client.printMail.campaigns.delete(
+     *   'id',
+     * );
+     * ```
+     */
+    delete(id, options) {
+        return this._client.delete(path `/print-mail/v1/campaigns/${id}`, options);
+    }
+    /**
+     * Send a campaign for processing.
+     *
+     * This action transitions a campaign from the `draft` status to `creating_orders`.
+     * You can optionally specify a future `sendDate`. Once sent, the campaign cannot
+     * be updated.
+     *
+     * @example
+     * ```ts
+     * const campaign = await client.printMail.campaigns.send(
+     *   'id',
+     * );
+     * ```
+     */
+    send(id, body, options) {
+        return this._client.post(path `/print-mail/v1/campaigns/${id}/send`, { body, ...options });
+    }
+}
+//# sourceMappingURL=campaigns.mjs.map

package/resources/print-mail/campaigns.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"campaigns.mjs","sourceRoot":"","sources":["../../src/resources/print-mail/campaigns.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAE,YAAY,EAAE;OAEhB,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,MAA4B,EAAE,OAAwB;QAC3D,MAAM,EAAE,iBAAiB,EAAE,cAAc,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,0BAA0B,EAAE;YACnD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBACnF,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,4BAA4B,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,EAAU,EAAE,IAA0B,EAAE,OAAwB;QACrE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,4BAA4B,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvF,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CACF,QAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,0BAA0B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,4BAA4B,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,IAAI,CAAC,EAAU,EAAE,IAAwB,EAAE,OAAwB;QACjE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,4BAA4B,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5F,CAAC;CACF"}