postgrid-node 0.5.0 → 0.6.1

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

@@ -1,404 +0,0 @@
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
-import { APIResource } from '../../../core/resource';
-import { APIPromise } from '../../../core/api-promise';
-import { PagePromise, SkipLimit, type SkipLimitParams } from '../../../core/pagination';
-import { RequestOptions } from '../../../internal/request-options';
-import { path } from '../../../internal/utils/path';
-
-export class Postcards extends APIResource {
-  /**
-   * Creates a new Postcard Profile. Provide either `frontTemplate` and
-   * `backTemplate` IDs, or upload a 2-page `pdf`. If providing a `pdf`, the request
-   * `Content-Type` must be `multipart/form-data`.
-   *
-   * @example
-   * ```ts
-   * const postcardProfile =
-   *   await client.printMail.orderProfiles.postcards.create({
-   *     size: '6x4',
-   *   });
-   * ```
-   */
-  create(params: PostcardCreateParams, options?: RequestOptions): APIPromise<PostcardProfile> {
-    const { expand, ...body } = params;
-    return this._client.post('/print-mail/v1/order_profiles/postcards', {
-      query: { expand },
-      body,
-      ...options,
-    });
-  }
-
-  /**
-   * Retrieves the details of a specific Postcard Profile.
-   *
-   * @example
-   * ```ts
-   * const postcardProfile =
-   *   await client.printMail.orderProfiles.postcards.retrieve(
-   *     'id',
-   *   );
-   * ```
-   */
-  retrieve(
-    id: string,
-    query: PostcardRetrieveParams | null | undefined = {},
-    options?: RequestOptions,
-  ): APIPromise<PostcardProfile> {
-    return this._client.get(path`/print-mail/v1/order_profiles/postcards/${id}`, { query, ...options });
-  }
-
-  /**
-   * Updates specific fields of an existing Postcard Profile. If providing a `pdf`,
-   * the request `Content-Type` must be `multipart/form-data`.
-   *
-   * @example
-   * ```ts
-   * const postcardProfile =
-   *   await client.printMail.orderProfiles.postcards.update(
-   *     'id',
-   *   );
-   * ```
-   */
-  update(id: string, params: PostcardUpdateParams, options?: RequestOptions): APIPromise<PostcardProfile> {
-    const { expand, ...body } = params;
-    return this._client.post(path`/print-mail/v1/order_profiles/postcards/${id}`, {
-      query: { expand },
-      body,
-      ...options,
-    });
-  }
-
-  /**
-   * Retrieves a list of Postcard Profiles.
-   *
-   * @example
-   * ```ts
-   * // Automatically fetches more pages as needed.
-   * for await (const postcardProfile of client.printMail.orderProfiles.postcards.list()) {
-   *   // ...
-   * }
-   * ```
-   */
-  list(
-    query: PostcardListParams | null | undefined = {},
-    options?: RequestOptions,
-  ): PagePromise<PostcardProfilesSkipLimit, PostcardProfile> {
-    return this._client.getAPIList('/print-mail/v1/order_profiles/postcards', SkipLimit<PostcardProfile>, {
-      query,
-      ...options,
-    });
-  }
-
-  /**
-   * Deletes a Postcard Profile.
-   *
-   * @example
-   * ```ts
-   * const postcard =
-   *   await client.printMail.orderProfiles.postcards.delete(
-   *     'id',
-   *   );
-   * ```
-   */
-  delete(id: string, options?: RequestOptions): APIPromise<PostcardDeleteResponse> {
-    return this._client.delete(path`/print-mail/v1/order_profiles/postcards/${id}`, options);
-  }
-}
-
-export type PostcardProfilesSkipLimit = SkipLimit<PostcardProfile>;
-
-export interface PostcardProfile {
-  /**
-   * 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 `postcard_profile`.
-   */
-  object: 'postcard_profile';
-
-  /**
-   * Enum representing the supported postcard sizes.
-   */
-  size: PostcardSize;
-
-  /**
-   * Timestamp when the profile was last updated.
-   */
-  updatedAt: string;
-
-  /**
-   * ID of the template for the back side. Required unless `pdf` is provided.
-   */
-  backTemplate?: string;
-
-  /**
-   * An optional description for the profile. Set to `null` to remove during update.
-   */
-  description?: string | null;
-
-  /**
-   * ID of the template for the front side. Required unless `pdf` is provided.
-   */
-  frontTemplate?: string;
-
-  /**
-   * Mailing class (cannot include extra services like `certified` or `registered`
-   * for postcards, though).
-   */
-  mailingClass?:
-    | 'first_class'
-    | 'standard_class'
-    | 'express'
-    | 'certified'
-    | 'certified_return_receipt'
-    | 'registered'
-    | 'usps_first_class'
-    | 'usps_standard_class'
-    | 'usps_eddm'
-    | 'usps_express_2_day'
-    | 'usps_express_3_day'
-    | 'usps_first_class_certified'
-    | 'usps_first_class_certified_return_receipt'
-    | 'usps_first_class_registered'
-    | 'usps_express_3_day_signature_confirmation'
-    | 'usps_express_3_day_certified'
-    | 'usps_express_3_day_certified_return_receipt'
-    | 'ca_post_lettermail'
-    | 'ca_post_personalized'
-    | 'ca_post_neighbourhood_mail'
-    | 'ups_express_overnight'
-    | 'ups_express_2_day'
-    | 'ups_express_3_day'
-    | 'royal_mail_first_class'
-    | 'royal_mail_second_class'
-    | 'au_post_second_class';
-
-  /**
-   * Default merge variables for orders created using this profile.
-   */
-  mergeVariables?: { [key: string]: unknown } | null;
-
-  /**
-   * Optional key-value metadata.
-   */
-  metadata?: { [key: string]: string } | null;
-
-  /**
-   * A temporary, signed URL to view the uploaded PDF content, if any.
-   */
-  uploadedPDF?: string;
-}
-
-/**
- * Enum representing the supported postcard sizes.
- */
-export type PostcardSize = '6x4' | '9x6' | '11x6';
-
-export interface PostcardDeleteResponse {
-  /**
-   * Unique identifier for the order profile.
-   */
-  id: string;
-
-  deleted: true;
-
-  /**
-   * Always `postcard_profile`.
-   */
-  object: 'postcard_profile';
-}
-
-export interface PostcardCreateParams {
-  /**
-   * Body param: Enum representing the supported postcard sizes.
-   */
-  size: PostcardSize;
-
-  /**
-   * Query param: Optional list of related resources to expand in the response.
-   */
-  expand?: Array<string>;
-
-  /**
-   * Body param: ID of the template for the back side. Required unless `pdf` is
-   * provided.
-   */
-  backTemplate?: 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 front side. Required unless `pdf` is
-   * provided.
-   */
-  frontTemplate?: string;
-
-  /**
-   * Body param: Mailing class (cannot include extra services like `certified` or
-   * `registered` for postcards, though).
-   */
-  mailingClass?:
-    | 'first_class'
-    | 'standard_class'
-    | 'express'
-    | 'certified'
-    | 'certified_return_receipt'
-    | 'registered'
-    | 'usps_first_class'
-    | 'usps_standard_class'
-    | 'usps_eddm'
-    | 'usps_express_2_day'
-    | 'usps_express_3_day'
-    | 'usps_first_class_certified'
-    | 'usps_first_class_certified_return_receipt'
-    | 'usps_first_class_registered'
-    | 'usps_express_3_day_signature_confirmation'
-    | 'usps_express_3_day_certified'
-    | 'usps_express_3_day_certified_return_receipt'
-    | 'ca_post_lettermail'
-    | 'ca_post_personalized'
-    | 'ca_post_neighbourhood_mail'
-    | 'ups_express_overnight'
-    | 'ups_express_2_day'
-    | 'ups_express_3_day'
-    | 'royal_mail_first_class'
-    | 'royal_mail_second_class'
-    | 'au_post_second_class';
-
-  /**
-   * 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 2-page PDF file containing the postcard content (front and back).
-   * Cannot be used with `frontTemplate`/`backTemplate`.
-   */
-  pdf?: string;
-}
-
-export interface PostcardRetrieveParams {
-  /**
-   * Optional list of related resources to expand in the response.
-   */
-  expand?: Array<string>;
-}
-
-export interface PostcardUpdateParams {
-  /**
-   * Query param: Optional list of related resources to expand in the response.
-   */
-  expand?: Array<string>;
-
-  /**
-   * Body param: ID of the template for the back side. Required unless `pdf` is
-   * provided.
-   */
-  backTemplate?: 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 front side. Required unless `pdf` is
-   * provided.
-   */
-  frontTemplate?: string;
-
-  /**
-   * Body param: Mailing class (cannot include extra services like `certified` or
-   * `registered` for postcards, though).
-   */
-  mailingClass?:
-    | 'first_class'
-    | 'standard_class'
-    | 'express'
-    | 'certified'
-    | 'certified_return_receipt'
-    | 'registered'
-    | 'usps_first_class'
-    | 'usps_standard_class'
-    | 'usps_eddm'
-    | 'usps_express_2_day'
-    | 'usps_express_3_day'
-    | 'usps_first_class_certified'
-    | 'usps_first_class_certified_return_receipt'
-    | 'usps_first_class_registered'
-    | 'usps_express_3_day_signature_confirmation'
-    | 'usps_express_3_day_certified'
-    | 'usps_express_3_day_certified_return_receipt'
-    | 'ca_post_lettermail'
-    | 'ca_post_personalized'
-    | 'ca_post_neighbourhood_mail'
-    | 'ups_express_overnight'
-    | 'ups_express_2_day'
-    | 'ups_express_3_day'
-    | 'royal_mail_first_class'
-    | 'royal_mail_second_class'
-    | 'au_post_second_class';
-
-  /**
-   * 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 2-page PDF file containing the postcard content (front and back).
-   * Cannot be used with `frontTemplate`/`backTemplate`.
-   */
-  pdf?: string;
-}
-
-export interface PostcardListParams 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 Postcards {
-  export {
-    type PostcardProfile as PostcardProfile,
-    type PostcardSize as PostcardSize,
-    type PostcardDeleteResponse as PostcardDeleteResponse,
-    type PostcardProfilesSkipLimit as PostcardProfilesSkipLimit,
-    type PostcardCreateParams as PostcardCreateParams,
-    type PostcardRetrieveParams as PostcardRetrieveParams,
-    type PostcardUpdateParams as PostcardUpdateParams,
-    type PostcardListParams as PostcardListParams,
-  };
-}