postgrid-node 0.1.0-alpha.4 → 0.2.0

package/resources/print-mail/order-profiles/self-mailers.d.mts

@@ -0,0 +1,268 @@
+import { APIResource } from "../../../core/resource.mjs";
+import * as BoxesAPI from "../boxes.mjs";
+import { APIPromise } from "../../../core/api-promise.mjs";
+import { RequestOptions } from "../../../internal/request-options.mjs";
+export declare class SelfMailers extends APIResource {
+    /**
+     * Creates a new Self-Mailer Profile. Provide either `insideTemplate` and
+     * `outsideTemplate` IDs, or upload a 2-page `pdf`. If providing a `pdf`, the
+     * request `Content-Type` must be `multipart/form-data`.
+     *
+     * @example
+     * ```ts
+     * const selfMailerProfile =
+     *   await client.printMail.orderProfiles.selfMailers.create({
+     *     size: '8.5x11_bifold',
+     *   });
+     * ```
+     */
+    create(params: SelfMailerCreateParams, options?: RequestOptions): APIPromise<SelfMailerProfile>;
+    /**
+     * Retrieves the details of a specific Self-Mailer Profile.
+     *
+     * @example
+     * ```ts
+     * const selfMailerProfile =
+     *   await client.printMail.orderProfiles.selfMailers.retrieve(
+     *     'id',
+     *   );
+     * ```
+     */
+    retrieve(id: string, query?: SelfMailerRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<SelfMailerProfile>;
+    /**
+     * Updates specific fields of an existing Self-Mailer Profile. If providing a
+     * `pdf`, the request `Content-Type` must be `multipart/form-data`.
+     *
+     * @example
+     * ```ts
+     * const selfMailerProfile =
+     *   await client.printMail.orderProfiles.selfMailers.update(
+     *     'id',
+     *     { size: '8.5x11_bifold' },
+     *   );
+     * ```
+     */
+    update(id: string, params: SelfMailerUpdateParams, options?: RequestOptions): APIPromise<SelfMailerProfile>;
+    /**
+     * Retrieves a list of Self-Mailer Profiles.
+     *
+     * @example
+     * ```ts
+     * const selfMailers =
+     *   await client.printMail.orderProfiles.selfMailers.list();
+     * ```
+     */
+    list(query?: SelfMailerListParams | null | undefined, options?: RequestOptions): APIPromise<SelfMailerListResponse>;
+    /**
+     * Deletes a Self-Mailer Profile.
+     *
+     * @example
+     * ```ts
+     * const selfMailer =
+     *   await client.printMail.orderProfiles.selfMailers.delete(
+     *     'id',
+     *   );
+     * ```
+     */
+    delete(id: string, options?: RequestOptions): APIPromise<SelfMailerDeleteResponse>;
+}
+/**
+ * Represents a Self-Mailer Profile resource.
+ */
+export interface SelfMailerProfile {
+    /**
+     * Unique identifier for the order profile.
+     */
+    id: string;
+    /**
+     * Timestamp when the profile was created.
+     */
+    createdAt: string;
+    /**
+     * Indicates if the profile is associated with the live or test environment.
+     */
+    live: boolean;
+    /**
+     * Always `self_mailer_profile`.
+     */
+    object: 'self_mailer_profile';
+    /**
+     * Enum representing the supported self-mailer sizes.
+     */
+    size: SelfMailerSize;
+    /**
+     * Timestamp when the profile was last updated.
+     */
+    updatedAt: string;
+    /**
+     * An optional description for the profile. Set to `null` to remove during update.
+     */
+    description?: string | null;
+    /**
+     * ID of the template for the inside. Required unless `pdf` is provided.
+     */
+    insideTemplate?: string;
+    /**
+     * Mailing class (cannot include extra services for self-mailers).
+     */
+    mailingClass?: BoxesAPI.OrderMailingClass;
+    /**
+     * Default merge variables for orders created using this profile.
+     */
+    mergeVariables?: {
+        [key: string]: unknown;
+    } | null;
+    /**
+     * Optional key-value metadata.
+     */
+    metadata?: {
+        [key: string]: string;
+    } | null;
+    /**
+     * ID of the template for the outside. Required unless `pdf` is provided.
+     */
+    outsideTemplate?: string;
+    /**
+     * A temporary, signed URL to view the uploaded PDF, if any.
+     */
+    uploadedPDF?: string;
+}
+/**
+ * Enum representing the supported self-mailer sizes.
+ */
+export type SelfMailerSize = '8.5x11_bifold' | '8.5x11_trifold' | '9.5x16_trifold';
+/**
+ * Represents a list of Self-Mailer Profiles.
+ */
+export interface SelfMailerListResponse {
+    data: Array<SelfMailerProfile>;
+    limit: number;
+    object: 'list';
+    skip: number;
+    totalCount: number;
+}
+export interface SelfMailerDeleteResponse {
+    /**
+     * Unique identifier for the order profile.
+     */
+    id: string;
+    deleted: true;
+    /**
+     * Always `self_mailer_profile`.
+     */
+    object: 'self_mailer_profile';
+}
+export interface SelfMailerCreateParams {
+    /**
+     * Body param: Enum representing the supported self-mailer sizes.
+     */
+    size: SelfMailerSize;
+    /**
+     * Query param: Optional list of related resources to expand in the response.
+     */
+    expand?: Array<string>;
+    /**
+     * Body param: An optional description for the profile. Set to `null` to remove
+     * during update.
+     */
+    description?: string | null;
+    /**
+     * Body param: ID of the template for the inside. Required unless `pdf` is
+     * provided.
+     */
+    insideTemplate?: string;
+    /**
+     * Body param: Mailing class (cannot include extra services for self-mailers).
+     */
+    mailingClass?: BoxesAPI.OrderMailingClass;
+    /**
+     * Body param: Default merge variables for orders created using this profile.
+     */
+    mergeVariables?: {
+        [key: string]: unknown;
+    } | null;
+    /**
+     * Body param: Optional key-value metadata.
+     */
+    metadata?: {
+        [key: string]: string;
+    } | null;
+    /**
+     * Body param: ID of the template for the outside. Required unless `pdf` is
+     * provided.
+     */
+    outsideTemplate?: string;
+    /**
+     * Body param: A 2-page PDF file containing the self-mailer content (inside and
+     * outside). Cannot be used with `insideTemplate`/`outsideTemplate`.
+     */
+    pdf?: string;
+}
+export interface SelfMailerRetrieveParams {
+    /**
+     * Optional list of related resources to expand in the response.
+     */
+    expand?: Array<string>;
+}
+export interface SelfMailerUpdateParams {
+    /**
+     * Body param: Enum representing the supported self-mailer sizes.
+     */
+    size: SelfMailerSize;
+    /**
+     * Query param: Optional list of related resources to expand in the response.
+     */
+    expand?: Array<string>;
+    /**
+     * Body param: An optional description for the profile. Set to `null` to remove
+     * during update.
+     */
+    description?: string | null;
+    /**
+     * Body param: ID of the template for the inside. Required unless `pdf` is
+     * provided.
+     */
+    insideTemplate?: string;
+    /**
+     * Body param: Mailing class (cannot include extra services for self-mailers).
+     */
+    mailingClass?: BoxesAPI.OrderMailingClass;
+    /**
+     * Body param: Default merge variables for orders created using this profile.
+     */
+    mergeVariables?: {
+        [key: string]: unknown;
+    } | null;
+    /**
+     * Body param: Optional key-value metadata.
+     */
+    metadata?: {
+        [key: string]: string;
+    } | null;
+    /**
+     * Body param: ID of the template for the outside. Required unless `pdf` is
+     * provided.
+     */
+    outsideTemplate?: string;
+    /**
+     * Body param: A 2-page PDF file containing the self-mailer content (inside and
+     * outside). Cannot be used with `insideTemplate`/`outsideTemplate`.
+     */
+    pdf?: string;
+}
+export interface SelfMailerListParams {
+    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 declare namespace SelfMailers {
+    export { type SelfMailerProfile as SelfMailerProfile, type SelfMailerSize as SelfMailerSize, type SelfMailerListResponse as SelfMailerListResponse, type SelfMailerDeleteResponse as SelfMailerDeleteResponse, type SelfMailerCreateParams as SelfMailerCreateParams, type SelfMailerRetrieveParams as SelfMailerRetrieveParams, type SelfMailerUpdateParams as SelfMailerUpdateParams, type SelfMailerListParams as SelfMailerListParams, };
+}
+//# sourceMappingURL=self-mailers.d.mts.map

package/resources/print-mail/order-profiles/self-mailers.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"self-mailers.d.mts","sourceRoot":"","sources":["../../../src/resources/print-mail/order-profiles/self-mailers.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,QAAQ;OACb,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,MAAM,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iBAAiB,CAAC;IAS/F;;;;;;;;;;OAUG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,wBAAwB,GAAG,IAAI,GAAG,SAAc,EACvD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iBAAiB,CAAC;IAIhC;;;;;;;;;;;;OAYG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,sBAAsB,EAC9B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iBAAiB,CAAC;IAShC;;;;;;;;OAQG;IACH,IAAI,CACF,KAAK,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,sBAAsB,CAAC;IAIrC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wBAAwB,CAAC;CAGnF;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;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,qBAAqB,CAAC;IAE9B;;OAEG;IACH,IAAI,EAAE,cAAc,CAAC;IAErB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,YAAY,CAAC,EAAE,QAAQ,CAAC,iBAAiB,CAAC;IAE1C;;OAEG;IACH,cAAc,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAEnD;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,eAAe,GAAG,gBAAgB,GAAG,gBAAgB,CAAC;AAEnF;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAC;IAE/B,KAAK,EAAE,MAAM,CAAC;IAEd,MAAM,EAAE,MAAM,CAAC;IAEf,IAAI,EAAE,MAAM,CAAC;IAEb,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX,OAAO,EAAE,IAAI,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,qBAAqB,CAAC;CAC/B;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,IAAI,EAAE,cAAc,CAAC;IAErB;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEvB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,YAAY,CAAC,EAAE,QAAQ,CAAC,iBAAiB,CAAC;IAE1C;;OAEG;IACH,cAAc,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAEnD;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC;IAE5C;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACxB;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,IAAI,EAAE,cAAc,CAAC;IAErB;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEvB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,YAAY,CAAC,EAAE,QAAQ,CAAC,iBAAiB,CAAC;IAE1C;;OAEG;IACH,cAAc,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAEnD;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC;IAE5C;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,oBAAoB;IACnC,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}

package/resources/print-mail/order-profiles/self-mailers.d.ts

@@ -0,0 +1,268 @@
+import { APIResource } from "../../../core/resource.js";
+import * as BoxesAPI from "../boxes.js";
+import { APIPromise } from "../../../core/api-promise.js";
+import { RequestOptions } from "../../../internal/request-options.js";
+export declare class SelfMailers extends APIResource {
+    /**
+     * Creates a new Self-Mailer Profile. Provide either `insideTemplate` and
+     * `outsideTemplate` IDs, or upload a 2-page `pdf`. If providing a `pdf`, the
+     * request `Content-Type` must be `multipart/form-data`.
+     *
+     * @example
+     * ```ts
+     * const selfMailerProfile =
+     *   await client.printMail.orderProfiles.selfMailers.create({
+     *     size: '8.5x11_bifold',
+     *   });
+     * ```
+     */
+    create(params: SelfMailerCreateParams, options?: RequestOptions): APIPromise<SelfMailerProfile>;
+    /**
+     * Retrieves the details of a specific Self-Mailer Profile.
+     *
+     * @example
+     * ```ts
+     * const selfMailerProfile =
+     *   await client.printMail.orderProfiles.selfMailers.retrieve(
+     *     'id',
+     *   );
+     * ```
+     */
+    retrieve(id: string, query?: SelfMailerRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<SelfMailerProfile>;
+    /**
+     * Updates specific fields of an existing Self-Mailer Profile. If providing a
+     * `pdf`, the request `Content-Type` must be `multipart/form-data`.
+     *
+     * @example
+     * ```ts
+     * const selfMailerProfile =
+     *   await client.printMail.orderProfiles.selfMailers.update(
+     *     'id',
+     *     { size: '8.5x11_bifold' },
+     *   );
+     * ```
+     */
+    update(id: string, params: SelfMailerUpdateParams, options?: RequestOptions): APIPromise<SelfMailerProfile>;
+    /**
+     * Retrieves a list of Self-Mailer Profiles.
+     *
+     * @example
+     * ```ts
+     * const selfMailers =
+     *   await client.printMail.orderProfiles.selfMailers.list();
+     * ```
+     */
+    list(query?: SelfMailerListParams | null | undefined, options?: RequestOptions): APIPromise<SelfMailerListResponse>;
+    /**
+     * Deletes a Self-Mailer Profile.
+     *
+     * @example
+     * ```ts
+     * const selfMailer =
+     *   await client.printMail.orderProfiles.selfMailers.delete(
+     *     'id',
+     *   );
+     * ```
+     */
+    delete(id: string, options?: RequestOptions): APIPromise<SelfMailerDeleteResponse>;
+}
+/**
+ * Represents a Self-Mailer Profile resource.
+ */
+export interface SelfMailerProfile {
+    /**
+     * Unique identifier for the order profile.
+     */
+    id: string;
+    /**
+     * Timestamp when the profile was created.
+     */
+    createdAt: string;
+    /**
+     * Indicates if the profile is associated with the live or test environment.
+     */
+    live: boolean;
+    /**
+     * Always `self_mailer_profile`.
+     */
+    object: 'self_mailer_profile';
+    /**
+     * Enum representing the supported self-mailer sizes.
+     */
+    size: SelfMailerSize;
+    /**
+     * Timestamp when the profile was last updated.
+     */
+    updatedAt: string;
+    /**
+     * An optional description for the profile. Set to `null` to remove during update.
+     */
+    description?: string | null;
+    /**
+     * ID of the template for the inside. Required unless `pdf` is provided.
+     */
+    insideTemplate?: string;
+    /**
+     * Mailing class (cannot include extra services for self-mailers).
+     */
+    mailingClass?: BoxesAPI.OrderMailingClass;
+    /**
+     * Default merge variables for orders created using this profile.
+     */
+    mergeVariables?: {
+        [key: string]: unknown;
+    } | null;
+    /**
+     * Optional key-value metadata.
+     */
+    metadata?: {
+        [key: string]: string;
+    } | null;
+    /**
+     * ID of the template for the outside. Required unless `pdf` is provided.
+     */
+    outsideTemplate?: string;
+    /**
+     * A temporary, signed URL to view the uploaded PDF, if any.
+     */
+    uploadedPDF?: string;
+}
+/**
+ * Enum representing the supported self-mailer sizes.
+ */
+export type SelfMailerSize = '8.5x11_bifold' | '8.5x11_trifold' | '9.5x16_trifold';
+/**
+ * Represents a list of Self-Mailer Profiles.
+ */
+export interface SelfMailerListResponse {
+    data: Array<SelfMailerProfile>;
+    limit: number;
+    object: 'list';
+    skip: number;
+    totalCount: number;
+}
+export interface SelfMailerDeleteResponse {
+    /**
+     * Unique identifier for the order profile.
+     */
+    id: string;
+    deleted: true;
+    /**
+     * Always `self_mailer_profile`.
+     */
+    object: 'self_mailer_profile';
+}
+export interface SelfMailerCreateParams {
+    /**
+     * Body param: Enum representing the supported self-mailer sizes.
+     */
+    size: SelfMailerSize;
+    /**
+     * Query param: Optional list of related resources to expand in the response.
+     */
+    expand?: Array<string>;
+    /**
+     * Body param: An optional description for the profile. Set to `null` to remove
+     * during update.
+     */
+    description?: string | null;
+    /**
+     * Body param: ID of the template for the inside. Required unless `pdf` is
+     * provided.
+     */
+    insideTemplate?: string;
+    /**
+     * Body param: Mailing class (cannot include extra services for self-mailers).
+     */
+    mailingClass?: BoxesAPI.OrderMailingClass;
+    /**
+     * Body param: Default merge variables for orders created using this profile.
+     */
+    mergeVariables?: {
+        [key: string]: unknown;
+    } | null;
+    /**
+     * Body param: Optional key-value metadata.
+     */
+    metadata?: {
+        [key: string]: string;
+    } | null;
+    /**
+     * Body param: ID of the template for the outside. Required unless `pdf` is
+     * provided.
+     */
+    outsideTemplate?: string;
+    /**
+     * Body param: A 2-page PDF file containing the self-mailer content (inside and
+     * outside). Cannot be used with `insideTemplate`/`outsideTemplate`.
+     */
+    pdf?: string;
+}
+export interface SelfMailerRetrieveParams {
+    /**
+     * Optional list of related resources to expand in the response.
+     */
+    expand?: Array<string>;
+}
+export interface SelfMailerUpdateParams {
+    /**
+     * Body param: Enum representing the supported self-mailer sizes.
+     */
+    size: SelfMailerSize;
+    /**
+     * Query param: Optional list of related resources to expand in the response.
+     */
+    expand?: Array<string>;
+    /**
+     * Body param: An optional description for the profile. Set to `null` to remove
+     * during update.
+     */
+    description?: string | null;
+    /**
+     * Body param: ID of the template for the inside. Required unless `pdf` is
+     * provided.
+     */
+    insideTemplate?: string;
+    /**
+     * Body param: Mailing class (cannot include extra services for self-mailers).
+     */
+    mailingClass?: BoxesAPI.OrderMailingClass;
+    /**
+     * Body param: Default merge variables for orders created using this profile.
+     */
+    mergeVariables?: {
+        [key: string]: unknown;
+    } | null;
+    /**
+     * Body param: Optional key-value metadata.
+     */
+    metadata?: {
+        [key: string]: string;
+    } | null;
+    /**
+     * Body param: ID of the template for the outside. Required unless `pdf` is
+     * provided.
+     */
+    outsideTemplate?: string;
+    /**
+     * Body param: A 2-page PDF file containing the self-mailer content (inside and
+     * outside). Cannot be used with `insideTemplate`/`outsideTemplate`.
+     */
+    pdf?: string;
+}
+export interface SelfMailerListParams {
+    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 declare namespace SelfMailers {
+    export { type SelfMailerProfile as SelfMailerProfile, type SelfMailerSize as SelfMailerSize, type SelfMailerListResponse as SelfMailerListResponse, type SelfMailerDeleteResponse as SelfMailerDeleteResponse, type SelfMailerCreateParams as SelfMailerCreateParams, type SelfMailerRetrieveParams as SelfMailerRetrieveParams, type SelfMailerUpdateParams as SelfMailerUpdateParams, type SelfMailerListParams as SelfMailerListParams, };
+}
+//# sourceMappingURL=self-mailers.d.ts.map

package/resources/print-mail/order-profiles/self-mailers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"self-mailers.d.ts","sourceRoot":"","sources":["../../../src/resources/print-mail/order-profiles/self-mailers.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,QAAQ;OACb,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,MAAM,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iBAAiB,CAAC;IAS/F;;;;;;;;;;OAUG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,wBAAwB,GAAG,IAAI,GAAG,SAAc,EACvD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iBAAiB,CAAC;IAIhC;;;;;;;;;;;;OAYG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,sBAAsB,EAC9B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iBAAiB,CAAC;IAShC;;;;;;;;OAQG;IACH,IAAI,CACF,KAAK,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,sBAAsB,CAAC;IAIrC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wBAAwB,CAAC;CAGnF;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;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,qBAAqB,CAAC;IAE9B;;OAEG;IACH,IAAI,EAAE,cAAc,CAAC;IAErB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,YAAY,CAAC,EAAE,QAAQ,CAAC,iBAAiB,CAAC;IAE1C;;OAEG;IACH,cAAc,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAEnD;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,eAAe,GAAG,gBAAgB,GAAG,gBAAgB,CAAC;AAEnF;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAC;IAE/B,KAAK,EAAE,MAAM,CAAC;IAEd,MAAM,EAAE,MAAM,CAAC;IAEf,IAAI,EAAE,MAAM,CAAC;IAEb,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX,OAAO,EAAE,IAAI,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,qBAAqB,CAAC;CAC/B;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,IAAI,EAAE,cAAc,CAAC;IAErB;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEvB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,YAAY,CAAC,EAAE,QAAQ,CAAC,iBAAiB,CAAC;IAE1C;;OAEG;IACH,cAAc,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAEnD;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC;IAE5C;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACxB;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,IAAI,EAAE,cAAc,CAAC;IAErB;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEvB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,YAAY,CAAC,EAAE,QAAQ,CAAC,iBAAiB,CAAC;IAE1C;;OAEG;IACH,cAAc,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAEnD;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC;IAE5C;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,oBAAoB;IACnC,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}

package/resources/print-mail/order-profiles/self-mailers.js

@@ -0,0 +1,92 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SelfMailers = void 0;
+const resource_1 = require("../../../core/resource.js");
+const path_1 = require("../../../internal/utils/path.js");
+class SelfMailers extends resource_1.APIResource {
+    /**
+     * Creates a new Self-Mailer Profile. Provide either `insideTemplate` and
+     * `outsideTemplate` IDs, or upload a 2-page `pdf`. If providing a `pdf`, the
+     * request `Content-Type` must be `multipart/form-data`.
+     *
+     * @example
+     * ```ts
+     * const selfMailerProfile =
+     *   await client.printMail.orderProfiles.selfMailers.create({
+     *     size: '8.5x11_bifold',
+     *   });
+     * ```
+     */
+    create(params, options) {
+        const { expand, ...body } = params;
+        return this._client.post('/print-mail/v1/order_profiles/self_mailers', {
+            query: { expand },
+            body,
+            ...options,
+        });
+    }
+    /**
+     * Retrieves the details of a specific Self-Mailer Profile.
+     *
+     * @example
+     * ```ts
+     * const selfMailerProfile =
+     *   await client.printMail.orderProfiles.selfMailers.retrieve(
+     *     'id',
+     *   );
+     * ```
+     */
+    retrieve(id, query = {}, options) {
+        return this._client.get((0, path_1.path) `/print-mail/v1/order_profiles/self_mailers/${id}`, { query, ...options });
+    }
+    /**
+     * Updates specific fields of an existing Self-Mailer Profile. If providing a
+     * `pdf`, the request `Content-Type` must be `multipart/form-data`.
+     *
+     * @example
+     * ```ts
+     * const selfMailerProfile =
+     *   await client.printMail.orderProfiles.selfMailers.update(
+     *     'id',
+     *     { size: '8.5x11_bifold' },
+     *   );
+     * ```
+     */
+    update(id, params, options) {
+        const { expand, ...body } = params;
+        return this._client.post((0, path_1.path) `/print-mail/v1/order_profiles/self_mailers/${id}`, {
+            query: { expand },
+            body,
+            ...options,
+        });
+    }
+    /**
+     * Retrieves a list of Self-Mailer Profiles.
+     *
+     * @example
+     * ```ts
+     * const selfMailers =
+     *   await client.printMail.orderProfiles.selfMailers.list();
+     * ```
+     */
+    list(query = {}, options) {
+        return this._client.get('/print-mail/v1/order_profiles/self_mailers', { query, ...options });
+    }
+    /**
+     * Deletes a Self-Mailer Profile.
+     *
+     * @example
+     * ```ts
+     * const selfMailer =
+     *   await client.printMail.orderProfiles.selfMailers.delete(
+     *     'id',
+     *   );
+     * ```
+     */
+    delete(id, options) {
+        return this._client.delete((0, path_1.path) `/print-mail/v1/order_profiles/self_mailers/${id}`, options);
+    }
+}
+exports.SelfMailers = SelfMailers;
+//# sourceMappingURL=self-mailers.js.map

package/resources/print-mail/order-profiles/self-mailers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"self-mailers.js","sourceRoot":"","sources":["../../../src/resources/print-mail/order-profiles/self-mailers.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAIrD,0DAAoD;AAEpD,MAAa,WAAY,SAAQ,sBAAW;IAC1C;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,MAA8B,EAAE,OAAwB;QAC7D,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACnC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,4CAA4C,EAAE;YACrE,KAAK,EAAE,EAAE,MAAM,EAAE;YACjB,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,QAAQ,CACN,EAAU,EACV,QAAqD,EAAE,EACvD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,8CAA8C,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzG,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,CACJ,EAAU,EACV,MAA8B,EAC9B,OAAwB;QAExB,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACnC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,8CAA8C,EAAE,EAAE,EAAE;YAC/E,KAAK,EAAE,EAAE,MAAM,EAAE;YACjB,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,IAAI,CACF,QAAiD,EAAE,EACnD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,4CAA4C,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/F,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,8CAA8C,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC9F,CAAC;CACF;AAlGD,kCAkGC"}