postgrid-node 0.5.0 → 0.6.1

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

@@ -1,589 +0,0 @@
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
-import { APIResource } from '../../../core/resource';
-import * as ChequesAPI from '../cheques';
-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 Cheques extends APIResource {
-  /**
-   * Creates a new Cheque Profile. Requires a `bankAccount` ID. Can optionally
-   * include an attached letter via `letterHTML`, `letterTemplate`, or `letterPDF`.
-   * If providing `letterPDF` or `logo` (if logo needs upload, though schema suggests
-   * URL), use `multipart/form-data`.
-   *
-   * @example
-   * ```ts
-   * const chequeProfile =
-   *   await client.printMail.orderProfiles.cheques.create({
-   *     bankAccount: 'bankAccount',
-   *     size: 'us_letter',
-   *   });
-   * ```
-   */
-  create(params: ChequeCreateParams, options?: RequestOptions): APIPromise<ChequeProfile> {
-    const { expand, ...body } = params;
-    return this._client.post('/print-mail/v1/order_profiles/cheques', {
-      query: { expand },
-      body,
-      ...options,
-    });
-  }
-
-  /**
-   * Retrieves the details of a specific Cheque Profile.
-   *
-   * @example
-   * ```ts
-   * const chequeProfile =
-   *   await client.printMail.orderProfiles.cheques.retrieve(
-   *     'id',
-   *   );
-   * ```
-   */
-  retrieve(
-    id: string,
-    query: ChequeRetrieveParams | null | undefined = {},
-    options?: RequestOptions,
-  ): APIPromise<ChequeProfile> {
-    return this._client.get(path`/print-mail/v1/order_profiles/cheques/${id}`, { query, ...options });
-  }
-
-  /**
-   * Updates specific fields of an existing Cheque Profile. If providing `letterPDF`
-   * or `logo`, use `multipart/form-data`.
-   *
-   * @example
-   * ```ts
-   * const chequeProfile =
-   *   await client.printMail.orderProfiles.cheques.update(
-   *     'id',
-   *     { bankAccount: 'bankAccount', size: 'us_letter' },
-   *   );
-   * ```
-   */
-  update(id: string, params: ChequeUpdateParams, options?: RequestOptions): APIPromise<ChequeProfile> {
-    const { expand, ...body } = params;
-    return this._client.post(path`/print-mail/v1/order_profiles/cheques/${id}`, {
-      query: { expand },
-      body,
-      ...options,
-    });
-  }
-
-  /**
-   * Retrieves a list of Cheque Profiles.
-   *
-   * @example
-   * ```ts
-   * // Automatically fetches more pages as needed.
-   * for await (const chequeListResponse of client.printMail.orderProfiles.cheques.list()) {
-   *   // ...
-   * }
-   * ```
-   */
-  list(
-    query: ChequeListParams | null | undefined = {},
-    options?: RequestOptions,
-  ): PagePromise<ChequeListResponsesSkipLimit, ChequeListResponse> {
-    return this._client.getAPIList('/print-mail/v1/order_profiles/cheques', SkipLimit<ChequeListResponse>, {
-      query,
-      ...options,
-    });
-  }
-
-  /**
-   * Deletes a Cheque Profile.
-   *
-   * @example
-   * ```ts
-   * const cheque =
-   *   await client.printMail.orderProfiles.cheques.delete('id');
-   * ```
-   */
-  delete(id: string, options?: RequestOptions): APIPromise<ChequeDeleteResponse> {
-    return this._client.delete(path`/print-mail/v1/order_profiles/cheques/${id}`, options);
-  }
-}
-
-export type ChequeListResponsesSkipLimit = SkipLimit<ChequeListResponse>;
-
-export interface ChequeProfile {
-  /**
-   * Unique identifier for the order profile.
-   */
-  id: string;
-
-  /**
-   * ID of the bank account to use for the cheque. Required for creation.
-   */
-  bankAccount: string;
-
-  /**
-   * Timestamp when the profile was created.
-   */
-  createdAt: string;
-
-  /**
-   * Enum representing the supported currency codes.
-   */
-  currencyCode: CurrencyCode;
-
-  /**
-   * Indicates if the profile is associated with the live or test environment.
-   */
-  live: boolean;
-
-  /**
-   * Always `cheque_profile`.
-   */
-  object: 'cheque_profile';
-
-  /**
-   * Enum representing the supported cheque sizes.
-   */
-  size: ChequesAPI.ChequeSize;
-
-  /**
-   * 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 a template for an optional attached letter. Cannot be used with
-   * `letterHTML` or `letterPDF`.
-   */
-  letterTemplate?: string;
-
-  /**
-   * A temporary, signed URL to view the attached letter PDF, if any. Output only.
-   */
-  letterUploadedPDF?: string;
-
-  /**
-   * A publicly accessible URL for the logo to print on the cheque. Set to `null` to
-   * remove during update.
-   */
-  logo?: string | null;
-
-  /**
-   * Mailing class. Generally must be first class (or equivalent for destination
-   * country) for cheques.
-   */
-  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';
-
-  /**
-   * Memo line text for the cheque. Set to `null` to remove during update.
-   */
-  memo?: string | null;
-
-  /**
-   * Default merge variables for orders created using this profile.
-   */
-  mergeVariables?: { [key: string]: unknown } | null;
-
-  /**
-   * Message included on the cheque stub. Set to `null` to remove during update.
-   */
-  message?: string | null;
-
-  /**
-   * Optional key-value metadata.
-   */
-  metadata?: { [key: string]: string } | null;
-}
-
-/**
- * Enum representing the supported currency codes.
- */
-export type CurrencyCode = 'CAD' | 'USD';
-
-export interface ChequeListResponse {
-  /**
-   * Unique identifier for the order profile.
-   */
-  id: string;
-
-  /**
-   * ID of the bank account to use for the cheque. Required for creation.
-   */
-  bankAccount: string;
-
-  /**
-   * Timestamp when the profile was created.
-   */
-  createdAt: string;
-
-  /**
-   * Indicates if the profile is associated with the live or test environment.
-   */
-  live: boolean;
-
-  /**
-   * Always `cheque_profile`.
-   */
-  object: 'cheque_profile';
-
-  /**
-   * Enum representing the supported cheque sizes.
-   */
-  size: ChequesAPI.ChequeSize;
-
-  /**
-   * 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 a template for an optional attached letter. Cannot be used with
-   * `letterHTML` or `letterPDF`.
-   */
-  letterTemplate?: string;
-
-  /**
-   * A temporary, signed URL to view the attached letter PDF, if any. Output only.
-   */
-  letterUploadedPDF?: string;
-
-  /**
-   * A publicly accessible URL for the logo to print on the cheque. Set to `null` to
-   * remove during update.
-   */
-  logo?: string | null;
-
-  /**
-   * Mailing class. Generally must be first class (or equivalent for destination
-   * country) for cheques.
-   */
-  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';
-
-  /**
-   * Memo line text for the cheque. Set to `null` to remove during update.
-   */
-  memo?: string | null;
-
-  /**
-   * Default merge variables for orders created using this profile.
-   */
-  mergeVariables?: { [key: string]: unknown } | null;
-
-  /**
-   * Message included on the cheque stub. Set to `null` to remove during update.
-   */
-  message?: string | null;
-
-  /**
-   * Optional key-value metadata.
-   */
-  metadata?: { [key: string]: string } | null;
-}
-
-export interface ChequeDeleteResponse {
-  /**
-   * Unique identifier for the order profile.
-   */
-  id: string;
-
-  deleted: true;
-
-  /**
-   * Always `cheque_profile`.
-   */
-  object: 'cheque_profile';
-}
-
-export interface ChequeCreateParams {
-  /**
-   * Body param: ID of the bank account to use for the cheque. Required for creation.
-   */
-  bankAccount: string;
-
-  /**
-   * Body param: Enum representing the supported cheque sizes.
-   */
-  size: ChequesAPI.ChequeSize;
-
-  /**
-   * Query param: Optional list of related resources to expand in the response.
-   */
-  expand?: Array<string>;
-
-  /**
-   * Body param: Enum representing the supported currency codes.
-   */
-  currencyCode?: CurrencyCode;
-
-  /**
-   * Body param: An optional description for the profile. Set to `null` to remove
-   * during update.
-   */
-  description?: string | null;
-
-  /**
-   * Body param: PDF file for an optional attached letter. Cannot be used with
-   * `letterHTML` or `letterTemplate`. Input only.
-   */
-  letterPDF?: string;
-
-  /**
-   * Body param: ID of a template for an optional attached letter. Cannot be used
-   * with `letterHTML` or `letterPDF`.
-   */
-  letterTemplate?: string;
-
-  /**
-   * Body param: A publicly accessible URL for the logo to print on the cheque. Set
-   * to `null` to remove during update.
-   */
-  logo?: string | null;
-
-  /**
-   * Body param: Mailing class. Generally must be first class (or equivalent for
-   * destination country) for cheques.
-   */
-  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: Memo line text for the cheque. Set to `null` to remove during
-   * update.
-   */
-  memo?: string | null;
-
-  /**
-   * Body param: Default merge variables for orders created using this profile.
-   */
-  mergeVariables?: { [key: string]: unknown } | null;
-
-  /**
-   * Body param: Message included on the cheque stub. Set to `null` to remove during
-   * update.
-   */
-  message?: string | null;
-
-  /**
-   * Body param: Optional key-value metadata.
-   */
-  metadata?: { [key: string]: string } | null;
-}
-
-export interface ChequeRetrieveParams {
-  /**
-   * Optional list of related resources to expand in the response.
-   */
-  expand?: Array<string>;
-}
-
-export interface ChequeUpdateParams {
-  /**
-   * Body param: ID of the bank account to use for the cheque. Required for creation.
-   */
-  bankAccount: string;
-
-  /**
-   * Body param: Enum representing the supported cheque sizes.
-   */
-  size: ChequesAPI.ChequeSize;
-
-  /**
-   * Query param: Optional list of related resources to expand in the response.
-   */
-  expand?: Array<string>;
-
-  /**
-   * Body param: Enum representing the supported currency codes.
-   */
-  currencyCode?: CurrencyCode;
-
-  /**
-   * Body param: An optional description for the profile. Set to `null` to remove
-   * during update.
-   */
-  description?: string | null;
-
-  /**
-   * Body param: PDF file for an optional attached letter. Cannot be used with
-   * `letterHTML` or `letterTemplate`. Input only.
-   */
-  letterPDF?: string;
-
-  /**
-   * Body param: ID of a template for an optional attached letter. Cannot be used
-   * with `letterHTML` or `letterPDF`.
-   */
-  letterTemplate?: string;
-
-  /**
-   * Body param: A publicly accessible URL for the logo to print on the cheque. Set
-   * to `null` to remove during update.
-   */
-  logo?: string | null;
-
-  /**
-   * Body param: Mailing class. Generally must be first class (or equivalent for
-   * destination country) for cheques.
-   */
-  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: Memo line text for the cheque. Set to `null` to remove during
-   * update.
-   */
-  memo?: string | null;
-
-  /**
-   * Body param: Default merge variables for orders created using this profile.
-   */
-  mergeVariables?: { [key: string]: unknown } | null;
-
-  /**
-   * Body param: Message included on the cheque stub. Set to `null` to remove during
-   * update.
-   */
-  message?: string | null;
-
-  /**
-   * Body param: Optional key-value metadata.
-   */
-  metadata?: { [key: string]: string } | null;
-}
-
-export interface ChequeListParams 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 Cheques {
-  export {
-    type ChequeProfile as ChequeProfile,
-    type CurrencyCode as CurrencyCode,
-    type ChequeListResponse as ChequeListResponse,
-    type ChequeDeleteResponse as ChequeDeleteResponse,
-    type ChequeListResponsesSkipLimit as ChequeListResponsesSkipLimit,
-    type ChequeCreateParams as ChequeCreateParams,
-    type ChequeRetrieveParams as ChequeRetrieveParams,
-    type ChequeUpdateParams as ChequeUpdateParams,
-    type ChequeListParams as ChequeListParams,
-  };
-}

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

