postgrid-node 0.1.0-alpha.5 → 0.3.0

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

@@ -0,0 +1,423 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import * as BoxesAPI from '../boxes';
+import * as LettersAPI from '../letters';
+import { APIPromise } from '../../../core/api-promise';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
+
+export 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> {
+    const { expand, ...body } = params;
+    return this._client.post('/print-mail/v1/order_profiles/letters', {
+      query: { expand },
+      body,
+      ...options,
+    });
+  }
+
+  /**
+   * 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> {
+    return this._client.get(path`/print-mail/v1/order_profiles/letters/${id}`, { query, ...options });
+  }
+
+  /**
+   * 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> {
+    const { expand, ...body } = params;
+    return this._client.post(path`/print-mail/v1/order_profiles/letters/${id}`, {
+      query: { expand },
+      body,
+      ...options,
+    });
+  }
+
+  /**
+   * Retrieves a list of Letter Profiles. The profiles are returned sorted by
+   * creation date, with the most recent appearing first.
+   *
+   * @example
+   * ```ts
+   * const letters =
+   *   await client.printMail.orderProfiles.letters.list();
+   * ```
+   */
+  list(
+    query: LetterListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<LetterListResponse> {
+    return this._client.get('/print-mail/v1/order_profiles/letters', { query, ...options });
+  }
+
+  /**
+   * 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> {
+    return this._client.delete(path`/print-mail/v1/order_profiles/letters/${id}`, options);
+  }
+}
+
+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;
+}
+
+/**
+ * Represents a list of Letter Profiles.
+ */
+export interface LetterListResponse {
+  data: Array<LetterProfile>;
+
+  limit: number;
+
+  object: 'list';
+
+  skip: number;
+
+  totalCount: number;
+}
+
+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 {
+  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 Letters {
+  export {
+    type LetterProfile as LetterProfile,
+    type LetterListResponse as LetterListResponse,
+    type LetterDeleteResponse as LetterDeleteResponse,
+    type LetterCreateParams as LetterCreateParams,
+    type LetterRetrieveParams as LetterRetrieveParams,
+    type LetterUpdateParams as LetterUpdateParams,
+    type LetterListParams as LetterListParams,
+  };
+}

package/src/resources/print-mail/order-profiles/order-profiles.ts

@@ -0,0 +1,111 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import * as ChequesAPI from './cheques';
+import {
+  ChequeCreateParams,
+  ChequeDeleteResponse,
+  ChequeListParams,
+  ChequeListResponse,
+  ChequeProfile,
+  ChequeRetrieveParams,
+  ChequeUpdateParams,
+  Cheques,
+  CurrencyCode,
+} from './cheques';
+import * as LettersAPI from './letters';
+import {
+  LetterCreateParams,
+  LetterDeleteResponse,
+  LetterListParams,
+  LetterListResponse,
+  LetterProfile,
+  LetterRetrieveParams,
+  LetterUpdateParams,
+  Letters,
+} from './letters';
+import * as PostcardsAPI from './postcards';
+import {
+  PostcardCreateParams,
+  PostcardDeleteResponse,
+  PostcardListParams,
+  PostcardListResponse,
+  PostcardProfile,
+  PostcardRetrieveParams,
+  PostcardSize,
+  PostcardUpdateParams,
+  Postcards,
+} from './postcards';
+import * as SelfMailersAPI from './self-mailers';
+import {
+  SelfMailerCreateParams,
+  SelfMailerDeleteResponse,
+  SelfMailerListParams,
+  SelfMailerListResponse,
+  SelfMailerProfile,
+  SelfMailerRetrieveParams,
+  SelfMailerSize,
+  SelfMailerUpdateParams,
+  SelfMailers,
+} from './self-mailers';
+
+export class OrderProfiles extends APIResource {
+  cheques: ChequesAPI.Cheques = new ChequesAPI.Cheques(this._client);
+  letters: LettersAPI.Letters = new LettersAPI.Letters(this._client);
+  postcards: PostcardsAPI.Postcards = new PostcardsAPI.Postcards(this._client);
+  selfMailers: SelfMailersAPI.SelfMailers = new SelfMailersAPI.SelfMailers(this._client);
+}
+
+OrderProfiles.Cheques = Cheques;
+OrderProfiles.Letters = Letters;
+OrderProfiles.Postcards = Postcards;
+OrderProfiles.SelfMailers = SelfMailers;
+
+export declare namespace OrderProfiles {
+  export {
+    Cheques as Cheques,
+    type ChequeProfile as ChequeProfile,
+    type CurrencyCode as CurrencyCode,
+    type ChequeListResponse as ChequeListResponse,
+    type ChequeDeleteResponse as ChequeDeleteResponse,
+    type ChequeCreateParams as ChequeCreateParams,
+    type ChequeRetrieveParams as ChequeRetrieveParams,
+    type ChequeUpdateParams as ChequeUpdateParams,
+    type ChequeListParams as ChequeListParams,
+  };
+
+  export {
+    Letters as Letters,
+    type LetterProfile as LetterProfile,
+    type LetterListResponse as LetterListResponse,
+    type LetterDeleteResponse as LetterDeleteResponse,
+    type LetterCreateParams as LetterCreateParams,
+    type LetterRetrieveParams as LetterRetrieveParams,
+    type LetterUpdateParams as LetterUpdateParams,
+    type LetterListParams as LetterListParams,
+  };
+
+  export {
+    Postcards as Postcards,
+    type PostcardProfile as PostcardProfile,
+    type PostcardSize as PostcardSize,
+    type PostcardListResponse as PostcardListResponse,
+    type PostcardDeleteResponse as PostcardDeleteResponse,
+    type PostcardCreateParams as PostcardCreateParams,
+    type PostcardRetrieveParams as PostcardRetrieveParams,
+    type PostcardUpdateParams as PostcardUpdateParams,
+    type PostcardListParams as PostcardListParams,
+  };
+
+  export {
+    SelfMailers as SelfMailers,
+    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,
+  };
+}