mdd-printful-client 0.2.1

package/src/resources/approval-sheets.ts

@@ -0,0 +1,245 @@
+// 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 ApprovalSheets extends APIResource {
+  /**
+   * Retrieve a list of approval sheets confirming suggested changes to files of on
+   * hold orders.
+   *
+   * @example
+   * ```ts
+   * const approvalSheets = await client.approvalSheets.list();
+   * ```
+   */
+  list(
+    params: ApprovalSheetListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<ApprovalSheetListResponse> {
+    const { 'X-PF-Store-Id': xPfStoreID } = params ?? {};
+    return this._client.get('/approval-sheets', {
+      ...options,
+      headers: buildHeaders([
+        { ...(xPfStoreID != null ? { 'X-PF-Store-Id': xPfStoreID } : undefined) },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * Uses the confirm hash of an approval sheet to approve a design and remove the
+   * hold on an order
+   *
+   * @example
+   * ```ts
+   * const response = await client.approvalSheets.approve({
+   *   confirm_hash: 'confirm_hash',
+   *   status: 'approved',
+   * });
+   * ```
+   */
+  approve(
+    params: ApprovalSheetApproveParams,
+    options?: RequestOptions,
+  ): APIPromise<ApprovalSheetApproveResponse> {
+    const { confirm_hash, 'X-PF-Store-Id': xPfStoreID, ...body } = params;
+    return this._client.post('/approval-sheets', {
+      query: { confirm_hash },
+      body,
+      ...options,
+      headers: buildHeaders([
+        { ...(xPfStoreID != null ? { 'X-PF-Store-Id': xPfStoreID } : undefined) },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * Use this to submit alternative changes to a design that has an approval sheet
+   *
+   * @example
+   * ```ts
+   * const response = await client.approvalSheets.submitChanges({
+   *   confirm_hash: 'confirm_hash',
+   *   files: [{ url: 'example.com' }],
+   *   message: 'The design needs to be aligned to the left',
+   * });
+   * ```
+   */
+  submitChanges(
+    params: ApprovalSheetSubmitChangesParams,
+    options?: RequestOptions,
+  ): APIPromise<ApprovalSheetSubmitChangesResponse> {
+    const { confirm_hash, 'X-PF-Store-Id': xPfStoreID, ...body } = params;
+    return this._client.post('/approval-sheets/changes', {
+      query: { confirm_hash },
+      body,
+      ...options,
+      headers: buildHeaders([
+        { ...(xPfStoreID != null ? { 'X-PF-Store-Id': xPfStoreID } : undefined) },
+        options?.headers,
+      ]),
+    });
+  }
+}
+
+export interface ApprovalSheetListResponse {
+  /**
+   * Response status code `200`
+   */
+  code?: number;
+
+  result?: Array<ApprovalSheetListResponse.Result>;
+}
+
+export namespace ApprovalSheetListResponse {
+  /**
+   * Approval sheet
+   */
+  export interface Result {
+    id?: number;
+
+    approval_sheet?: string;
+
+    confirm_hash?: string;
+
+    recommended_design?: string;
+
+    status?: 'waiting_for_action' | 'approved';
+
+    submitted_design?: string;
+  }
+}
+
+export interface ApprovalSheetApproveResponse {
+  /**
+   * Response status code `200`
+   */
+  code?: number;
+
+  result?: ApprovalSheetApproveResponse.Result;
+}
+
+export namespace ApprovalSheetApproveResponse {
+  export interface Result {
+    message?: string;
+  }
+}
+
+export interface ApprovalSheetSubmitChangesResponse {
+  /**
+   * Response status code `200`
+   */
+  code?: number;
+
+  /**
+   * Approval sheet
+   */
+  result?: ApprovalSheetSubmitChangesResponse.Result;
+}
+
+export namespace ApprovalSheetSubmitChangesResponse {
+  /**
+   * Approval sheet
+   */
+  export interface Result {
+    id?: number;
+
+    approval_sheet?: string;
+
+    confirm_hash?: string;
+
+    recommended_design?: string;
+
+    status?: 'waiting_for_action' | 'approved';
+
+    submitted_design?: string;
+  }
+}
+
+export interface ApprovalSheetListParams {
+  /**
+   * 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 interface ApprovalSheetApproveParams {
+  /**
+   * Query param: The confirm hash for the approval sheet you would like to approve.
+   */
+  confirm_hash: string;
+
+  /**
+   * Body param
+   */
+  status: 'approved';
+
+  /**
+   * 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 interface ApprovalSheetSubmitChangesParams {
+  /**
+   * Query param: The confirm hash for the approval sheet you would like to approve.
+   */
+  confirm_hash: string;
+
+  /**
+   * Body param: An array of images to help describe the requested changes. Consider
+   * using the mockup generator to generate these images. The array is required but
+   * can be empty if you do not want to email any images.
+   */
+  files: Array<ApprovalSheetSubmitChangesParams.File>;
+
+  /**
+   * Body param: A message to send to Printful designers. Customers should use this
+   * to describe the changes they want.
+   */
+  message: 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 ApprovalSheetSubmitChangesParams {
+  export interface File {
+    /**
+     * A url to an image, consider using the mockup generator to generate this image.
+     */
+    url: string;
+  }
+}
+
+export declare namespace ApprovalSheets {
+  export {
+    type ApprovalSheetListResponse as ApprovalSheetListResponse,
+    type ApprovalSheetApproveResponse as ApprovalSheetApproveResponse,
+    type ApprovalSheetSubmitChangesResponse as ApprovalSheetSubmitChangesResponse,
+    type ApprovalSheetListParams as ApprovalSheetListParams,
+    type ApprovalSheetApproveParams as ApprovalSheetApproveParams,
+    type ApprovalSheetSubmitChangesParams as ApprovalSheetSubmitChangesParams,
+  };
+}

package/src/resources/categories.ts

@@ -0,0 +1,114 @@
+// 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 { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+export class Categories extends APIResource {
+  /**
+   * Returns information about a specific category.
+   */
+  retrieve(id: number, options?: RequestOptions): APIPromise<CategoryRetrieveResponse> {
+    return this._client.get(path`/categories/${id}`, options);
+  }
+
+  /**
+   * Returns list of Catalog Categories available in the Printful
+   */
+  list(options?: RequestOptions): APIPromise<CategoryListResponse> {
+    return this._client.get('/categories', options);
+  }
+}
+
+export interface CategoryRetrieveResponse {
+  /**
+   * Response status code `200`
+   */
+  code?: number;
+
+  /**
+   * Information about the Category
+   */
+  result?: CategoryRetrieveResponse.Result;
+}
+
+export namespace CategoryRetrieveResponse {
+  /**
+   * Information about the Category
+   */
+  export interface Result {
+    /**
+     * Category ID
+     */
+    id?: number;
+
+    /**
+     * The URL of the Category image
+     */
+    image_url?: string;
+
+    /**
+     * ID of the parent Category. If there is no parent Category, 0 is returned.
+     */
+    parent_id?: number;
+
+    /**
+     * The size of the category image
+     */
+    size?: 'small' | 'medium' | 'large';
+
+    /**
+     * Category title
+     */
+    title?: string;
+  }
+}
+
+export interface CategoryListResponse {
+  /**
+   * Response status code `200`
+   */
+  code?: number;
+
+  result?: Array<CategoryListResponse.Result>;
+}
+
+export namespace CategoryListResponse {
+  /**
+   * Information about the Category
+   */
+  export interface Result {
+    /**
+     * Category ID
+     */
+    id?: number;
+
+    /**
+     * The URL of the Category image
+     */
+    image_url?: string;
+
+    /**
+     * ID of the parent Category. If there is no parent Category, 0 is returned.
+     */
+    parent_id?: number;
+
+    /**
+     * The size of the category image
+     */
+    size?: 'small' | 'medium' | 'large';
+
+    /**
+     * Category title
+     */
+    title?: string;
+  }
+}
+
+export declare namespace Categories {
+  export {
+    type CategoryRetrieveResponse as CategoryRetrieveResponse,
+    type CategoryListResponse as CategoryListResponse,
+  };
+}

package/src/resources/countries.ts

@@ -0,0 +1,59 @@
+// 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 { RequestOptions } from '../internal/request-options';
+
+export class Countries extends APIResource {
+  /**
+   * Returns list of countries and states that are accepted by the Printful.
+   */
+  list(options?: RequestOptions): APIPromise<CountryListResponse> {
+    return this._client.get('/countries', options);
+  }
+}
+
+export interface CountryListResponse {
+  /**
+   * Response status code `200`
+   */
+  code?: number;
+
+  result?: Array<CountryListResponse.Result>;
+}
+
+export namespace CountryListResponse {
+  export interface Result {
+    /**
+     * Country code
+     */
+    code?: string;
+
+    /**
+     * Country name
+     */
+    name?: string;
+
+    region?: string;
+
+    states?: Array<Result.State> | null;
+  }
+
+  export namespace Result {
+    export interface State {
+      /**
+       * State code
+       */
+      code?: string;
+
+      /**
+       * State name
+       */
+      name?: string;
+    }
+  }
+}
+
+export declare namespace Countries {
+  export { type CountryListResponse as CountryListResponse };
+}

package/src/resources/files.ts

@@ -0,0 +1,185 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import * as Shared from './shared';
+import { APIPromise } from '../core/api-promise';
+import { buildHeaders } from '../internal/headers';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+export class Files extends APIResource {
+  /**
+   * Adds a new File to the library by providing URL of the file.
+   *
+   * If a file with identical URL already exists, then the original file is returned.
+   * If a file does not exist, a new file is created.
+   *
+   * [See examples](#tag/Examples/File-Library-API-examples/Add-a-new-file)
+   *
+   * @example
+   * ```ts
+   * const file = await client.files.create({
+   *   url: '​https://www.example.com/files/tshirts/example.png',
+   * });
+   * ```
+   */
+  create(params: FileCreateParams, options?: RequestOptions): APIPromise<FileCreateResponse> {
+    const { 'X-PF-Store-Id': xPfStoreID, ...body } = params;
+    return this._client.post('/files', {
+      body,
+      ...options,
+      headers: buildHeaders([
+        { ...(xPfStoreID != null ? { 'X-PF-Store-Id': xPfStoreID } : undefined) },
+        options?.headers,
+      ]),
+      __security: {},
+    });
+  }
+
+  /**
+   * Returns information about the given file.
+   *
+   * @example
+   * ```ts
+   * const file = await client.files.retrieve(0);
+   * ```
+   */
+  retrieve(
+    id: number,
+    params: FileRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<FileRetrieveResponse> {
+    const { 'X-PF-Store-Id': xPfStoreID } = params ?? {};
+    return this._client.get(path`/files/${id}`, {
+      ...options,
+      headers: buildHeaders([
+        { ...(xPfStoreID != null ? { 'X-PF-Store-Id': xPfStoreID } : undefined) },
+        options?.headers,
+      ]),
+      __security: {},
+    });
+  }
+
+  /**
+   * Returns colors in hexadecimal format.
+   *
+   * Returned thread colors are matched as closely as possible to provided image
+   * colors.
+   *
+   * [See examples](#tag/Examples/File-Library-API-examples/Suggest-thread-colors)
+   *
+   * @example
+   * ```ts
+   * const response = await client.files.getThreadColors();
+   * ```
+   */
+  getThreadColors(
+    body: FileGetThreadColorsParams,
+    options?: RequestOptions,
+  ): APIPromise<FileGetThreadColorsResponse> {
+    return this._client.post('/files/thread-colors', { body, ...options });
+  }
+}
+
+export interface FileCreateResponse {
+  /**
+   * Response status code `200`
+   */
+  code?: number;
+
+  /**
+   * Information about the File
+   */
+  result?: Shared.File;
+}
+
+export interface FileRetrieveResponse {
+  /**
+   * Response status code `200`
+   */
+  code?: number;
+
+  /**
+   * Information about the File
+   */
+  result?: Shared.File;
+}
+
+export interface FileGetThreadColorsResponse {
+  /**
+   * Response status code `200`
+   */
+  code?: number;
+
+  thread_colors?: Array<string>;
+}
+
+export interface FileCreateParams {
+  /**
+   * Body param: 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;
+
+  /**
+   * Body param: File name
+   */
+  filename?: string;
+
+  /**
+   * Body param: Array of additional options for this file
+   * [See examples](#tag/Common/Options)
+   */
+  options?: Array<Shared.FileOption>;
+
+  /**
+   * Body param: Role of the file
+   */
+  type?: string;
+
+  /**
+   * Body param: Show file in the Printfile Library (default true)
+   */
+  visible?: boolean;
+
+  /**
+   * 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 interface FileRetrieveParams {
+  /**
+   * 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 interface FileGetThreadColorsParams {
+  /**
+   * URL to file
+   */
+  file_url?: string;
+}
+
+export declare namespace Files {
+  export {
+    type FileCreateResponse as FileCreateResponse,
+    type FileRetrieveResponse as FileRetrieveResponse,
+    type FileGetThreadColorsResponse as FileGetThreadColorsResponse,
+    type FileCreateParams as FileCreateParams,
+    type FileRetrieveParams as FileRetrieveParams,
+    type FileGetThreadColorsParams as FileGetThreadColorsParams,
+  };
+}

package/src/resources/index.ts

@@ -0,0 +1,115 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './shared';
+export {
+  ApprovalSheets,
+  type ApprovalSheetListResponse,
+  type ApprovalSheetApproveResponse,
+  type ApprovalSheetSubmitChangesResponse,
+  type ApprovalSheetListParams,
+  type ApprovalSheetApproveParams,
+  type ApprovalSheetSubmitChangesParams,
+} from './approval-sheets';
+export { Categories, type CategoryRetrieveResponse, type CategoryListResponse } from './categories';
+export { Countries, type CountryListResponse } from './countries';
+export {
+  Files,
+  type FileCreateResponse,
+  type FileRetrieveResponse,
+  type FileGetThreadColorsResponse,
+  type FileCreateParams,
+  type FileRetrieveParams,
+  type FileGetThreadColorsParams,
+} from './files';
+export {
+  MockupGenerator,
+  type MockupGeneratorCreateTaskResponse,
+  type MockupGeneratorRetrievePrintfilesResponse,
+  type MockupGeneratorRetrieveTaskResultResponse,
+  type MockupGeneratorRetrieveTemplatesResponse,
+  type MockupGeneratorCreateTaskParams,
+  type MockupGeneratorRetrievePrintfilesParams,
+  type MockupGeneratorRetrieveTaskResultParams,
+  type MockupGeneratorRetrieveTemplatesParams,
+} from './mockup-generator';
+export { OAuth, type OAuthListScopesResponse } from './oauth';
+export {
+  Orders,
+  type Address,
+  type Costs,
+  type Gift,
+  type IncompleteItem,
+  type Item,
+  type Option,
+  type Order,
+  type OrderShipmentItem,
+  type PricingBreakdown,
+  type RetailCosts,
+  type Shipment,
+  type OrderCreateResponse,
+  type OrderRetrieveResponse,
+  type OrderUpdateResponse,
+  type OrderListResponse,
+  type OrderCancelResponse,
+  type OrderConfirmResponse,
+  type OrderEstimateCostsResponse,
+  type OrderCreateParams,
+  type OrderRetrieveParams,
+  type OrderUpdateParams,
+  type OrderListParams,
+  type OrderCancelParams,
+  type OrderConfirmParams,
+  type OrderEstimateCostsParams,
+} from './orders';
+export {
+  ProductTemplates,
+  type ProductTemplateRetrieveResponse,
+  type ProductTemplateListResponse,
+  type ProductTemplateDeleteResponse,
+  type ProductTemplateListParams,
+} from './product-templates';
+export {
+  Products,
+  type AvailableTechnique,
+  type CatalogFileOption,
+  type FileType,
+  type OptionType,
+  type Product,
+  type ProductRetrieveResponse,
+  type ProductListResponse,
+  type ProductRetrieveSizeGuideResponse,
+  type ProductRetrieveVariantResponse,
+  type ProductListParams,
+  type ProductRetrieveSizeGuideParams,
+} from './products';
+export {
+  Reports,
+  type ReportRetrieveStatisticsResponse,
+  type ReportRetrieveStatisticsParams,
+} from './reports';
+export { Shipping, type ShippingCalculateRatesResponse, type ShippingCalculateRatesParams } from './shipping';
+export {
+  Store,
+  type StoreRetrieveResponse,
+  type StoreListResponse,
+  type StoreUpdatePackingSlipResponse,
+  type StoreUpdatePackingSlipParams,
+} from './store/store';
+export { Sync } from './sync/sync';
+export {
+  Tax,
+  type TaxCalculateRateResponse,
+  type TaxListCountriesResponse,
+  type TaxCalculateRateParams,
+} from './tax';
+export { Warehouse } from './warehouse/warehouse';
+export {
+  Webhooks,
+  type WebhookInfo,
+  type WebhookCreateResponse,
+  type WebhookRetrieveResponse,
+  type WebhookDeleteResponse,
+  type WebhookCreateParams,
+  type WebhookRetrieveParams,
+  type WebhookDeleteParams,
+} from './webhooks';