@@ -1,47 +0,0 @@
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
-export {
-  Cheques,
-  type ChequeProfile,
-  type CurrencyCode,
-  type ChequeListResponse,
-  type ChequeDeleteResponse,
-  type ChequeCreateParams,
-  type ChequeRetrieveParams,
-  type ChequeUpdateParams,
-  type ChequeListParams,
-  type ChequeListResponsesSkipLimit,
-} from './cheques';
-export {
-  Letters,
-  type LetterProfile,
-  type LetterDeleteResponse,
-  type LetterCreateParams,
-  type LetterRetrieveParams,
-  type LetterUpdateParams,
-  type LetterListParams,
-  type LetterProfilesSkipLimit,
-} from './letters';
-export { OrderProfiles } from './order-profiles';
-export {
-  Postcards,
-  type PostcardProfile,
-  type PostcardSize,
-  type PostcardDeleteResponse,
-  type PostcardCreateParams,
-  type PostcardRetrieveParams,
-  type PostcardUpdateParams,
-  type PostcardListParams,
-  type PostcardProfilesSkipLimit,
-} from './postcards';
-export {
-  SelfMailers,
-  type SelfMailerProfile,
-  type SelfMailerSize,
-  type SelfMailerDeleteResponse,
-  type SelfMailerCreateParams,
-  type SelfMailerRetrieveParams,
-  type SelfMailerUpdateParams,
-  type SelfMailerListParams,
-  type SelfMailerProfilesSkipLimit,
-} from './self-mailers';