postgrid-node 0.1.0-alpha.5 → 0.2.0

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

@@ -0,0 +1,331 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as BankAccountsAPI from './bank-accounts';
+import {
+  BankAccount,
+  BankAccountCountryCode,
+  BankAccountCreateParams,
+  BankAccountDeleteResponse,
+  BankAccountListParams,
+  BankAccountListResponse,
+  BankAccounts,
+} from './bank-accounts';
+import * as BoxesAPI from './boxes';
+import {
+  Box,
+  BoxChequeBase,
+  BoxCreateParams,
+  BoxListParams,
+  BoxListResponse,
+  Boxes,
+  Cancellation,
+  OrderImbStatus,
+  OrderMailingClass,
+  OrderStatus,
+} from './boxes';
+import * as CampaignsAPI from './campaigns';
+import {
+  Campaign,
+  CampaignCreateParams,
+  CampaignDeleteResponse,
+  CampaignListParams,
+  CampaignListResponse,
+  CampaignSendParams,
+  CampaignUpdateParams,
+  Campaigns,
+} from './campaigns';
+import * as ChequesAPI from './cheques';
+import {
+  Cheque,
+  ChequeCreateParams,
+  ChequeListParams,
+  ChequeListResponse,
+  ChequeRetrieveURLResponse,
+  ChequeSize,
+  Cheques,
+  DigitalOnly,
+} from './cheques';
+import * as ContactsAPI from './contacts';
+import {
+  Contact,
+  ContactCreate,
+  ContactCreateParams,
+  ContactDeleteResponse,
+  ContactListParams,
+  ContactListResponse,
+  Contacts,
+} from './contacts';
+import * as LettersAPI from './letters';
+import {
+  AddressPlacement,
+  AttachedPdf,
+  Letter,
+  LetterCreateParams,
+  LetterListParams,
+  LetterListResponse,
+  LetterRetrieveURLResponse,
+  LetterSize,
+  Letters,
+  PlasticCard,
+} from './letters';
+import * as MailingListImportsAPI from './mailing-list-imports';
+import {
+  FileType,
+  MailingListImportCreateParams,
+  MailingListImportDeleteResponse,
+  MailingListImportListParams,
+  MailingListImportListResponse,
+  MailingListImportResponse,
+  MailingListImportUpdateParams,
+  MailingListImports,
+  VerificationStatusCount,
+} from './mailing-list-imports';
+import * as MailingListsAPI from './mailing-lists';
+import {
+  MailingList,
+  MailingListCreateParams,
+  MailingListDeleteResponse,
+  MailingListJobsParams,
+  MailingListListParams,
+  MailingListListResponse,
+  MailingListUpdate,
+  MailingListUpdateParams,
+  MailingLists,
+} from './mailing-lists';
+import * as PostcardsAPI from './postcards';
+import {
+  Postcard,
+  PostcardCreateParams,
+  PostcardListParams,
+  PostcardListResponse,
+  PostcardRetrieveURLResponse,
+  Postcards,
+} from './postcards';
+import * as SelfMailersAPI from './self-mailers';
+import {
+  SelfMailer,
+  SelfMailerCreateParams,
+  SelfMailerListParams,
+  SelfMailerListResponse,
+  SelfMailerRetrieveURLResponse,
+  SelfMailers,
+} from './self-mailers';
+import * as SubOrganizationsAPI from './sub-organizations';
+import {
+  EmailPreferences,
+  SubOrganization,
+  SubOrganizationListParams,
+  SubOrganizationListResponse,
+  SubOrganizationRetrieveUsersParams,
+  SubOrganizationRetrieveUsersResponse,
+  SubOrganizationUpdateParams,
+  SubOrganizationUpdateResponse,
+  SubOrganizations,
+} from './sub-organizations';
+import * as TemplatesAPI from './templates';
+import {
+  Template,
+  TemplateCreateParams,
+  TemplateDeleteResponse,
+  TemplateListParams,
+  TemplateListResponse,
+  TemplateUpdateParams,
+  Templates,
+} from './templates';
+import * as OrderProfilesAPI from './order-profiles/order-profiles';
+import { OrderProfiles } from './order-profiles/order-profiles';
+import * as ReportsAPI from './reports/reports';
+import {
+  DeletedResponse,
+  Report,
+  ReportCreateParams,
+  ReportListParams,
+  ReportListResponse,
+  ReportSampleParams,
+  ReportUpdateParams,
+  Reports,
+} from './reports/reports';
+
+export class PrintMail extends APIResource {
+  bankAccounts: BankAccountsAPI.BankAccounts = new BankAccountsAPI.BankAccounts(this._client);
+  boxes: BoxesAPI.Boxes = new BoxesAPI.Boxes(this._client);
+  campaigns: CampaignsAPI.Campaigns = new CampaignsAPI.Campaigns(this._client);
+  cheques: ChequesAPI.Cheques = new ChequesAPI.Cheques(this._client);
+  contacts: ContactsAPI.Contacts = new ContactsAPI.Contacts(this._client);
+  letters: LettersAPI.Letters = new LettersAPI.Letters(this._client);
+  mailingListImports: MailingListImportsAPI.MailingListImports = new MailingListImportsAPI.MailingListImports(
+    this._client,
+  );
+  mailingLists: MailingListsAPI.MailingLists = new MailingListsAPI.MailingLists(this._client);
+  orderProfiles: OrderProfilesAPI.OrderProfiles = new OrderProfilesAPI.OrderProfiles(this._client);
+  postcards: PostcardsAPI.Postcards = new PostcardsAPI.Postcards(this._client);
+  reports: ReportsAPI.Reports = new ReportsAPI.Reports(this._client);
+  selfMailers: SelfMailersAPI.SelfMailers = new SelfMailersAPI.SelfMailers(this._client);
+  subOrganizations: SubOrganizationsAPI.SubOrganizations = new SubOrganizationsAPI.SubOrganizations(
+    this._client,
+  );
+  templates: TemplatesAPI.Templates = new TemplatesAPI.Templates(this._client);
+}
+
+PrintMail.BankAccounts = BankAccounts;
+PrintMail.Boxes = Boxes;
+PrintMail.Campaigns = Campaigns;
+PrintMail.Cheques = Cheques;
+PrintMail.Contacts = Contacts;
+PrintMail.Letters = Letters;
+PrintMail.MailingListImports = MailingListImports;
+PrintMail.MailingLists = MailingLists;
+PrintMail.OrderProfiles = OrderProfiles;
+PrintMail.Postcards = Postcards;
+PrintMail.Reports = Reports;
+PrintMail.SelfMailers = SelfMailers;
+PrintMail.SubOrganizations = SubOrganizations;
+PrintMail.Templates = Templates;
+
+export declare namespace PrintMail {
+  export {
+    BankAccounts as BankAccounts,
+    type BankAccount as BankAccount,
+    type BankAccountCountryCode as BankAccountCountryCode,
+    type BankAccountListResponse as BankAccountListResponse,
+    type BankAccountDeleteResponse as BankAccountDeleteResponse,
+    type BankAccountCreateParams as BankAccountCreateParams,
+    type BankAccountListParams as BankAccountListParams,
+  };
+
+  export {
+    Boxes as Boxes,
+    type Box as Box,
+    type BoxChequeBase as BoxChequeBase,
+    type Cancellation as Cancellation,
+    type OrderImbStatus as OrderImbStatus,
+    type OrderMailingClass as OrderMailingClass,
+    type OrderStatus as OrderStatus,
+    type BoxListResponse as BoxListResponse,
+    type BoxCreateParams as BoxCreateParams,
+    type BoxListParams as BoxListParams,
+  };
+
+  export {
+    Campaigns as Campaigns,
+    type Campaign as Campaign,
+    type CampaignListResponse as CampaignListResponse,
+    type CampaignDeleteResponse as CampaignDeleteResponse,
+    type CampaignCreateParams as CampaignCreateParams,
+    type CampaignUpdateParams as CampaignUpdateParams,
+    type CampaignListParams as CampaignListParams,
+    type CampaignSendParams as CampaignSendParams,
+  };
+
+  export {
+    Cheques as Cheques,
+    type Cheque as Cheque,
+    type ChequeSize as ChequeSize,
+    type DigitalOnly as DigitalOnly,
+    type ChequeListResponse as ChequeListResponse,
+    type ChequeRetrieveURLResponse as ChequeRetrieveURLResponse,
+    type ChequeCreateParams as ChequeCreateParams,
+    type ChequeListParams as ChequeListParams,
+  };
+
+  export {
+    Contacts as Contacts,
+    type Contact as Contact,
+    type ContactCreate as ContactCreate,
+    type ContactListResponse as ContactListResponse,
+    type ContactDeleteResponse as ContactDeleteResponse,
+    type ContactCreateParams as ContactCreateParams,
+    type ContactListParams as ContactListParams,
+  };
+
+  export {
+    Letters as Letters,
+    type AddressPlacement as AddressPlacement,
+    type AttachedPdf as AttachedPdf,
+    type Letter as Letter,
+    type LetterSize as LetterSize,
+    type PlasticCard as PlasticCard,
+    type LetterListResponse as LetterListResponse,
+    type LetterRetrieveURLResponse as LetterRetrieveURLResponse,
+    type LetterCreateParams as LetterCreateParams,
+    type LetterListParams as LetterListParams,
+  };
+
+  export {
+    MailingListImports as MailingListImports,
+    type FileType as FileType,
+    type MailingListImportResponse as MailingListImportResponse,
+    type VerificationStatusCount as VerificationStatusCount,
+    type MailingListImportListResponse as MailingListImportListResponse,
+    type MailingListImportDeleteResponse as MailingListImportDeleteResponse,
+    type MailingListImportCreateParams as MailingListImportCreateParams,
+    type MailingListImportUpdateParams as MailingListImportUpdateParams,
+    type MailingListImportListParams as MailingListImportListParams,
+  };
+
+  export {
+    MailingLists as MailingLists,
+    type MailingList as MailingList,
+    type MailingListUpdate as MailingListUpdate,
+    type MailingListListResponse as MailingListListResponse,
+    type MailingListDeleteResponse as MailingListDeleteResponse,
+    type MailingListCreateParams as MailingListCreateParams,
+    type MailingListUpdateParams as MailingListUpdateParams,
+    type MailingListListParams as MailingListListParams,
+    type MailingListJobsParams as MailingListJobsParams,
+  };
+
+  export { OrderProfiles as OrderProfiles };
+
+  export {
+    Postcards as Postcards,
+    type Postcard as Postcard,
+    type PostcardListResponse as PostcardListResponse,
+    type PostcardRetrieveURLResponse as PostcardRetrieveURLResponse,
+    type PostcardCreateParams as PostcardCreateParams,
+    type PostcardListParams as PostcardListParams,
+  };
+
+  export {
+    Reports as Reports,
+    type DeletedResponse as DeletedResponse,
+    type Report as Report,
+    type ReportListResponse as ReportListResponse,
+    type ReportCreateParams as ReportCreateParams,
+    type ReportUpdateParams as ReportUpdateParams,
+    type ReportListParams as ReportListParams,
+    type ReportSampleParams as ReportSampleParams,
+  };
+
+  export {
+    SelfMailers as SelfMailers,
+    type SelfMailer as SelfMailer,
+    type SelfMailerListResponse as SelfMailerListResponse,
+    type SelfMailerRetrieveURLResponse as SelfMailerRetrieveURLResponse,
+    type SelfMailerCreateParams as SelfMailerCreateParams,
+    type SelfMailerListParams as SelfMailerListParams,
+  };
+
+  export {
+    SubOrganizations as SubOrganizations,
+    type EmailPreferences as EmailPreferences,
+    type SubOrganization as SubOrganization,
+    type SubOrganizationUpdateResponse as SubOrganizationUpdateResponse,
+    type SubOrganizationListResponse as SubOrganizationListResponse,
+    type SubOrganizationRetrieveUsersResponse as SubOrganizationRetrieveUsersResponse,
+    type SubOrganizationUpdateParams as SubOrganizationUpdateParams,
+    type SubOrganizationListParams as SubOrganizationListParams,
+    type SubOrganizationRetrieveUsersParams as SubOrganizationRetrieveUsersParams,
+  };
+
+  export {
+    Templates as Templates,
+    type Template as Template,
+    type TemplateListResponse as TemplateListResponse,
+    type TemplateDeleteResponse as TemplateDeleteResponse,
+    type TemplateCreateParams as TemplateCreateParams,
+    type TemplateUpdateParams as TemplateUpdateParams,
+    type TemplateListParams as TemplateListParams,
+  };
+}

