postgrid-node 0.4.2 → 0.6.1

package/resources/print-mail/order-profiles/letters.d.mts

@@ -1,325 +0,0 @@
-import { APIResource } from "../../../core/resource.mjs";
-import * as BoxesAPI from "../boxes.mjs";
-import * as LettersAPI from "../letters.mjs";
-import { APIPromise } from "../../../core/api-promise.mjs";
-import { PagePromise, SkipLimit, type SkipLimitParams } from "../../../core/pagination.mjs";
-import { RequestOptions } from "../../../internal/request-options.mjs";
-export declare class Letters extends APIResource {
-    /**
-     * Creates a new Letter Profile. You must provide either a `template` ID or upload
-     * a `pdf` file for the content. If providing PDF files (`pdf` or
-     * `attachedPDFFile`), the request `Content-Type` must be `multipart/form-data`.
-     *
-     * @example
-     * ```ts
-     * const letterProfile =
-     *   await client.printMail.orderProfiles.letters.create({
-     *     size: 'us_letter',
-     *     color: true,
-     *     description: 'Monthly Newsletter Profile',
-     *     mailingClass: 'first_class',
-     *     mergeVariables: { salutation: 'Valued Customer' },
-     *     metadata: { campaign: 'Q1 Newsletter' },
-     *     template: 'template_abc',
-     *   });
-     * ```
-     */
-    create(params: LetterCreateParams, options?: RequestOptions): APIPromise<LetterProfile>;
-    /**
-     * Retrieves the details of a specific Letter Profile by its ID.
-     *
-     * @example
-     * ```ts
-     * const letterProfile =
-     *   await client.printMail.orderProfiles.letters.retrieve(
-     *     'id',
-     *   );
-     * ```
-     */
-    retrieve(id: string, query?: LetterRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<LetterProfile>;
-    /**
-     * Updates specific fields of an existing Letter Profile. Only the fields provided
-     * in the request body will be updated. If providing PDF files (`pdf` or
-     * `attachedPDFFile`), the request `Content-Type` must be `multipart/form-data`.
-     *
-     * @example
-     * ```ts
-     * const letterProfile =
-     *   await client.printMail.orderProfiles.letters.update(
-     *     'id',
-     *     { description: 'Updated Newsletter Profile' },
-     *   );
-     * ```
-     */
-    update(id: string, params: LetterUpdateParams, options?: RequestOptions): APIPromise<LetterProfile>;
-    /**
-     * Retrieves a list of Letter Profiles. The profiles are returned sorted by
-     * creation date, with the most recent appearing first.
-     *
-     * @example
-     * ```ts
-     * // Automatically fetches more pages as needed.
-     * for await (const letterProfile of client.printMail.orderProfiles.letters.list()) {
-     *   // ...
-     * }
-     * ```
-     */
-    list(query?: LetterListParams | null | undefined, options?: RequestOptions): PagePromise<LetterProfilesSkipLimit, LetterProfile>;
-    /**
-     * Deletes a Letter Profile. This action cannot be undone. Orders previously
-     * created using this profile are not affected.
-     *
-     * @example
-     * ```ts
-     * const letter =
-     *   await client.printMail.orderProfiles.letters.delete('id');
-     * ```
-     */
-    delete(id: string, options?: RequestOptions): APIPromise<LetterDeleteResponse>;
-}
-export type LetterProfilesSkipLimit = SkipLimit<LetterProfile>;
-export interface LetterProfile {
-    /**
-     * 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 `letter_profile`.
-     */
-    object: 'letter_profile';
-    /**
-     * Enum representing the supported letter sizes.
-     */
-    size: LettersAPI.LetterSize;
-    /**
-     * Timestamp when the profile was last updated.
-     */
-    updatedAt: string;
-    /**
-     * Enum representing the placement of the address on the letter.
-     */
-    addressPlacement?: LettersAPI.AddressPlacement;
-    /**
-     * Model representing an attached PDF.
-     */
-    attachedPDF?: LettersAPI.AttachedPdf;
-    /**
-     * Specifies whether to print in color (true) or black and white (false).
-     */
-    color?: boolean;
-    /**
-     * An optional description for the profile. Set to `null` to remove during update.
-     */
-    description?: string | null;
-    /**
-     * Specifies whether to print on both sides of the paper.
-     */
-    doubleSided?: boolean;
-    /**
-     * ID of a custom envelope to use.
-     */
-    envelope?: string;
-    /**
-     * Mailing class.
-     */
-    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;
-    /**
-     * Specifies which page number should be perforated (if any).
-     */
-    perforatedPage?: 1;
-    /**
-     * ID of a template to use for the letter content. Cannot be used with `pdf`.
-     */
-    template?: string;
-    /**
-     * A temporary, signed URL to view the uploaded PDF, if any.
-     */
-    uploadedPDF?: string;
-}
-export interface LetterDeleteResponse {
-    /**
-     * Unique identifier for the order profile.
-     */
-    id: string;
-    deleted: true;
-    /**
-     * Always `letter_profile`.
-     */
-    object: 'letter_profile';
-}
-export interface LetterCreateParams {
-    /**
-     * Body param: Enum representing the supported letter sizes.
-     */
-    size: LettersAPI.LetterSize;
-    /**
-     * Query param: Optional list of related resources to expand in the response.
-     */
-    expand?: Array<string>;
-    /**
-     * Body param: Enum representing the placement of the address on the letter.
-     */
-    addressPlacement?: LettersAPI.AddressPlacement;
-    /**
-     * Body param: Model representing an attached PDF.
-     */
-    attachedPDF?: LettersAPI.AttachedPdf;
-    /**
-     * Body param: Specifies whether to print in color (true) or black and white
-     * (false).
-     */
-    color?: boolean;
-    /**
-     * Body param: An optional description for the profile. Set to `null` to remove
-     * during update.
-     */
-    description?: string | null;
-    /**
-     * Body param: Specifies whether to print on both sides of the paper.
-     */
-    doubleSided?: boolean;
-    /**
-     * Body param: ID of a custom envelope to use.
-     */
-    envelope?: string;
-    /**
-     * Body param: Mailing class.
-     */
-    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: A PDF file containing the letter content. Cannot be used with
-     * `template`.
-     */
-    pdf?: string;
-    /**
-     * Body param: Specifies which page number should be perforated (if any).
-     */
-    perforatedPage?: 1;
-    /**
-     * Body param: ID of a return envelope to include.
-     */
-    returnEnvelope?: string;
-    /**
-     * Body param: ID of a template to use for the letter content. Cannot be used with
-     * `pdf`.
-     */
-    template?: string;
-}
-export interface LetterRetrieveParams {
-    /**
-     * Optional list of related resources to expand in the response.
-     */
-    expand?: Array<string>;
-}
-export interface LetterUpdateParams {
-    /**
-     * Query param: Optional list of related resources to expand in the response.
-     */
-    expand?: Array<string>;
-    /**
-     * Body param: Enum representing the placement of the address on the letter.
-     */
-    addressPlacement?: LettersAPI.AddressPlacement;
-    /**
-     * Body param: Model representing an attached PDF.
-     */
-    attachedPDF?: LettersAPI.AttachedPdf;
-    /**
-     * Body param: Specifies whether to print in color (true) or black and white
-     * (false).
-     */
-    color?: boolean;
-    /**
-     * Body param: An optional description for the profile. Set to `null` to remove
-     * during update.
-     */
-    description?: string | null;
-    /**
-     * Body param: Specifies whether to print on both sides of the paper.
-     */
-    doubleSided?: boolean;
-    /**
-     * Body param: ID of a custom envelope to use.
-     */
-    envelope?: string;
-    /**
-     * Body param: Mailing class.
-     */
-    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: A PDF file containing the letter content. Cannot be used with
-     * `template`.
-     */
-    pdf?: string;
-    /**
-     * Body param: Specifies which page number should be perforated (if any).
-     */
-    perforatedPage?: 1;
-    /**
-     * Body param: ID of a return envelope to include.
-     */
-    returnEnvelope?: string;
-    /**
-     * Body param: ID of a template to use for the letter content. Cannot be used with
-     * `pdf`.
-     */
-    template?: string;
-}
-export interface LetterListParams 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 Letters {
-    export { type LetterProfile as LetterProfile, type LetterDeleteResponse as LetterDeleteResponse, type LetterProfilesSkipLimit as LetterProfilesSkipLimit, type LetterCreateParams as LetterCreateParams, type LetterRetrieveParams as LetterRetrieveParams, type LetterUpdateParams as LetterUpdateParams, type LetterListParams as LetterListParams, };
-}
-//# sourceMappingURL=letters.d.mts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"letters.d.mts","sourceRoot":"","sources":["../../../src/resources/print-mail/order-profiles/letters.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,QAAQ;OACb,KAAK,UAAU;OACf,EAAE,UAAU,EAAE;OACd,EAAE,WAAW,EAAE,SAAS,EAAE,KAAK,eAAe,EAAE;OAChD,EAAE,cAAc,EAAE;AAGzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;;;;;OAkBG;IACH,MAAM,CAAC,MAAM,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,aAAa,CAAC;IASvF;;;;;;;;;;OAUG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,aAAa,CAAC;IAI5B;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,aAAa,CAAC;IASnG;;;;;;;;;;;OAWG;IACH,IAAI,CACF,KAAK,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,uBAAuB,EAAE,aAAa,CAAC;IAOtD;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,oBAAoB,CAAC;CAG/E;AAED,MAAM,MAAM,uBAAuB,GAAG,SAAS,CAAC,aAAa,CAAC,CAAC;AAE/D,MAAM,WAAW,aAAa;IAC5B;;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,gBAAgB,CAAC;IAEzB;;OAEG;IACH,IAAI,EAAE,UAAU,CAAC,UAAU,CAAC;IAE5B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,gBAAgB,CAAC,EAAE,UAAU,CAAC,gBAAgB,CAAC;IAE/C;;OAEG;IACH,WAAW,CAAC,EAAE,UAAU,CAAC,WAAW,CAAC;IAErC;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;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,cAAc,CAAC,EAAE,CAAC,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX,OAAO,EAAE,IAAI,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,gBAAgB,CAAC;CAC1B;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,IAAI,EAAE,UAAU,CAAC,UAAU,CAAC;IAE5B;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEvB;;OAEG;IACH,gBAAgB,CAAC,EAAE,UAAU,CAAC,gBAAgB,CAAC;IAE/C;;OAEG;IACH,WAAW,CAAC,EAAE,UAAU,CAAC,WAAW,CAAC;IAErC;;;OAGG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;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,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,cAAc,CAAC,EAAE,CAAC,CAAC;IAEnB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACxB;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEvB;;OAEG;IACH,gBAAgB,CAAC,EAAE,UAAU,CAAC,gBAAgB,CAAC;IAE/C;;OAEG;IACH,WAAW,CAAC,EAAE,UAAU,CAAC,WAAW,CAAC;IAErC;;;OAGG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;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,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,cAAc,CAAC,EAAE,CAAC,CAAC;IAEnB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,gBAAiB,SAAQ,eAAe;IACvD;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;CACH"}

package/resources/print-mail/order-profiles/letters.d.ts

@@ -1,325 +0,0 @@
-import { APIResource } from "../../../core/resource.js";
-import * as BoxesAPI from "../boxes.js";
-import * as LettersAPI from "../letters.js";
-import { APIPromise } from "../../../core/api-promise.js";
-import { PagePromise, SkipLimit, type SkipLimitParams } from "../../../core/pagination.js";
-import { RequestOptions } from "../../../internal/request-options.js";
-export declare class Letters extends APIResource {
-    /**
-     * Creates a new Letter Profile. You must provide either a `template` ID or upload
-     * a `pdf` file for the content. If providing PDF files (`pdf` or
-     * `attachedPDFFile`), the request `Content-Type` must be `multipart/form-data`.
-     *
-     * @example
-     * ```ts
-     * const letterProfile =
-     *   await client.printMail.orderProfiles.letters.create({
-     *     size: 'us_letter',
-     *     color: true,
-     *     description: 'Monthly Newsletter Profile',
-     *     mailingClass: 'first_class',
-     *     mergeVariables: { salutation: 'Valued Customer' },
-     *     metadata: { campaign: 'Q1 Newsletter' },
-     *     template: 'template_abc',
-     *   });
-     * ```
-     */
-    create(params: LetterCreateParams, options?: RequestOptions): APIPromise<LetterProfile>;
-    /**
-     * Retrieves the details of a specific Letter Profile by its ID.
-     *
-     * @example
-     * ```ts
-     * const letterProfile =
-     *   await client.printMail.orderProfiles.letters.retrieve(
-     *     'id',
-     *   );
-     * ```
-     */
-    retrieve(id: string, query?: LetterRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<LetterProfile>;
-    /**
-     * Updates specific fields of an existing Letter Profile. Only the fields provided
-     * in the request body will be updated. If providing PDF files (`pdf` or
-     * `attachedPDFFile`), the request `Content-Type` must be `multipart/form-data`.
-     *
-     * @example
-     * ```ts
-     * const letterProfile =
-     *   await client.printMail.orderProfiles.letters.update(
-     *     'id',
-     *     { description: 'Updated Newsletter Profile' },
-     *   );
-     * ```
-     */
-    update(id: string, params: LetterUpdateParams, options?: RequestOptions): APIPromise<LetterProfile>;
-    /**
-     * Retrieves a list of Letter Profiles. The profiles are returned sorted by
-     * creation date, with the most recent appearing first.
-     *
-     * @example
-     * ```ts
-     * // Automatically fetches more pages as needed.
-     * for await (const letterProfile of client.printMail.orderProfiles.letters.list()) {
-     *   // ...
-     * }
-     * ```
-     */
-    list(query?: LetterListParams | null | undefined, options?: RequestOptions): PagePromise<LetterProfilesSkipLimit, LetterProfile>;
-    /**
-     * Deletes a Letter Profile. This action cannot be undone. Orders previously
-     * created using this profile are not affected.
-     *
-     * @example
-     * ```ts
-     * const letter =
-     *   await client.printMail.orderProfiles.letters.delete('id');
-     * ```
-     */
-    delete(id: string, options?: RequestOptions): APIPromise<LetterDeleteResponse>;
-}
-export type LetterProfilesSkipLimit = SkipLimit<LetterProfile>;
-export interface LetterProfile {
-    /**
-     * 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 `letter_profile`.
-     */
-    object: 'letter_profile';
-    /**
-     * Enum representing the supported letter sizes.
-     */
-    size: LettersAPI.LetterSize;
-    /**
-     * Timestamp when the profile was last updated.
-     */
-    updatedAt: string;
-    /**
-     * Enum representing the placement of the address on the letter.
-     */
-    addressPlacement?: LettersAPI.AddressPlacement;
-    /**
-     * Model representing an attached PDF.
-     */
-    attachedPDF?: LettersAPI.AttachedPdf;
-    /**
-     * Specifies whether to print in color (true) or black and white (false).
-     */
-    color?: boolean;
-    /**
-     * An optional description for the profile. Set to `null` to remove during update.
-     */
-    description?: string | null;
-    /**
-     * Specifies whether to print on both sides of the paper.
-     */
-    doubleSided?: boolean;
-    /**
-     * ID of a custom envelope to use.
-     */
-    envelope?: string;
-    /**
-     * Mailing class.
-     */
-    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;
-    /**
-     * Specifies which page number should be perforated (if any).
-     */
-    perforatedPage?: 1;
-    /**
-     * ID of a template to use for the letter content. Cannot be used with `pdf`.
-     */
-    template?: string;
-    /**
-     * A temporary, signed URL to view the uploaded PDF, if any.
-     */
-    uploadedPDF?: string;
-}
-export interface LetterDeleteResponse {
-    /**
-     * Unique identifier for the order profile.
-     */
-    id: string;
-    deleted: true;
-    /**
-     * Always `letter_profile`.
-     */
-    object: 'letter_profile';
-}
-export interface LetterCreateParams {
-    /**
-     * Body param: Enum representing the supported letter sizes.
-     */
-    size: LettersAPI.LetterSize;
-    /**
-     * Query param: Optional list of related resources to expand in the response.
-     */
-    expand?: Array<string>;
-    /**
-     * Body param: Enum representing the placement of the address on the letter.
-     */
-    addressPlacement?: LettersAPI.AddressPlacement;
-    /**
-     * Body param: Model representing an attached PDF.
-     */
-    attachedPDF?: LettersAPI.AttachedPdf;
-    /**
-     * Body param: Specifies whether to print in color (true) or black and white
-     * (false).
-     */
-    color?: boolean;
-    /**
-     * Body param: An optional description for the profile. Set to `null` to remove
-     * during update.
-     */
-    description?: string | null;
-    /**
-     * Body param: Specifies whether to print on both sides of the paper.
-     */
-    doubleSided?: boolean;
-    /**
-     * Body param: ID of a custom envelope to use.
-     */
-    envelope?: string;
-    /**
-     * Body param: Mailing class.
-     */
-    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: A PDF file containing the letter content. Cannot be used with
-     * `template`.
-     */
-    pdf?: string;
-    /**
-     * Body param: Specifies which page number should be perforated (if any).
-     */
-    perforatedPage?: 1;
-    /**
-     * Body param: ID of a return envelope to include.
-     */
-    returnEnvelope?: string;
-    /**
-     * Body param: ID of a template to use for the letter content. Cannot be used with
-     * `pdf`.
-     */
-    template?: string;
-}
-export interface LetterRetrieveParams {
-    /**
-     * Optional list of related resources to expand in the response.
-     */
-    expand?: Array<string>;
-}
-export interface LetterUpdateParams {
-    /**
-     * Query param: Optional list of related resources to expand in the response.
-     */
-    expand?: Array<string>;
-    /**
-     * Body param: Enum representing the placement of the address on the letter.
-     */
-    addressPlacement?: LettersAPI.AddressPlacement;
-    /**
-     * Body param: Model representing an attached PDF.
-     */
-    attachedPDF?: LettersAPI.AttachedPdf;
-    /**
-     * Body param: Specifies whether to print in color (true) or black and white
-     * (false).
-     */
-    color?: boolean;
-    /**
-     * Body param: An optional description for the profile. Set to `null` to remove
-     * during update.
-     */
-    description?: string | null;
-    /**
-     * Body param: Specifies whether to print on both sides of the paper.
-     */
-    doubleSided?: boolean;
-    /**
-     * Body param: ID of a custom envelope to use.
-     */
-    envelope?: string;
-    /**
-     * Body param: Mailing class.
-     */
-    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: A PDF file containing the letter content. Cannot be used with
-     * `template`.
-     */
-    pdf?: string;
-    /**
-     * Body param: Specifies which page number should be perforated (if any).
-     */
-    perforatedPage?: 1;
-    /**
-     * Body param: ID of a return envelope to include.
-     */
-    returnEnvelope?: string;
-    /**
-     * Body param: ID of a template to use for the letter content. Cannot be used with
-     * `pdf`.
-     */
-    template?: string;
-}
-export interface LetterListParams 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 Letters {
-    export { type LetterProfile as LetterProfile, type LetterDeleteResponse as LetterDeleteResponse, type LetterProfilesSkipLimit as LetterProfilesSkipLimit, type LetterCreateParams as LetterCreateParams, type LetterRetrieveParams as LetterRetrieveParams, type LetterUpdateParams as LetterUpdateParams, type LetterListParams as LetterListParams, };
-}
-//# sourceMappingURL=letters.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"letters.d.ts","sourceRoot":"","sources":["../../../src/resources/print-mail/order-profiles/letters.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,QAAQ;OACb,KAAK,UAAU;OACf,EAAE,UAAU,EAAE;OACd,EAAE,WAAW,EAAE,SAAS,EAAE,KAAK,eAAe,EAAE;OAChD,EAAE,cAAc,EAAE;AAGzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;;;;;OAkBG;IACH,MAAM,CAAC,MAAM,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,aAAa,CAAC;IASvF;;;;;;;;;;OAUG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,aAAa,CAAC;IAI5B;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,aAAa,CAAC;IASnG;;;;;;;;;;;OAWG;IACH,IAAI,CACF,KAAK,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,uBAAuB,EAAE,aAAa,CAAC;IAOtD;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,oBAAoB,CAAC;CAG/E;AAED,MAAM,MAAM,uBAAuB,GAAG,SAAS,CAAC,aAAa,CAAC,CAAC;AAE/D,MAAM,WAAW,aAAa;IAC5B;;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,gBAAgB,CAAC;IAEzB;;OAEG;IACH,IAAI,EAAE,UAAU,CAAC,UAAU,CAAC;IAE5B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,gBAAgB,CAAC,EAAE,UAAU,CAAC,gBAAgB,CAAC;IAE/C;;OAEG;IACH,WAAW,CAAC,EAAE,UAAU,CAAC,WAAW,CAAC;IAErC;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;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,cAAc,CAAC,EAAE,CAAC,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX,OAAO,EAAE,IAAI,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,gBAAgB,CAAC;CAC1B;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,IAAI,EAAE,UAAU,CAAC,UAAU,CAAC;IAE5B;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEvB;;OAEG;IACH,gBAAgB,CAAC,EAAE,UAAU,CAAC,gBAAgB,CAAC;IAE/C;;OAEG;IACH,WAAW,CAAC,EAAE,UAAU,CAAC,WAAW,CAAC;IAErC;;;OAGG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;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,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,cAAc,CAAC,EAAE,CAAC,CAAC;IAEnB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACxB;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEvB;;OAEG;IACH,gBAAgB,CAAC,EAAE,UAAU,CAAC,gBAAgB,CAAC;IAE/C;;OAEG;IACH,WAAW,CAAC,EAAE,UAAU,CAAC,WAAW,CAAC;IAErC;;;OAGG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;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,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,cAAc,CAAC,EAAE,CAAC,CAAC;IAEnB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,gBAAiB,SAAQ,eAAe;IACvD;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;CACH"}