mdd-printful-client 0.2.1

package/resources/store/products.d.mts

@@ -0,0 +1,327 @@
+import { APIResource } from "../../core/resource.mjs";
+import * as Shared from "../shared.mjs";
+import { APIPromise } from "../../core/api-promise.mjs";
+import { RequestOptions } from "../../internal/request-options.mjs";
+export declare class Products extends APIResource {
+    /**
+     * Creates a new Sync Product together with its Sync Variants
+     * ([See examples](#tag/Products-API/operation/createSyncProduct)).
+     *
+     * @example
+     * ```ts
+     * const product = await client.store.products.create({
+     *   sync_product: { name: 'T-shirt' },
+     *   sync_variants: [
+     *     {
+     *       files: [
+     *         {
+     *           url: '​https://www.example.com/files/tshirts/example.png',
+     *         },
+     *       ],
+     *       variant_id: 3001,
+     *     },
+     *   ],
+     * });
+     * ```
+     */
+    create(params: ProductCreateParams, options?: RequestOptions): APIPromise<ProductCreateResponse>;
+    /**
+     * Get information about a single Sync Product and its Sync Variants.
+     *
+     * @example
+     * ```ts
+     * const product = await client.store.products.retrieve(0);
+     * ```
+     */
+    retrieve(id: number | string, params?: ProductRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<ProductRetrieveResponse>;
+    /**
+     * Modifies an existing Sync Product with its Sync Variants.
+     *
+     * Please note that in the request body you only need to specify the fields that
+     * need to be changed. Furthermore, if you want to update existing sync variants,
+     * then in the sync variants array you must specify the IDs of all existing sync
+     * variants. All omitted existing sync variants will be deleted. All new sync
+     * variants without an ID will be created. See examples for more insights.
+     *
+     * **Rate limiting:** Up to 10 requests per 60 seconds. A 60 seconds lockout is
+     * applied if request count is exceeded.
+     *
+     * [See examples](#tag/Examples/Products-API-examples/Modify-a-Sync-Product)
+     *
+     * @example
+     * ```ts
+     * const product = await client.store.products.update(0);
+     * ```
+     */
+    update(id: number | string, params: ProductUpdateParams, options?: RequestOptions): APIPromise<ProductUpdateResponse>;
+    /**
+     * Returns a list of Sync Product objects from your custom Printful store.
+     *
+     * @example
+     * ```ts
+     * const products = await client.store.products.list();
+     * ```
+     */
+    list(params?: ProductListParams | null | undefined, options?: RequestOptions): APIPromise<ProductListResponse>;
+    /**
+     * Deletes a Sync Product with all of its Sync Variants
+     *
+     * @example
+     * ```ts
+     * const product = await client.store.products.delete(0);
+     * ```
+     */
+    delete(id: number | string, params?: ProductDeleteParams | null | undefined, options?: RequestOptions): APIPromise<ProductDeleteResponse>;
+    /**
+     * Creates a new Sync Variant for an existing Sync Product
+     * ([See examples](#tag/Examples/Products-API-examples/Create-a-new-Sync-Variant)).
+     *
+     * @example
+     * ```ts
+     * const response = await client.store.products.createVariant(
+     *   0,
+     *   {
+     *     files: [
+     *       {
+     *         url: '​https://www.example.com/files/tshirts/example.png',
+     *       },
+     *     ],
+     *     variant_id: 3001,
+     *   },
+     * );
+     * ```
+     */
+    createVariant(id: number | string, params: ProductCreateVariantParams, options?: RequestOptions): APIPromise<ProductCreateVariantResponse>;
+}
+export interface ProductCreateResponse {
+    /**
+     * Response status code `200`
+     */
+    code?: number;
+    /**
+     * Information about the SyncProduct
+     */
+    result?: Shared.SyncProduct;
+}
+export interface ProductRetrieveResponse {
+    /**
+     * Response status code `200`
+     */
+    code?: number;
+    result?: ProductRetrieveResponse.Result;
+}
+export declare namespace ProductRetrieveResponse {
+    interface Result {
+        /**
+         * Information about the SyncProduct
+         */
+        sync_product?: Shared.SyncProduct;
+        /**
+         * Array of Sync Variants available for the selected product
+         */
+        sync_variants?: Array<Shared.SyncVariant>;
+    }
+}
+export interface ProductUpdateResponse {
+    /**
+     * Response status code `200`
+     */
+    code?: number;
+    /**
+     * Information about the SyncProduct
+     */
+    result?: Shared.SyncProduct;
+}
+export interface ProductListResponse {
+    /**
+     * Response status code `200`
+     */
+    code?: number;
+    /**
+     * Paging information
+     */
+    paging?: Shared.Paging;
+    /**
+     * Array of SyncProduct
+     */
+    result?: Array<Shared.SyncProduct>;
+}
+export interface ProductDeleteResponse {
+    /**
+     * Response status code `200`
+     */
+    code?: number;
+    result?: ProductDeleteResponse.Result;
+}
+export declare namespace ProductDeleteResponse {
+    interface Result {
+        /**
+         * Information about the SyncProduct
+         */
+        sync_product?: Shared.SyncProduct;
+        /**
+         * Array of Sync Variants available for the selected product
+         */
+        sync_variants?: Array<Shared.SyncVariant>;
+    }
+}
+export interface ProductCreateVariantResponse {
+    /**
+     * Response status code `200`
+     */
+    code?: number;
+    /**
+     * Information about the SyncVariant
+     */
+    result?: Shared.SyncVariant;
+}
+export interface ProductCreateParams {
+    /**
+     * Body param: Information about the SyncProduct
+     */
+    sync_product: Shared.SyncProduct;
+    /**
+     * Body param: Information about the Sync Variants
+     */
+    sync_variants: Array<Shared.SyncVariant>;
+    /**
+     * 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 ProductRetrieveParams {
+    /**
+     * 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 ProductUpdateParams {
+    /**
+     * Body param: Information about the SyncProduct
+     */
+    sync_product?: Shared.SyncProduct;
+    /**
+     * Body param: Information about the Sync Variants
+     */
+    sync_variants?: Array<ProductUpdateParams.SyncVariant>;
+    /**
+     * 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 declare namespace ProductUpdateParams {
+    /**
+     * Information about the SyncVariant
+     */
+    interface SyncVariant extends Shared.SyncVariant {
+        /**
+         * Sync Variant ID. Please specify the IDs of all Sync Variants you wish to keep.
+         */
+        id?: number;
+    }
+}
+export interface ProductListParams {
+    /**
+     * Query param: A comma-separated list of Category IDs of the Products that are to
+     * be returned
+     */
+    category_id?: string;
+    /**
+     * Query param: Parameter used to filter results by status/group of Sync Products
+     */
+    status?: 'all' | 'synced' | 'unsynced' | 'ignored' | 'imported' | 'discontinued' | 'out_of_stock';
+    /**
+     * 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 ProductDeleteParams {
+    /**
+     * 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 ProductCreateVariantParams {
+    /**
+     * Body param: Array of attached printfiles / preview images
+     */
+    files: Array<ProductCreateVariantParams.File>;
+    /**
+     * Body param: Printful Variant ID that this Sync Variant is synced to
+     */
+    variant_id: number;
+    /**
+     * Body param: Indicates the status of the Sync Variant.
+     */
+    availability_status?: 'active' | 'discontinued' | 'out_of_stock' | 'temporary_out_of_stock';
+    /**
+     * Body param: Variant ID from the Ecommerce platform
+     */
+    external_id?: string;
+    /**
+     * Body param: Indicates if this Sync Variant is ignored
+     */
+    is_ignored?: boolean;
+    /**
+     * Body param: Array of additional options for the configured product/variant
+     * [See examples](#tag/Common/Options)
+     */
+    options?: Array<Shared.ItemOption>;
+    /**
+     * Body param: Short information about the Printful Product and Variant
+     */
+    product?: Shared.ProductVariant;
+    /**
+     * Body param: Retail price that this item is sold for
+     */
+    retail_price?: string;
+    /**
+     * Body param: SKU of this Sync Variant
+     */
+    sku?: string | null;
+    /**
+     * 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 declare namespace ProductCreateVariantParams {
+    /**
+     * Information about the File
+     */
+    interface File extends Shared.File {
+    }
+}
+export declare namespace Products {
+    export { type ProductCreateResponse as ProductCreateResponse, type ProductRetrieveResponse as ProductRetrieveResponse, type ProductUpdateResponse as ProductUpdateResponse, type ProductListResponse as ProductListResponse, type ProductDeleteResponse as ProductDeleteResponse, type ProductCreateVariantResponse as ProductCreateVariantResponse, type ProductCreateParams as ProductCreateParams, type ProductRetrieveParams as ProductRetrieveParams, type ProductUpdateParams as ProductUpdateParams, type ProductListParams as ProductListParams, type ProductDeleteParams as ProductDeleteParams, type ProductCreateVariantParams as ProductCreateVariantParams, };
+}
+//# sourceMappingURL=products.d.mts.map

package/resources/store/products.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"products.d.mts","sourceRoot":"","sources":["../../src/resources/store/products.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,MAAM,CAAC,MAAM,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAahG;;;;;;;OAOG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,GAAG,MAAM,EACnB,MAAM,GAAE,qBAAqB,GAAG,IAAI,GAAG,SAAc,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uBAAuB,CAAC;IAYtC;;;;;;;;;;;;;;;;;;OAkBG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,GAAG,MAAM,EACnB,MAAM,EAAE,mBAAmB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,qBAAqB,CAAC;IAapC;;;;;;;OAOG;IACH,IAAI,CACF,MAAM,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mBAAmB,CAAC;IAalC;;;;;;;OAOG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,GAAG,MAAM,EACnB,MAAM,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,qBAAqB,CAAC;IAYpC;;;;;;;;;;;;;;;;;;OAkBG;IACH,aAAa,CACX,EAAE,EAAE,MAAM,GAAG,MAAM,EACnB,MAAM,EAAE,0BAA0B,EAClC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,4BAA4B,CAAC;CAY5C;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC,WAAW,CAAC;CAC7B;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,MAAM,CAAC,EAAE,uBAAuB,CAAC,MAAM,CAAC;CACzC;AAED,yBAAiB,uBAAuB,CAAC;IACvC,UAAiB,MAAM;QACrB;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC,WAAW,CAAC;QAElC;;WAEG;QACH,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;KAC3C;CACF;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC,WAAW,CAAC;CAC7B;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC;IAEvB;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;CACpC;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,MAAM,CAAC,EAAE,qBAAqB,CAAC,MAAM,CAAC;CACvC;AAED,yBAAiB,qBAAqB,CAAC;IACrC,UAAiB,MAAM;QACrB;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC,WAAW,CAAC;QAElC;;WAEG;QACH,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;KAC3C;CACF;AAED,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC,WAAW,CAAC;CAC7B;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC,WAAW,CAAC;IAEjC;;OAEG;IACH,aAAa,EAAE,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;IAEzC;;;;;;;OAOG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,qBAAqB;IACpC;;;;;;;OAOG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,WAAW,CAAC;IAElC;;OAEG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC,mBAAmB,CAAC,WAAW,CAAC,CAAC;IAEvD;;;;;;;OAOG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;OAEG;IACH,UAAiB,WAAY,SAAQ,MAAM,CAAC,WAAW;QACrD;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;KACb;CACF;AAED,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,GAAG,QAAQ,GAAG,UAAU,GAAG,SAAS,GAAG,UAAU,GAAG,cAAc,GAAG,cAAc,CAAC;IAElG;;;;;;;OAOG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,mBAAmB;IAClC;;;;;;;OAOG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC,0BAA0B,CAAC,IAAI,CAAC,CAAC;IAE9C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,mBAAmB,CAAC,EAAE,QAAQ,GAAG,cAAc,GAAG,cAAc,GAAG,wBAAwB,CAAC;IAE5F;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;IAEnC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,cAAc,CAAC;IAEhC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB;;;;;;;OAOG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,yBAAiB,0BAA0B,CAAC;IAC1C;;OAEG;IACH,UAAiB,IAAK,SAAQ,MAAM,CAAC,IAAI;KAAG;CAC7C;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,0BAA0B,IAAI,0BAA0B,GAC9D,CAAC;CACH"}

package/resources/store/products.d.ts

@@ -0,0 +1,327 @@
+import { APIResource } from "../../core/resource.js";
+import * as Shared from "../shared.js";
+import { APIPromise } from "../../core/api-promise.js";
+import { RequestOptions } from "../../internal/request-options.js";
+export declare class Products extends APIResource {
+    /**
+     * Creates a new Sync Product together with its Sync Variants
+     * ([See examples](#tag/Products-API/operation/createSyncProduct)).
+     *
+     * @example
+     * ```ts
+     * const product = await client.store.products.create({
+     *   sync_product: { name: 'T-shirt' },
+     *   sync_variants: [
+     *     {
+     *       files: [
+     *         {
+     *           url: '​https://www.example.com/files/tshirts/example.png',
+     *         },
+     *       ],
+     *       variant_id: 3001,
+     *     },
+     *   ],
+     * });
+     * ```
+     */
+    create(params: ProductCreateParams, options?: RequestOptions): APIPromise<ProductCreateResponse>;
+    /**
+     * Get information about a single Sync Product and its Sync Variants.
+     *
+     * @example
+     * ```ts
+     * const product = await client.store.products.retrieve(0);
+     * ```
+     */
+    retrieve(id: number | string, params?: ProductRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<ProductRetrieveResponse>;
+    /**
+     * Modifies an existing Sync Product with its Sync Variants.
+     *
+     * Please note that in the request body you only need to specify the fields that
+     * need to be changed. Furthermore, if you want to update existing sync variants,
+     * then in the sync variants array you must specify the IDs of all existing sync
+     * variants. All omitted existing sync variants will be deleted. All new sync
+     * variants without an ID will be created. See examples for more insights.
+     *
+     * **Rate limiting:** Up to 10 requests per 60 seconds. A 60 seconds lockout is
+     * applied if request count is exceeded.
+     *
+     * [See examples](#tag/Examples/Products-API-examples/Modify-a-Sync-Product)
+     *
+     * @example
+     * ```ts
+     * const product = await client.store.products.update(0);
+     * ```
+     */
+    update(id: number | string, params: ProductUpdateParams, options?: RequestOptions): APIPromise<ProductUpdateResponse>;
+    /**
+     * Returns a list of Sync Product objects from your custom Printful store.
+     *
+     * @example
+     * ```ts
+     * const products = await client.store.products.list();
+     * ```
+     */
+    list(params?: ProductListParams | null | undefined, options?: RequestOptions): APIPromise<ProductListResponse>;
+    /**
+     * Deletes a Sync Product with all of its Sync Variants
+     *
+     * @example
+     * ```ts
+     * const product = await client.store.products.delete(0);
+     * ```
+     */
+    delete(id: number | string, params?: ProductDeleteParams | null | undefined, options?: RequestOptions): APIPromise<ProductDeleteResponse>;
+    /**
+     * Creates a new Sync Variant for an existing Sync Product
+     * ([See examples](#tag/Examples/Products-API-examples/Create-a-new-Sync-Variant)).
+     *
+     * @example
+     * ```ts
+     * const response = await client.store.products.createVariant(
+     *   0,
+     *   {
+     *     files: [
+     *       {
+     *         url: '​https://www.example.com/files/tshirts/example.png',
+     *       },
+     *     ],
+     *     variant_id: 3001,
+     *   },
+     * );
+     * ```
+     */
+    createVariant(id: number | string, params: ProductCreateVariantParams, options?: RequestOptions): APIPromise<ProductCreateVariantResponse>;
+}
+export interface ProductCreateResponse {
+    /**
+     * Response status code `200`
+     */
+    code?: number;
+    /**
+     * Information about the SyncProduct
+     */
+    result?: Shared.SyncProduct;
+}
+export interface ProductRetrieveResponse {
+    /**
+     * Response status code `200`
+     */
+    code?: number;
+    result?: ProductRetrieveResponse.Result;
+}
+export declare namespace ProductRetrieveResponse {
+    interface Result {
+        /**
+         * Information about the SyncProduct
+         */
+        sync_product?: Shared.SyncProduct;
+        /**
+         * Array of Sync Variants available for the selected product
+         */
+        sync_variants?: Array<Shared.SyncVariant>;
+    }
+}
+export interface ProductUpdateResponse {
+    /**
+     * Response status code `200`
+     */
+    code?: number;
+    /**
+     * Information about the SyncProduct
+     */
+    result?: Shared.SyncProduct;
+}
+export interface ProductListResponse {
+    /**
+     * Response status code `200`
+     */
+    code?: number;
+    /**
+     * Paging information
+     */
+    paging?: Shared.Paging;
+    /**
+     * Array of SyncProduct
+     */
+    result?: Array<Shared.SyncProduct>;
+}
+export interface ProductDeleteResponse {
+    /**
+     * Response status code `200`
+     */
+    code?: number;
+    result?: ProductDeleteResponse.Result;
+}
+export declare namespace ProductDeleteResponse {
+    interface Result {
+        /**
+         * Information about the SyncProduct
+         */
+        sync_product?: Shared.SyncProduct;
+        /**
+         * Array of Sync Variants available for the selected product
+         */
+        sync_variants?: Array<Shared.SyncVariant>;
+    }
+}
+export interface ProductCreateVariantResponse {
+    /**
+     * Response status code `200`
+     */
+    code?: number;
+    /**
+     * Information about the SyncVariant
+     */
+    result?: Shared.SyncVariant;
+}
+export interface ProductCreateParams {
+    /**
+     * Body param: Information about the SyncProduct
+     */
+    sync_product: Shared.SyncProduct;
+    /**
+     * Body param: Information about the Sync Variants
+     */
+    sync_variants: Array<Shared.SyncVariant>;
+    /**
+     * 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 ProductRetrieveParams {
+    /**
+     * 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 ProductUpdateParams {
+    /**
+     * Body param: Information about the SyncProduct
+     */
+    sync_product?: Shared.SyncProduct;
+    /**
+     * Body param: Information about the Sync Variants
+     */
+    sync_variants?: Array<ProductUpdateParams.SyncVariant>;
+    /**
+     * 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 declare namespace ProductUpdateParams {
+    /**
+     * Information about the SyncVariant
+     */
+    interface SyncVariant extends Shared.SyncVariant {
+        /**
+         * Sync Variant ID. Please specify the IDs of all Sync Variants you wish to keep.
+         */
+        id?: number;
+    }
+}
+export interface ProductListParams {
+    /**
+     * Query param: A comma-separated list of Category IDs of the Products that are to
+     * be returned
+     */
+    category_id?: string;
+    /**
+     * Query param: Parameter used to filter results by status/group of Sync Products
+     */
+    status?: 'all' | 'synced' | 'unsynced' | 'ignored' | 'imported' | 'discontinued' | 'out_of_stock';
+    /**
+     * 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 ProductDeleteParams {
+    /**
+     * 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 ProductCreateVariantParams {
+    /**
+     * Body param: Array of attached printfiles / preview images
+     */
+    files: Array<ProductCreateVariantParams.File>;
+    /**
+     * Body param: Printful Variant ID that this Sync Variant is synced to
+     */
+    variant_id: number;
+    /**
+     * Body param: Indicates the status of the Sync Variant.
+     */
+    availability_status?: 'active' | 'discontinued' | 'out_of_stock' | 'temporary_out_of_stock';
+    /**
+     * Body param: Variant ID from the Ecommerce platform
+     */
+    external_id?: string;
+    /**
+     * Body param: Indicates if this Sync Variant is ignored
+     */
+    is_ignored?: boolean;
+    /**
+     * Body param: Array of additional options for the configured product/variant
+     * [See examples](#tag/Common/Options)
+     */
+    options?: Array<Shared.ItemOption>;
+    /**
+     * Body param: Short information about the Printful Product and Variant
+     */
+    product?: Shared.ProductVariant;
+    /**
+     * Body param: Retail price that this item is sold for
+     */
+    retail_price?: string;
+    /**
+     * Body param: SKU of this Sync Variant
+     */
+    sku?: string | null;
+    /**
+     * 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 declare namespace ProductCreateVariantParams {
+    /**
+     * Information about the File
+     */
+    interface File extends Shared.File {
+    }
+}
+export declare namespace Products {
+    export { type ProductCreateResponse as ProductCreateResponse, type ProductRetrieveResponse as ProductRetrieveResponse, type ProductUpdateResponse as ProductUpdateResponse, type ProductListResponse as ProductListResponse, type ProductDeleteResponse as ProductDeleteResponse, type ProductCreateVariantResponse as ProductCreateVariantResponse, type ProductCreateParams as ProductCreateParams, type ProductRetrieveParams as ProductRetrieveParams, type ProductUpdateParams as ProductUpdateParams, type ProductListParams as ProductListParams, type ProductDeleteParams as ProductDeleteParams, type ProductCreateVariantParams as ProductCreateVariantParams, };
+}
+//# sourceMappingURL=products.d.ts.map

package/resources/store/products.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"products.d.ts","sourceRoot":"","sources":["../../src/resources/store/products.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,MAAM,CAAC,MAAM,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAahG;;;;;;;OAOG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,GAAG,MAAM,EACnB,MAAM,GAAE,qBAAqB,GAAG,IAAI,GAAG,SAAc,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uBAAuB,CAAC;IAYtC;;;;;;;;;;;;;;;;;;OAkBG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,GAAG,MAAM,EACnB,MAAM,EAAE,mBAAmB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,qBAAqB,CAAC;IAapC;;;;;;;OAOG;IACH,IAAI,CACF,MAAM,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mBAAmB,CAAC;IAalC;;;;;;;OAOG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,GAAG,MAAM,EACnB,MAAM,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,qBAAqB,CAAC;IAYpC;;;;;;;;;;;;;;;;;;OAkBG;IACH,aAAa,CACX,EAAE,EAAE,MAAM,GAAG,MAAM,EACnB,MAAM,EAAE,0BAA0B,EAClC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,4BAA4B,CAAC;CAY5C;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC,WAAW,CAAC;CAC7B;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,MAAM,CAAC,EAAE,uBAAuB,CAAC,MAAM,CAAC;CACzC;AAED,yBAAiB,uBAAuB,CAAC;IACvC,UAAiB,MAAM;QACrB;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC,WAAW,CAAC;QAElC;;WAEG;QACH,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;KAC3C;CACF;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC,WAAW,CAAC;CAC7B;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC;IAEvB;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;CACpC;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,MAAM,CAAC,EAAE,qBAAqB,CAAC,MAAM,CAAC;CACvC;AAED,yBAAiB,qBAAqB,CAAC;IACrC,UAAiB,MAAM;QACrB;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC,WAAW,CAAC;QAElC;;WAEG;QACH,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;KAC3C;CACF;AAED,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC,WAAW,CAAC;CAC7B;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC,WAAW,CAAC;IAEjC;;OAEG;IACH,aAAa,EAAE,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;IAEzC;;;;;;;OAOG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,qBAAqB;IACpC;;;;;;;OAOG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,WAAW,CAAC;IAElC;;OAEG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC,mBAAmB,CAAC,WAAW,CAAC,CAAC;IAEvD;;;;;;;OAOG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;OAEG;IACH,UAAiB,WAAY,SAAQ,MAAM,CAAC,WAAW;QACrD;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;KACb;CACF;AAED,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,GAAG,QAAQ,GAAG,UAAU,GAAG,SAAS,GAAG,UAAU,GAAG,cAAc,GAAG,cAAc,CAAC;IAElG;;;;;;;OAOG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,mBAAmB;IAClC;;;;;;;OAOG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC,0BAA0B,CAAC,IAAI,CAAC,CAAC;IAE9C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,mBAAmB,CAAC,EAAE,QAAQ,GAAG,cAAc,GAAG,cAAc,GAAG,wBAAwB,CAAC;IAE5F;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;IAEnC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,cAAc,CAAC;IAEhC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB;;;;;;;OAOG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,yBAAiB,0BAA0B,CAAC;IAC1C;;OAEG;IACH,UAAiB,IAAK,SAAQ,MAAM,CAAC,IAAI;KAAG;CAC7C;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,0BAA0B,IAAI,0BAA0B,GAC9D,CAAC;CACH"}