@vymalo/medusa-printful/dist/core/generated/printful/sdk.gen.d.ts

Connect your MedusaJS store to Printful

import type { Options as ClientOptions, TDataShape, Client } from '@hey-api/client-axios';
import type { GetProductsData, GetVariantByIdData, GetProductByIdData, GetProductSizeGuideByIdData, GetCategoriesData, GetCategoryByIdData, GetSyncProductsData, CreateSyncProductData, CreateSyncProductError, DeleteSyncProductData, DeleteSyncProductError, GetSyncProductByIdData, GetSyncProductByIdError, UpdateSyncProductData, UpdateSyncProductError, DeleteSyncVariantData, DeleteSyncVariantError, GetSyncVariantByIdData, GetSyncVariantByIdError, UpdateSyncVariantData, UpdateSyncVariantError, CreateSyncVariantData, CreateSyncVariantError, GetProductTemplatesData, DeleteProductTemplateData, GetProductTemplateByIdData, GetOrdersData, CreateOrderData, CreateOrderError, CancelOrderByIdData, CancelOrderByIdError, GetOrderByIdData, GetOrderByIdError, UpdateOrderByIdData, UpdateOrderByIdError, ConfirmOrderByIdData, ConfirmOrderByIdError, EstimateOrderCostsData, EstimateOrderCostsError, AddFileData, AddFileError, GetFileData, GetFileError, ThreadColorsData, ThreadColorsError, GetStoreSyncProductsData, DeleteStoreSyncProductData, DeleteStoreSyncProductError, GetStoreSyncProductByIdData, GetStoreSyncProductByIdError, DeleteStoreSyncVariantData, DeleteStoreSyncVariantError, GetStoreSyncVariantByIdData, GetStoreSyncVariantByIdError, UpdateStoreSyncVariantData, UpdateStoreSyncVariantError, CalculateShippingRatesData, CalculateShippingRatesError, GetCountriesData, GetTaxCountriesData, GetTaxCountriesError, CalculateTaxRatesData, ChangePackingSlipData, ChangePackingSlipError, GetStoresData, GetStoresError, GetStoreData, GetStoreError, CreateGeneratorTaskData, CreateGeneratorTaskError, GetPrintfilesData, GetPrintfilesError, GetTaskData, GetTaskError, GetTemplatesData, GetTemplatesError, GetWarehouseProductsData, GetWarehouseProductData, GetWarehouseProductError, GetApprovalSheetsData, GetApprovalSheetsError, ApproveDesignData, ApproveDesignError, SubmitApprovalSheetChangesData, SubmitApprovalSheetChangesError, DisableWebhookData, GetWebhooksData, CreateWebhookData, CreateWebhookError, GetScopesData, GetScopesError, GetStatisticsData, GetStatisticsError } from './types.gen';
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = ClientOptions<TData, ThrowOnError> & {
    client?: Client;
    meta?: Record<string, unknown>;
};
export declare class CatalogApiService {
    static getProducts<ThrowOnError extends boolean = true>(options?: Options<GetProductsData, ThrowOnError>): import("@hey-api/client-axios").RequestResult<import("./types.gen").Response200 & {
        result?: Array<import("./types.gen").Product>;
    }, {
        code?: number;
        result?: string;
        error?: {
            reason?: string;
            message?: string;
        };
    }, ThrowOnError>;
    static getVariantById<ThrowOnError extends boolean = true>(options: Options<GetVariantByIdData, ThrowOnError>): import("@hey-api/client-axios").RequestResult<import("./types.gen").Response200 & {
        result?: {
            variant?: import("./types.gen").Variant;
            product?: import("./types.gen").Product;
        };
    }, {
        code?: number;
        result?: string;
        error?: {
            reason?: string;
            message?: string;
        };
    }, ThrowOnError>;
    static getProductById<ThrowOnError extends boolean = true>(options: Options<GetProductByIdData, ThrowOnError>): import("@hey-api/client-axios").RequestResult<import("./types.gen").Response200 & {
        result?: import("./types.gen").ProductInfo;
    }, {
        code?: number;
        result?: string;
        error?: {
            reason?: string;
            message?: string;
        };
    }, ThrowOnError>;
    static getProductSizeGuideById<ThrowOnError extends boolean = true>(options: Options<GetProductSizeGuideByIdData, ThrowOnError>): import("@hey-api/client-axios").RequestResult<import("./types.gen").Response200 & {
        result?: import("./types.gen").ProductSizeGuide;
    }, {
        code?: number;
        result?: string;
        error?: {
            reason?: string;
            message?: string;
        };
    }, ThrowOnError>;
    static getCategories<ThrowOnError extends boolean = true>(options?: Options<GetCategoriesData, ThrowOnError>): import("@hey-api/client-axios").RequestResult<import("./types.gen").Response200 & {
        result?: Array<import("./types.gen").Category>;
    }, {
        code?: number;
        result?: string;
        error?: {
            reason?: string;
            message?: string;
        };
    }, ThrowOnError>;
    static getCategoryById<ThrowOnError extends boolean = true>(options: Options<GetCategoryByIdData, ThrowOnError>): import("@hey-api/client-axios").RequestResult<import("./types.gen").Response200 & {
        result?: import("./types.gen").Category;
    }, {
        code?: number;
        result?: string;
        error?: {
            reason?: string;
            message?: string;
        };
    }, ThrowOnError>;
}
export declare class ProductsApiService {
    static getSyncProducts<ThrowOnError extends boolean = true>(options?: Options<GetSyncProductsData, ThrowOnError>): import("@hey-api/client-axios").RequestResult<import("./types.gen").Response200 & {
        paging?: import("./types.gen").Paging;
    } & {
        result?: Array<import("./types.gen").SyncProduct>;
    }, {
        code?: number;
        result?: string;
        error?: {
            reason?: string;
            message?: string;
        };
    }, ThrowOnError>;
    static createSyncProduct<ThrowOnError extends boolean = true>(options: Options<CreateSyncProductData, ThrowOnError>): import("@hey-api/client-axios").RequestResult<import("./types.gen").Response200 & {
        result?: import("./types.gen").SyncProduct;
    }, CreateSyncProductError, ThrowOnError>;
    static deleteSyncProduct<ThrowOnError extends boolean = true>(options: Options<DeleteSyncProductData, ThrowOnError>): import("@hey-api/client-axios").RequestResult<import("./types.gen").Response200 & {
        result?: {
            sync_product?: import("./types.gen").SyncProduct;
            sync_variants?: Array<import("./types.gen").SyncVariant>;
        };
    }, DeleteSyncProductError, ThrowOnError>;
    static getSyncProductById<ThrowOnError extends boolean = true>(options: Options<GetSyncProductByIdData, ThrowOnError>): import("@hey-api/client-axios").RequestResult<import("./types.gen").Response200 & {
        result?: {
            sync_product?: import("./types.gen").SyncProduct;
            sync_variants?: Array<import("./types.gen").SyncVariant>;
        };
    }, GetSyncProductByIdError, ThrowOnError>;
    static updateSyncProduct<ThrowOnError extends boolean = true>(options: Options<UpdateSyncProductData, ThrowOnError>): import("@hey-api/client-axios").RequestResult<import("./types.gen").Response200 & {
        result?: import("./types.gen").SyncProduct;
    }, UpdateSyncProductError, ThrowOnError>;
    static deleteSyncVariant<ThrowOnError extends boolean = true>(options: Options<DeleteSyncVariantData, ThrowOnError>): import("@hey-api/client-axios").RequestResult<{
        code?: number;
        result?: Array<unknown>;
    }, DeleteSyncVariantError, ThrowOnError>;
    static getSyncVariantById<ThrowOnError extends boolean = true>(options: Options<GetSyncVariantByIdData, ThrowOnError>): import("@hey-api/client-axios").RequestResult<{
        code?: number;
        result?: import("./types.gen").SyncVariant;
    }, GetSyncVariantByIdError, ThrowOnError>;
    static updateSyncVariant<ThrowOnError extends boolean = true>(options: Options<UpdateSyncVariantData, ThrowOnError>): import("@hey-api/client-axios").RequestResult<{
        code?: number;
        result?: import("./types.gen").SyncVariant;
    }, UpdateSyncVariantError, ThrowOnError>;
    static createSyncVariant<ThrowOnError extends boolean = true>(options: Options<CreateSyncVariantData, ThrowOnError>): import("@hey-api/client-axios").RequestResult<{
        code?: number;
        result?: import("./types.gen").SyncVariant;
    }, CreateSyncVariantError, ThrowOnError>;
}
export declare class ProductTemplatesApiService {
    static getProductTemplates<ThrowOnError extends boolean = true>(options?: Options<GetProductTemplatesData, ThrowOnError>): import("@hey-api/client-axios").RequestResult<import("./types.gen").Response200 & {
        result?: import("./types.gen").Templates;
        paging?: import("./types.gen").Paging;
    }, {
        code?: number;
        result?: string;
        error?: {
            reason?: string;
            message?: string;
        };
    }, ThrowOnError>;
    static deleteProductTemplate<ThrowOnError extends boolean = true>(options: Options<DeleteProductTemplateData, ThrowOnError>): import("@hey-api/client-axios").RequestResult<import("./types.gen").Response200 & {
        result?: {
            success?: boolean;
        };
    }, {
        code?: number;
        result?: string;
        error?: {
            reason?: string;
            message?: string;
        };
    }, ThrowOnError>;
    static getProductTemplateById<ThrowOnError extends boolean = true>(options: Options<GetProductTemplateByIdData, ThrowOnError>): import("@hey-api/client-axios").RequestResult<import("./types.gen").Response200 & {
        result?: import("./types.gen").TemplateById;
    }, {
        code?: number;
        result?: string;
        error?: {
            reason?: string;
            message?: string;
        };
    }, ThrowOnError>;
}
export declare class OrdersApiService {
    static getOrders<ThrowOnError extends boolean = true>(options?: Options<GetOrdersData, ThrowOnError>): import("@hey-api/client-axios").RequestResult<import("./types.gen").Response200 & {
        paging?: import("./types.gen").Paging;
    } & {
        result?: Array<import("./types.gen").Order>;
    }, {
        code?: number;
        result?: string;
        error?: {
            reason?: string;
            message?: string;
        };
    }, ThrowOnError>;
    static createOrder<ThrowOnError extends boolean = true>(options: Options<CreateOrderData, ThrowOnError>): import("@hey-api/client-axios").RequestResult<import("./types.gen").Response200 & {
        result?: import("./types.gen").Order;
    }, CreateOrderError, ThrowOnError>;
    static cancelOrderById<ThrowOnError extends boolean = true>(options: Options<CancelOrderByIdData, ThrowOnError>): import("@hey-api/client-axios").RequestResult<import("./types.gen").Response200 & {
        result?: import("./types.gen").Order;
    }, CancelOrderByIdError, ThrowOnError>;
    static getOrderById<ThrowOnError extends boolean = true>(options: Options<GetOrderByIdData, ThrowOnError>): import("@hey-api/client-axios").RequestResult<import("./types.gen").Response200 & {
        result?: import("./types.gen").Order;
    }, GetOrderByIdError, ThrowOnError>;
    static updateOrderById<ThrowOnError extends boolean = true>(options: Options<UpdateOrderByIdData, ThrowOnError>): import("@hey-api/client-axios").RequestResult<import("./types.gen").Response200 & {
        result?: import("./types.gen").Order;
    }, UpdateOrderByIdError, ThrowOnError>;
    static confirmOrderById<ThrowOnError extends boolean = true>(options: Options<ConfirmOrderByIdData, ThrowOnError>): import("@hey-api/client-axios").RequestResult<import("./types.gen").Response200 & {
        result?: import("./types.gen").Order;
    }, ConfirmOrderByIdError, ThrowOnError>;
    static estimateOrderCosts<ThrowOnError extends boolean = true>(options: Options<EstimateOrderCostsData, ThrowOnError>): import("@hey-api/client-axios").RequestResult<import("./types.gen").Response200 & {
        result?: {
            costs?: import("./types.gen").OrderEstimateCosts;
            retail_costs?: import("./types.gen").OrderEstimateRetailCosts;
        };
    }, EstimateOrderCostsError, ThrowOnError>;
}
export declare class FileLibraryApiService {
    static addFile<ThrowOnError extends boolean = true>(options: Options<AddFileData, ThrowOnError>): import("@hey-api/client-axios").RequestResult<import("./types.gen").Response200 & {
        result?: import("./types.gen").File;
    }, AddFileError, ThrowOnError>;
    static getFile<ThrowOnError extends boolean = true>(options: Options<GetFileData, ThrowOnError>): import("@hey-api/client-axios").RequestResult<import("./types.gen").Response200 & {
        result?: import("./types.gen").File;
    }, GetFileError, ThrowOnError>;
    static threadColors<ThrowOnError extends boolean = true>(options: Options<ThreadColorsData, ThrowOnError>): import("@hey-api/client-axios").RequestResult<import("./types.gen").Response200 & {
        thread_colors?: Array<string>;
    }, ThreadColorsError, ThrowOnError>;
}
export declare class EcommercePlatformSyncApiService {
    static getStoreSyncProducts<ThrowOnError extends boolean = true>(options?: Options<GetStoreSyncProductsData, ThrowOnError>): import("@hey-api/client-axios").RequestResult<import("./types.gen").Response200 & {
        paging?: import("./types.gen").Paging;
    } & {
        result?: Array<import("./types.gen").SyncProduct>;
    }, {
        code?: number;
        result?: string;
        error?: {
            reason?: string;
            message?: string;
        };
    }, ThrowOnError>;
    static deleteStoreSyncProduct<ThrowOnError extends boolean = true>(options: Options<DeleteStoreSyncProductData, ThrowOnError>): import("@hey-api/client-axios").RequestResult<import("./types.gen").Response200 & {
        result?: {
            sync_product?: import("./types.gen").SyncProduct;
            sync_variants?: Array<import("./types.gen").SyncVariant>;
        };
    }, DeleteStoreSyncProductError, ThrowOnError>;
    static getStoreSyncProductById<ThrowOnError extends boolean = true>(options: Options<GetStoreSyncProductByIdData, ThrowOnError>): import("@hey-api/client-axios").RequestResult<import("./types.gen").Response200 & {
        result?: {
            sync_product?: import("./types.gen").SyncProduct;
            sync_variants?: Array<import("./types.gen").SyncVariant>;
        };
    }, GetStoreSyncProductByIdError, ThrowOnError>;
    static deleteStoreSyncVariant<ThrowOnError extends boolean = true>(options: Options<DeleteStoreSyncVariantData, ThrowOnError>): import("@hey-api/client-axios").RequestResult<import("./types.gen").Response200 & {
        result?: {
            sync_variant?: import("./types.gen").SyncVariant;
            sync_product?: import("./types.gen").SyncProduct;
        };
    }, DeleteStoreSyncVariantError, ThrowOnError>;
    static getStoreSyncVariantById<ThrowOnError extends boolean = true>(options: Options<GetStoreSyncVariantByIdData, ThrowOnError>): import("@hey-api/client-axios").RequestResult<import("./types.gen").Response200 & {
        result?: {
            sync_variant?: import("./types.gen").SyncVariant;
            sync_product?: import("./types.gen").SyncProduct;
        };
    }, GetStoreSyncVariantByIdError, ThrowOnError>;
    static updateStoreSyncVariant<ThrowOnError extends boolean = true>(options: Options<UpdateStoreSyncVariantData, ThrowOnError>): import("@hey-api/client-axios").RequestResult<import("./types.gen").Response200 & {
        result?: {
            sync_variant?: import("./types.gen").SyncVariant;
            sync_product?: import("./types.gen").SyncProduct;
        };
    }, UpdateStoreSyncVariantError, ThrowOnError>;
}
export declare class ShippingRateApiService {
    static calculateShippingRates<ThrowOnError extends boolean = true>(options: Options<CalculateShippingRatesData, ThrowOnError>): import("@hey-api/client-axios").RequestResult<{
        code?: number;
        result?: Array<import("./types.gen").ShippingInfo>;
    }, CalculateShippingRatesError, ThrowOnError>;
}
export declare class CountryStateCodeApiService {
    static getCountries<ThrowOnError extends boolean = true>(options?: Options<GetCountriesData, ThrowOnError>): import("@hey-api/client-axios").RequestResult<import("./types.gen").Response200 & {
        result?: Array<import("./types.gen").Country>;
    }, {
        code?: number;
        result?: string;
        error?: {
            reason?: string;
            message?: string;
        };
    }, ThrowOnError>;
}
export declare class TaxRateApiService {
    static getTaxCountries<ThrowOnError extends boolean = true>(options?: Options<GetTaxCountriesData, ThrowOnError>): import("@hey-api/client-axios").RequestResult<{
        code?: number;
        result?: Array<import("./types.gen").Country & {
            states?: Array<{
                shipping_taxable?: boolean;
            }>;
        }>;
    }, GetTaxCountriesError, ThrowOnError>;
    static calculateTaxRates<ThrowOnError extends boolean = true>(options: Options<CalculateTaxRatesData, ThrowOnError>): import("@hey-api/client-axios").RequestResult<{
        code?: number;
        result?: import("./types.gen").TaxInfo;
    }, {
        code?: number;
        result?: string;
        error?: {
            reason?: string;
            message?: string;
        };
    }, ThrowOnError>;
}
export declare class StoreInformationApiService {
    static changePackingSlip<ThrowOnError extends boolean = true>(options: Options<ChangePackingSlipData, ThrowOnError>): import("@hey-api/client-axios").RequestResult<{
        code?: number;
        result?: {
            packing_slip?: import("./types.gen").PackingSlip;
        };
    }, ChangePackingSlipError, ThrowOnError>;
    static getStores<ThrowOnError extends boolean = true>(options?: Options<GetStoresData, ThrowOnError>): import("@hey-api/client-axios").RequestResult<import("./types.gen").Response200 & {
        paging?: import("./types.gen").Paging;
    } & {
        result?: Array<import("./types.gen").StoreSummary>;
    }, GetStoresError, ThrowOnError>;
    static getStore<ThrowOnError extends boolean = true>(options: Options<GetStoreData, ThrowOnError>): import("@hey-api/client-axios").RequestResult<import("./types.gen").Response200 & {
        result?: import("./types.gen").StoreDetails;
    }, GetStoreError, ThrowOnError>;
}
export declare class MockupGeneratorApiService {
    static createGeneratorTask<ThrowOnError extends boolean = true>(options: Options<CreateGeneratorTaskData, ThrowOnError>): import("@hey-api/client-axios").RequestResult<import("./types.gen").Response200 & {
        result?: import("./types.gen").GenerationTask;
    }, CreateGeneratorTaskError, ThrowOnError>;
    static getPrintfiles<ThrowOnError extends boolean = true>(options: Options<GetPrintfilesData, ThrowOnError>): import("@hey-api/client-axios").RequestResult<import("./types.gen").Response200 & {
        result?: import("./types.gen").PrintfileInfo;
    }, GetPrintfilesError, ThrowOnError>;
    static getTask<ThrowOnError extends boolean = true>(options: Options<GetTaskData, ThrowOnError>): import("@hey-api/client-axios").RequestResult<import("./types.gen").Response200 & {
        result?: import("./types.gen").GenerationTask;
    }, GetTaskError, ThrowOnError>;
    static getTemplates<ThrowOnError extends boolean = true>(options: Options<GetTemplatesData, ThrowOnError>): import("@hey-api/client-axios").RequestResult<import("./types.gen").Response200 & {
        result?: import("./types.gen").ProductTemplate;
    }, GetTemplatesError, ThrowOnError>;
}
export declare class WarehouseProductsApiService {
    static getWarehouseProducts<ThrowOnError extends boolean = true>(options?: Options<GetWarehouseProductsData, ThrowOnError>): import("@hey-api/client-axios").RequestResult<import("./types.gen").Response200 & {
        result?: Array<import("./types.gen").WarehouseProduct>;
        paging?: import("./types.gen").Paging;
    }, {
        code?: number;
        result?: string;
        error?: {
            reason?: string;
            message?: string;
        };
    }, ThrowOnError>;
    static getWarehouseProduct<ThrowOnError extends boolean = true>(options: Options<GetWarehouseProductData, ThrowOnError>): import("@hey-api/client-axios").RequestResult<import("./types.gen").Response200 & {
        result?: import("./types.gen").WarehouseProduct;
    }, GetWarehouseProductError, ThrowOnError>;
}
export declare class ApprovalSheetsApiService {
    static getApprovalSheets<ThrowOnError extends boolean = true>(options?: Options<GetApprovalSheetsData, ThrowOnError>): import("@hey-api/client-axios").RequestResult<import("./types.gen").Response200 & {
        result?: Array<import("./types.gen").ApprovalSheet>;
    }, GetApprovalSheetsError, ThrowOnError>;
    static approveDesign<ThrowOnError extends boolean = true>(options: Options<ApproveDesignData, ThrowOnError>): import("@hey-api/client-axios").RequestResult<import("./types.gen").Response200 & {
        result?: {
            message?: string;
        };
    }, ApproveDesignError, ThrowOnError>;
    static submitApprovalSheetChanges<ThrowOnError extends boolean = true>(options: Options<SubmitApprovalSheetChangesData, ThrowOnError>): import("@hey-api/client-axios").RequestResult<import("./types.gen").Response200 & {
        result?: import("./types.gen").ApprovalSheet;
    }, SubmitApprovalSheetChangesError, ThrowOnError>;
}
export declare class WebhookApiService {
    static disableWebhook<ThrowOnError extends boolean = true>(options?: Options<DisableWebhookData, ThrowOnError>): import("@hey-api/client-axios").RequestResult<import("./types.gen").Response200 & {
        result?: import("./types.gen").WebhookInfo;
    }, {
        code?: number;
        result?: string;
        error?: {
            reason?: string;
            message?: string;
        };
    }, ThrowOnError>;
    static getWebhooks<ThrowOnError extends boolean = true>(options?: Options<GetWebhooksData, ThrowOnError>): import("@hey-api/client-axios").RequestResult<import("./types.gen").Response200 & {
        result?: import("./types.gen").WebhookInfo;
    }, {
        code?: number;
        result?: string;
        error?: {
            reason?: string;
            message?: string;
        };
    }, ThrowOnError>;
    static createWebhook<ThrowOnError extends boolean = true>(options: Options<CreateWebhookData, ThrowOnError>): import("@hey-api/client-axios").RequestResult<import("./types.gen").Response200 & {
        result?: import("./types.gen").WebhookInfo;
    }, CreateWebhookError, ThrowOnError>;
}
export declare class OAuthApiService {
    static getScopes<ThrowOnError extends boolean = true>(options?: Options<GetScopesData, ThrowOnError>): import("@hey-api/client-axios").RequestResult<import("./types.gen").Response200 & {
        result?: {
            scopes?: Array<{
                scope?: string;
                display_name?: string;
            }>;
        };
    }, GetScopesError, ThrowOnError>;
}
export declare class ReportsApiService {
    static getStatistics<ThrowOnError extends boolean = true>(options: Options<GetStatisticsData, ThrowOnError>): import("@hey-api/client-axios").RequestResult<{
        code?: number;
        result?: import("./types.gen").Statistics;
    }, GetStatisticsError, ThrowOnError>;
}