package/src/resources/print-mail/reports/exports.ts

@@ -0,0 +1,209 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import * as ReportsAPI from './reports';
+import { APIPromise } from '../../../core/api-promise';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
+
+export class Exports extends APIResource {
+  /**
+   * Create a new export job for a saved report. This runs the report's query
+   * asynchronously and generates a downloadable CSV file with the full results. Your
+   * queries can run for up to 13 minutes the resulting file can be up to 100mb
+   * large.
+   *
+   * @example
+   * ```ts
+   * const reportExport =
+   *   await client.printMail.reports.exports.create(
+   *     'reportID',
+   *     {
+   *       description: 'October Orders Export',
+   *       params: ['2023-10-01T00:00:00Z'],
+   *     },
+   *   );
+   * ```
+   */
+  create(reportID: string, body: ExportCreateParams, options?: RequestOptions): APIPromise<ReportExport> {
+    return this._client.post(path`/print-mail/v1/reports/${reportID}/exports`, { body, ...options });
+  }
+
+  /**
+   * Retrieve the status and details of a specific report export job. Check the
+   * `outputURL` property for the download link once generation is complete.
+   *
+   * @example
+   * ```ts
+   * const reportExport =
+   *   await client.printMail.reports.exports.retrieve(
+   *     'exportID',
+   *     { reportID: 'reportID' },
+   *   );
+   * ```
+   */
+  retrieve(
+    exportID: string,
+    params: ExportRetrieveParams,
+    options?: RequestOptions,
+  ): APIPromise<ReportExport> {
+    const { reportID } = params;
+    return this._client.get(path`/print-mail/v1/reports/${reportID}/exports/${exportID}`, options);
+  }
+
+  /**
+   * Delete a completed or failed report export job and its associated output file
+   * (if any). This action cannot be undone. You cannot delete an export that is
+   * still generating.
+   *
+   * @example
+   * ```ts
+   * const deletedResponse =
+   *   await client.printMail.reports.exports.delete(
+   *     'exportID',
+   *     { reportID: 'reportID' },
+   *   );
+   * ```
+   */
+  delete(
+    exportID: string,
+    params: ExportDeleteParams,
+    options?: RequestOptions,
+  ): APIPromise<ReportsAPI.DeletedResponse> {
+    const { reportID } = params;
+    return this._client.delete(path`/print-mail/v1/reports/${reportID}/exports/${exportID}`, options);
+  }
+}
+
+/**
+ * Represents a report export job and its results.
+ */
+export interface ReportExport {
+  /**
+   * Unique identifier for the report export.
+   */
+  id: string;
+
+  /**
+   * Timestamp when the export was created.
+   */
+  createdAt: string;
+
+  /**
+   * Indicates if the export is associated with the live or test environment.
+   */
+  live: boolean;
+
+  /**
+   * Always `report_export`.
+   */
+  object: 'report_export';
+
+  /**
+   * Details of the report this export was generated from.
+   */
+  report: ReportExport.Report;
+
+  /**
+   * Timestamp when the export was last updated (e.g., finished generation).
+   */
+  updatedAt: string;
+
+  /**
+   * An optional user-friendly description for the export.
+   */
+  description?: string;
+
+  /**
+   * If export generation failed, this contains the error message.
+   */
+  failureMessage?: string;
+
+  /**
+   * Optional key-value metadata associated with the export.
+   */
+  metadata?: { [key: string]: string };
+
+  /**
+   * A signed URL to download the exported data (CSV format). Available when
+   * generation is complete and successful.
+   */
+  outputURL?: string;
+
+  /**
+   * Optional parameters to bind to the SQL query of the associated report.
+   */
+  params?: Array<string>;
+
+  /**
+   * The number of rows in the exported data.
+   */
+  rowCount?: number;
+
+  /**
+   * The size of the generated export file in bytes.
+   */
+  sizeInBytes?: number;
+
+  /**
+   * If the output was truncated, indicates the byte limit reached.
+   */
+  truncatedToBytes?: number;
+}
+
+export namespace ReportExport {
+  /**
+   * Details of the report this export was generated from.
+   */
+  export interface Report {
+    /**
+     * The ID of the report.
+     */
+    id: string;
+
+    /**
+     * The SQL query used for this export (snapshotted at creation time).
+     */
+    sqlQuery: string;
+  }
+}
+
+export interface ExportCreateParams {
+  /**
+   * An optional user-friendly description for the export.
+   */
+  description?: string;
+
+  /**
+   * Optional key-value metadata associated with the export.
+   */
+  metadata?: { [key: string]: string };
+
+  /**
+   * Optional parameters to bind to the SQL query of the associated report.
+   */
+  params?: Array<string>;
+}
+
+export interface ExportRetrieveParams {
+  /**
+   * The ID of the report the export belongs to.
+   */
+  reportID: string;
+}
+
+export interface ExportDeleteParams {
+  /**
+   * The ID of the report the export belongs to.
+   */
+  reportID: string;
+}
+
+export declare namespace Exports {
+  export {
+    type ReportExport as ReportExport,
+    type ExportCreateParams as ExportCreateParams,
+    type ExportRetrieveParams as ExportRetrieveParams,
+    type ExportDeleteParams as ExportDeleteParams,
+  };
+}

package/src/resources/print-mail/reports/index.ts

@@ -0,0 +1,20 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Exports,
+  type ReportExport,
+  type ExportCreateParams,
+  type ExportRetrieveParams,
+  type ExportDeleteParams,
+} from './exports';
+export {
+  Reports,
+  type DeletedResponse,
+  type Report,
+  type ReportListResponse,
+  type ReportCreateParams,
+  type ReportUpdateParams,
+  type ReportListParams,
+  type ReportSampleParams,
+} from './reports';
+export { Samples, type ReportSample, type ReportSampleCreateBase, type SampleCreateParams } from './samples';