mdd-printful-client 0.2.1

package/src/resources/shared.ts

@@ -0,0 +1,366 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import * as Shared from './shared';
+
+/**
+ * Information about the File
+ */
+export interface File {
+  /**
+   * Source URL where the file is downloaded from. The use of .ai .psd and .tiff
+   * files have been depreciated, if your application uses these file types or
+   * accepts these types from users you will need to add validation.
+   */
+  url: string;
+
+  /**
+   * File ID
+   */
+  id?: number;
+
+  /**
+   * File creation timestamp
+   */
+  created?: number;
+
+  /**
+   * Resolution DPI. **Note:** for vector files this may be indicated as only 72dpi,
+   * but it doesn't affect print quality since the vector files are resolution
+   * independent.
+   */
+  dpi?: number;
+
+  /**
+   * File name
+   */
+  filename?: string;
+
+  /**
+   * MD5 checksum of the file
+   */
+  hash?: string;
+
+  /**
+   * Height in pixels
+   */
+  height?: number;
+
+  /**
+   * Whether it is a temporary printfile.
+   */
+  is_temporary?: boolean;
+
+  /**
+   * MIME type of the file
+   */
+  mime_type?: string;
+
+  /**
+   * Array of additional options for this file [See examples](#tag/Common/Options)
+   */
+  options?: Array<FileOption>;
+
+  /**
+   * Medium preview image URL
+   */
+  preview_url?: string;
+
+  /**
+   * Size in bytes
+   */
+  size?: number;
+
+  /**
+   * File processing status: **ok** - file was processed successfuly **waiting** -
+   * file is being processed **failed** - file failed to be processed
+   */
+  status?: string;
+
+  /**
+   * Small thumbnail URL
+   */
+  thumbnail_url?: string;
+
+  /**
+   * Role of the file
+   */
+  type?: string;
+
+  /**
+   * Show file in the Printfile Library (default true)
+   */
+  visible?: boolean;
+
+  /**
+   * Width in pixels
+   */
+  width?: number;
+}
+
+/**
+ * File option
+ */
+export interface FileOption {
+  /**
+   * Option id
+   */
+  id: string;
+
+  /**
+   * Option value
+   */
+  value: string;
+}
+
+/**
+ * Additional options for the configured product/variant
+ */
+export interface ItemOption {
+  /**
+   * Option id
+   */
+  id: string;
+
+  /**
+   * Option value
+   */
+  value: string;
+}
+
+/**
+ * Custom packing slip for this order. Example of a packing slip with explained
+ * fields can be found [here](#packing-slip).
+ */
+export interface PackingSlip {
+  /**
+   * Your own Order ID that will be printed instead of Printful's Order ID
+   */
+  custom_order_id?: string;
+
+  /**
+   * Customer service email
+   */
+  email?: string;
+
+  /**
+   * URL address to a sticker we will put on a package. The provided image is
+   * converted to grayscale/1-bit monochrome image.
+   */
+  logo_url?: string;
+
+  /**
+   * Custom packing slip message
+   */
+  message?: string;
+
+  /**
+   * Customer service phone
+   */
+  phone?: string;
+
+  /**
+   * Store name override for the return address
+   */
+  store_name?: string;
+}
+
+/**
+ * Paging information
+ */
+export interface Paging {
+  /**
+   * Max number of items per page
+   */
+  limit: number;
+
+  /**
+   * Current result set page offset
+   */
+  offset: number;
+
+  /**
+   * Total number of items available
+   */
+  total: number;
+}
+
+/**
+ * Short information about the Printful Product and Variant
+ */
+export interface ProductVariant {
+  /**
+   * URL of a sample image for this variant
+   */
+  image?: string;
+
+  /**
+   * Display name of this variant
+   */
+  name?: string;
+
+  /**
+   * Product ID of this variant
+   */
+  product_id?: number;
+
+  /**
+   * Variant ID
+   */
+  variant_id?: number;
+}
+
+/**
+ * Information about the SyncProduct
+ */
+export interface SyncProduct {
+  /**
+   * Product name
+   */
+  name: string;
+
+  /**
+   * SyncProduct ID
+   */
+  id?: number;
+
+  /**
+   * Product ID from the Ecommerce platform
+   */
+  external_id?: string;
+
+  /**
+   * Indicates if this Sync Product is ignored
+   */
+  is_ignored?: boolean;
+
+  /**
+   * Number of synced Sync Variants belonging to this product
+   */
+  synced?: number;
+
+  /**
+   * Thumbnail image for the product
+   */
+  thumbnail_url?: string;
+
+  /**
+   * Total number of Sync Variants belonging to this product
+   */
+  variants?: number;
+}
+
+/**
+ * Information about the SyncVariant
+ */
+export interface SyncVariant {
+  /**
+   * Sync Variant ID
+   */
+  id?: number;
+
+  /**
+   * Indicates the status of the Sync Variant.
+   */
+  availability_status?: 'active' | 'discontinued' | 'out_of_stock' | 'temporary_out_of_stock';
+
+  /**
+   * The color of the associated Catalog Variant
+   */
+  color?: string | null;
+
+  /**
+   * Currency in which prices are returned
+   */
+  currency?: string;
+
+  /**
+   * Variant ID from the Ecommerce platform
+   */
+  external_id?: string;
+
+  /**
+   * Array of attached printfiles / preview images
+   */
+  files?: Array<SyncVariant.File>;
+
+  /**
+   * Indicates if this Sync Variant is ignored
+   */
+  is_ignored?: boolean;
+
+  /**
+   * Printful Variant catalog category ID
+   */
+  main_category_id?: number | null;
+
+  /**
+   * Sync Variant name
+   */
+  name?: string;
+
+  /**
+   * Array of additional options for the configured product/variant
+   * [See examples](#tag/Common/Options)
+   */
+  options?: Array<ItemOption>;
+
+  /**
+   * Short information about the Printful Product and Variant
+   */
+  product?: ProductVariant;
+
+  /**
+   * Retail price that this item is sold for
+   */
+  retail_price?: string;
+
+  /**
+   * The size of the associated Catalog Variant
+   */
+  size?: string | null;
+
+  /**
+   * SKU of this Sync Variant
+   */
+  sku?: string | null;
+
+  /**
+   * Sync Product ID that this variant belongs to
+   */
+  sync_product_id?: number;
+
+  /**
+   * Indicates if this Sync Variant is properly linked with Printful product
+   */
+  synced?: boolean;
+
+  /**
+   * Printful Variant ID that this Sync Variant is synced to
+   */
+  variant_id?: number;
+
+  /**
+   * Warehousing product ID. If the sync variant is connected with a warehousing
+   * item, this is the ID of corresponding warehouse product.
+   */
+  warehouse_product_id?: number | null;
+
+  /**
+   * Warehousing variant ID. If the sync variant is connected with a warehousing
+   * item, this is its ID.
+   */
+  warehouse_product_variant_id?: number | null;
+}
+
+export namespace SyncVariant {
+  /**
+   * Information about the File
+   */
+  export interface File extends Shared.File {
+    /**
+     * Stitch count tier see
+     * https://help.printful.com/hc/en-us/articles/4909652626204-What-s-the-new-large-embroidery-pricing-
+     */
+    stitch_count_tier?: string | null;
+  }
+}

