postgrid-node 0.1.0-alpha.5 → 0.3.0

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

@@ -0,0 +1,338 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import * as BoxesAPI from '../boxes';
+import { APIPromise } from '../../../core/api-promise';
+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
+   * const postcards =
+   *   await client.printMail.orderProfiles.postcards.list();
+   * ```
+   */
+  list(
+    query: PostcardListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<PostcardListResponse> {
+    return this._client.get('/print-mail/v1/order_profiles/postcards', { 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 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?: 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;
+
+  /**
+   * 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';
+
+/**
+ * Represents a list of Postcard Profiles.
+ */
+export interface PostcardListResponse {
+  data: Array<PostcardProfile>;
+
+  limit: number;
+
+  object: 'list';
+
+  skip: number;
+
+  totalCount: number;
+}
+
+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?: 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 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?: 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 2-page PDF file containing the postcard content (front and back).
+   * Cannot be used with `frontTemplate`/`backTemplate`.
+   */
+  pdf?: string;
+}
+
+export interface PostcardListParams {
+  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 Postcards {
+  export {
+    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,
+  };
+}

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

@@ -0,0 +1,348 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import * as BoxesAPI from '../boxes';
+import { APIPromise } from '../../../core/api-promise';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
+
+export class SelfMailers extends APIResource {
+  /**
+   * Creates a new Self-Mailer Profile. Provide either `insideTemplate` and
+   * `outsideTemplate` IDs, or upload a 2-page `pdf`. If providing a `pdf`, the
+   * request `Content-Type` must be `multipart/form-data`.
+   *
+   * @example
+   * ```ts
+   * const selfMailerProfile =
+   *   await client.printMail.orderProfiles.selfMailers.create({
+   *     size: '8.5x11_bifold',
+   *   });
+   * ```
+   */
+  create(params: SelfMailerCreateParams, options?: RequestOptions): APIPromise<SelfMailerProfile> {
+    const { expand, ...body } = params;
+    return this._client.post('/print-mail/v1/order_profiles/self_mailers', {
+      query: { expand },
+      body,
+      ...options,
+    });
+  }
+
+  /**
+   * Retrieves the details of a specific Self-Mailer Profile.
+   *
+   * @example
+   * ```ts
+   * const selfMailerProfile =
+   *   await client.printMail.orderProfiles.selfMailers.retrieve(
+   *     'id',
+   *   );
+   * ```
+   */
+  retrieve(
+    id: string,
+    query: SelfMailerRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<SelfMailerProfile> {
+    return this._client.get(path`/print-mail/v1/order_profiles/self_mailers/${id}`, { query, ...options });
+  }
+
+  /**
+   * Updates specific fields of an existing Self-Mailer Profile. If providing a
+   * `pdf`, the request `Content-Type` must be `multipart/form-data`.
+   *
+   * @example
+   * ```ts
+   * const selfMailerProfile =
+   *   await client.printMail.orderProfiles.selfMailers.update(
+   *     'id',
+   *     { size: '8.5x11_bifold' },
+   *   );
+   * ```
+   */
+  update(
+    id: string,
+    params: SelfMailerUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<SelfMailerProfile> {
+    const { expand, ...body } = params;
+    return this._client.post(path`/print-mail/v1/order_profiles/self_mailers/${id}`, {
+      query: { expand },
+      body,
+      ...options,
+    });
+  }
+
+  /**
+   * Retrieves a list of Self-Mailer Profiles.
+   *
+   * @example
+   * ```ts
+   * const selfMailers =
+   *   await client.printMail.orderProfiles.selfMailers.list();
+   * ```
+   */
+  list(
+    query: SelfMailerListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<SelfMailerListResponse> {
+    return this._client.get('/print-mail/v1/order_profiles/self_mailers', { query, ...options });
+  }
+
+  /**
+   * Deletes a Self-Mailer Profile.
+   *
+   * @example
+   * ```ts
+   * const selfMailer =
+   *   await client.printMail.orderProfiles.selfMailers.delete(
+   *     'id',
+   *   );
+   * ```
+   */
+  delete(id: string, options?: RequestOptions): APIPromise<SelfMailerDeleteResponse> {
+    return this._client.delete(path`/print-mail/v1/order_profiles/self_mailers/${id}`, options);
+  }
+}
+
+/**
+ * Represents a Self-Mailer Profile resource.
+ */
+export interface SelfMailerProfile {
+  /**
+   * 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 `self_mailer_profile`.
+   */
+  object: 'self_mailer_profile';
+
+  /**
+   * Enum representing the supported self-mailer sizes.
+   */
+  size: SelfMailerSize;
+
+  /**
+   * 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 the template for the inside. Required unless `pdf` is provided.
+   */
+  insideTemplate?: string;
+
+  /**
+   * Mailing class (cannot include extra services for self-mailers).
+   */
+  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;
+
+  /**
+   * ID of the template for the outside. Required unless `pdf` is provided.
+   */
+  outsideTemplate?: string;
+
+  /**
+   * A temporary, signed URL to view the uploaded PDF, if any.
+   */
+  uploadedPDF?: string;
+}
+
+/**
+ * Enum representing the supported self-mailer sizes.
+ */
+export type SelfMailerSize = '8.5x11_bifold' | '8.5x11_trifold' | '9.5x16_trifold';
+
+/**
+ * Represents a list of Self-Mailer Profiles.
+ */
+export interface SelfMailerListResponse {
+  data: Array<SelfMailerProfile>;
+
+  limit: number;
+
+  object: 'list';
+
+  skip: number;
+
+  totalCount: number;
+}
+
+export interface SelfMailerDeleteResponse {
+  /**
+   * Unique identifier for the order profile.
+   */
+  id: string;
+
+  deleted: true;
+
+  /**
+   * Always `self_mailer_profile`.
+   */
+  object: 'self_mailer_profile';
+}
+
+export interface SelfMailerCreateParams {
+  /**
+   * Body param: Enum representing the supported self-mailer sizes.
+   */
+  size: SelfMailerSize;
+
+  /**
+   * Query param: Optional list of related resources to expand in the response.
+   */
+  expand?: Array<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 inside. Required unless `pdf` is
+   * provided.
+   */
+  insideTemplate?: string;
+
+  /**
+   * Body param: Mailing class (cannot include extra services for self-mailers).
+   */
+  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: ID of the template for the outside. Required unless `pdf` is
+   * provided.
+   */
+  outsideTemplate?: string;
+
+  /**
+   * Body param: A 2-page PDF file containing the self-mailer content (inside and
+   * outside). Cannot be used with `insideTemplate`/`outsideTemplate`.
+   */
+  pdf?: string;
+}
+
+export interface SelfMailerRetrieveParams {
+  /**
+   * Optional list of related resources to expand in the response.
+   */
+  expand?: Array<string>;
+}
+
+export interface SelfMailerUpdateParams {
+  /**
+   * Body param: Enum representing the supported self-mailer sizes.
+   */
+  size: SelfMailerSize;
+
+  /**
+   * Query param: Optional list of related resources to expand in the response.
+   */
+  expand?: Array<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 inside. Required unless `pdf` is
+   * provided.
+   */
+  insideTemplate?: string;
+
+  /**
+   * Body param: Mailing class (cannot include extra services for self-mailers).
+   */
+  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: ID of the template for the outside. Required unless `pdf` is
+   * provided.
+   */
+  outsideTemplate?: string;
+
+  /**
+   * Body param: A 2-page PDF file containing the self-mailer content (inside and
+   * outside). Cannot be used with `insideTemplate`/`outsideTemplate`.
+   */
+  pdf?: string;
+}
+
+export interface SelfMailerListParams {
+  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 SelfMailers {
+  export {
+    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,
+  };
+}