package/src/resources/shipping.ts

@@ -0,0 +1,263 @@
+// 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 { buildHeaders } from '../internal/headers';
+import { RequestOptions } from '../internal/request-options';
+
+export class Shipping extends APIResource {
+  /**
+   * Returns available shipping options and rates for the given list of products.
+   *
+   * **Recipient Address Requirements:**
+   *
+   * - Only `country_code` is required in the recipient object
+   * - `state_code` is only required for United States (US), Australia (AU), and
+   *   Canada (CA)
+   * - All other recipient fields are optional
+   *
+   * **Note:** Providing more address information may produce more precise results
+   * and more shipping options. While only the country code is required, including
+   * additional details like city, postal code, and state/province can help return
+   * more accurate shipping rates and additional delivery options.
+   *
+   * **Important:** Shipping rates returned by this endpoint may differ from those
+   * returned by `/orders/estimate-costs` if your store has
+   * [store shipping settings](https://www.printful.com/dashboard/settings/store-shipping)
+   * configured.
+   *
+   * The `/orders/estimate-costs` endpoint automatically applies your store's
+   * shipping settings (including shipping markup), while this endpoint applies them
+   * **only if the store shipping settings are enabled**. To ensure consistent
+   * results between both endpoints, make sure your store shipping settings are
+   * enabled and properly configured in your Printful Dashboard.
+   *
+   * @example
+   * ```ts
+   * const response = await client.shipping.calculateRates({
+   *   items: [{ quantity: 10 }],
+   *   recipient: { country_code: 'US' },
+   * });
+   * ```
+   */
+  calculateRates(
+    params: ShippingCalculateRatesParams,
+    options?: RequestOptions,
+  ): APIPromise<ShippingCalculateRatesResponse> {
+    const { 'X-PF-Store-Id': xPfStoreID, ...body } = params;
+    return this._client.post('/shipping/rates', {
+      body,
+      ...options,
+      headers: buildHeaders([
+        { ...(xPfStoreID != null ? { 'X-PF-Store-Id': xPfStoreID } : undefined) },
+        options?.headers,
+      ]),
+      __security: {},
+    });
+  }
+}
+
+export interface ShippingCalculateRatesResponse {
+  /**
+   * Response status code `200`
+   */
+  code?: number;
+
+  result?: Array<ShippingCalculateRatesResponse.Result>;
+}
+
+export namespace ShippingCalculateRatesResponse {
+  /**
+   * Shipping information
+   */
+  export interface Result {
+    /**
+     * Shipping method ID
+     */
+    id?: string;
+
+    /**
+     * Currency code in which the rate is returned
+     */
+    currency?: string;
+
+    /**
+     * Estimated maximum delivery date. <span style="color:orange">Warning! This value
+     * may not be present in response.</span>
+     */
+    maxDeliveryDate?: number;
+
+    /**
+     * Estimated maximum delivery days. <span style="color:orange">Warning! This value
+     * may not be present in response.</span>
+     */
+    maxDeliveryDays?: number;
+
+    /**
+     * Estimated minimum delivery date. <span style="color:orange">Warning! This value
+     * may not be present in response.</span>
+     */
+    minDeliveryDate?: number;
+
+    /**
+     * Estimated minimum delivery days. <span style="color:orange">Warning! This value
+     * may not be present in response.</span>
+     */
+    minDeliveryDays?: number;
+
+    /**
+     * Shipping method name
+     */
+    name?: string;
+
+    /**
+     * Shipping rate
+     */
+    rate?: string;
+  }
+}
+
+export interface ShippingCalculateRatesParams {
+  /**
+   * Body param: Array of order items
+   */
+  items: Array<ShippingCalculateRatesParams.Item>;
+
+  /**
+   * Body param: Recipient address information for shipping rate calculation.
+   *
+   * **Required fields:**
+   *
+   * - `country_code`: Always required
+   *
+   * **Conditionally required fields:**
+   *
+   * - `state_code`: Required for United States (US), Australia (AU), and Canada (CA)
+   *
+   * **Optional fields:**
+   *
+   * - All other fields are optional but providing more information may produce more
+   *   precise results and more shipping options.
+   */
+  recipient: ShippingCalculateRatesParams.Recipient;
+
+  /**
+   * Body param: 3 letter currency code (optional), required if the rates need to be
+   * converted to another currency instead of store default currency
+   */
+  currency?: string;
+
+  /**
+   * Body param: Locale in which shipping rate names will be returned. Available
+   * options: `en_US` (default), `es_ES`
+   */
+  locale?: string;
+
+  /**
+   * Header param: Use this to specify which store you want to use (required only for
+   * account level token).
+   *
+   * The store IDs can be retrieved with the
+   * [Get basic information about stores](#tag/Store-Information-API/operation/getStores)
+   * endpoint.
+   */
+  'X-PF-Store-Id'?: string;
+}
+
+export namespace ShippingCalculateRatesParams {
+  /**
+   * Order item information
+   */
+  export interface Item {
+    /**
+     * Number of items ordered
+     */
+    quantity: number;
+
+    /**
+     * External Variant ID of the item ordered. See
+     * [Ecommerce Platform Sync API](#tag/Ecommerce-Platform-Sync-API).
+     * <span style="color:red">\*Required if no other IDs given</span>
+     */
+    external_variant_id?: string;
+
+    /**
+     * Item retail value - optional but can help to properly calculate
+     */
+    value?: string;
+
+    /**
+     * Catalog Variant ID of the item ordered. See [Catalog API](#tag/Catalog-API)
+     * <span style="color:red">\*Required if no other IDs given</span>
+     */
+    variant_id?: string;
+
+    /**
+     * Warehouse product variant ID of the item ordered. See
+     * [Warehouse Products API](#tag/Warehouse-Products-API).
+     * <span style="color:red">\*Required if no other IDs given</span>
+     */
+    warehouse_product_variant_id?: string;
+  }
+
+  /**
+   * Recipient address information for shipping rate calculation.
+   *
+   * **Required fields:**
+   *
+   * - `country_code`: Always required
+   *
+   * **Conditionally required fields:**
+   *
+   * - `state_code`: Required for United States (US), Australia (AU), and Canada (CA)
+   *
+   * **Optional fields:**
+   *
+   * - All other fields are optional but providing more information may produce more
+   *   precise results and more shipping options.
+   */
+  export interface Recipient {
+    /**
+     * Two-letter country code (ISO 3166-1 alpha-2)
+     */
+    country_code: string;
+
+    /**
+     * Address line 1
+     */
+    address1?: string;
+
+    /**
+     * Address line 2
+     */
+    address2?: string | null;
+
+    /**
+     * City
+     */
+    city?: string;
+
+    /**
+     * Phone number
+     */
+    phone?: string | null;
+
+    /**
+     * State/province code. Required for United States (US), Australia (AU), and Canada
+     * (CA). For other countries, this field is optional.
+     */
+    state_code?: string | null;
+
+    /**
+     * ZIP or postal code
+     */
+    zip?: string | null;
+  }
+}
+
+export declare namespace Shipping {
+  export {
+    type ShippingCalculateRatesResponse as ShippingCalculateRatesResponse,
+    type ShippingCalculateRatesParams as ShippingCalculateRatesParams,
+  };
+}

package/src/resources/store/index.ts

@@ -0,0 +1,33 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Products,
+  type ProductCreateResponse,
+  type ProductRetrieveResponse,
+  type ProductUpdateResponse,
+  type ProductListResponse,
+  type ProductDeleteResponse,
+  type ProductCreateVariantResponse,
+  type ProductCreateParams,
+  type ProductRetrieveParams,
+  type ProductUpdateParams,
+  type ProductListParams,
+  type ProductDeleteParams,
+  type ProductCreateVariantParams,
+} from './products';
+export {
+  Store,
+  type StoreRetrieveResponse,
+  type StoreListResponse,
+  type StoreUpdatePackingSlipResponse,
+  type StoreUpdatePackingSlipParams,
+} from './store';
+export {
+  Variants,
+  type VariantRetrieveResponse,
+  type VariantUpdateResponse,
+  type VariantDeleteResponse,
+  type VariantRetrieveParams,
+  type VariantUpdateParams,
+  type VariantDeleteParams,
+} from './variants';