@teemill/website 0.3.0 → 0.4.0

package/dist/esm/api.d.ts

@@ -2,7 +2,7 @@
  * Website API
  * Manage your Teemill Website  Currently this API is in development and is not yet publicly accessible. All paths and models are subject to change.  For full documentation on functionality and account settings go to [teemill.com](https://teemill.com)
  *
- * The version of the OpenAPI document: 0.3.0
+ * The version of the OpenAPI document: 0.4.0
  * Contact: hello@teemill.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -32,6 +32,151 @@ export interface ApiError {
      */
     'message': string;
 }
+/**
+ *
+ * @export
+ * @interface Application
+ */
+export interface Application {
+    /**
+     * Unique object identifier
+     * @type {string}
+     * @memberof Application
+     */
+    'id'?: string;
+    /**
+     * Technology to use for the application.
+     * @type {string}
+     * @memberof Application
+     */
+    'technology': ApplicationTechnologyEnum;
+    /**
+     * Placement of the application. Available placements depend on the chosen product and technology.
+     * @type {string}
+     * @memberof Application
+     */
+    'placement': ApplicationPlacementEnum;
+    /**
+     * Publicly available design file URL. This will fill the design area of the warehouse product. It will be centered horizontally and aligned to the top of the design area. Accepts PNG and JPEG files.
+     * @type {string}
+     * @memberof Application
+     */
+    'src': string;
+    /**
+     *
+     * @type {ApplicationMockup}
+     * @memberof Application
+     */
+    'mockup'?: ApplicationMockup | null;
+}
+export declare const ApplicationTechnologyEnum: {
+    readonly Dtg: "dtg";
+    readonly Embroidery: "embroidery";
+    readonly Dtf: "dtf";
+    readonly Pretreat: "pretreat";
+    readonly MugSublimation: "mug_sublimation";
+    readonly ManualPrint: "manual_print";
+    readonly AdditionalApplication: "additional_application";
+    readonly NotebookSublimation: "notebook_sublimation";
+    readonly DuplexPrint: "duplex_print";
+};
+export type ApplicationTechnologyEnum = typeof ApplicationTechnologyEnum[keyof typeof ApplicationTechnologyEnum];
+export declare const ApplicationPlacementEnum: {
+    readonly Front: "front";
+    readonly Back: "back";
+    readonly Left: "left";
+    readonly Right: "right";
+    readonly Neck: "neck";
+};
+export type ApplicationPlacementEnum = typeof ApplicationPlacementEnum[keyof typeof ApplicationPlacementEnum];
+/**
+ *
+ * @export
+ * @interface ApplicationMockup
+ */
+export interface ApplicationMockup {
+    /**
+     * Drive image URL. If provided, this will be used as the mockup image for the variant application rather than generating a new one.
+     * @type {string}
+     * @memberof ApplicationMockup
+     */
+    'file': string;
+    /**
+     * Publicly available mockup image URL. This is a preview of the mockup image for the given application.
+     * @type {string}
+     * @memberof ApplicationMockup
+     */
+    'preview'?: string;
+}
+/**
+ *
+ * @export
+ * @interface AttachCrossSellProductsRequest
+ */
+export interface AttachCrossSellProductsRequest {
+    /**
+     * A list of product IDs to attach as cross-sell products. The order in which they are sent is the order they will be saved in.
+     * @type {Array<string>}
+     * @memberof AttachCrossSellProductsRequest
+     */
+    'products'?: Array<string>;
+}
+/**
+ *
+ * @export
+ * @interface Attribute
+ */
+export interface Attribute {
+    /**
+     * Attribute name
+     * @type {string}
+     * @memberof Attribute
+     */
+    'name': string;
+    /**
+     * Attribute value
+     * @type {string}
+     * @memberof Attribute
+     */
+    'value': string;
+    /**
+     *
+     * @type {AttributeThumbnail}
+     * @memberof Attribute
+     */
+    'thumbnail'?: AttributeThumbnail;
+    /**
+     * Attribute tags
+     * @type {Array<string>}
+     * @memberof Attribute
+     */
+    'tags'?: Array<string>;
+}
+/**
+ * Attribute thumbnail, intended for interfaces like storefront colour selector.
+ * @export
+ * @interface AttributeThumbnail
+ */
+export interface AttributeThumbnail {
+    /**
+     *
+     * @type {string}
+     * @memberof AttributeThumbnail
+     */
+    'type'?: AttributeThumbnailTypeEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof AttributeThumbnail
+     */
+    'value'?: string;
+}
+export declare const AttributeThumbnailTypeEnum: {
+    readonly Text: "text";
+    readonly Color: "color";
+    readonly Image: "image";
+};
+export type AttributeThumbnailTypeEnum = typeof AttributeThumbnailTypeEnum[keyof typeof AttributeThumbnailTypeEnum];
 /**
  *
  * @export
@@ -45,6 +190,61 @@ export interface AuthorizeStripe200Response {
      */
     'redirect_url': string;
 }
+/**
+ * Image description
+ * @export
+ * @interface Image
+ */
+export interface Image {
+    /**
+     * Unique object identifier
+     * @type {string}
+     * @memberof Image
+     */
+    'id'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Image
+     */
+    'src'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Image
+     */
+    'type'?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof Image
+     */
+    'alt'?: string;
+    /**
+     * List of variant Ids
+     * @type {Array<string>}
+     * @memberof Image
+     */
+    'variantIds'?: Array<string>;
+    /**
+     *
+     * @type {number}
+     * @memberof Image
+     */
+    'sortOrder'?: number;
+    /**
+     *
+     * @type {string}
+     * @memberof Image
+     */
+    'createdAt'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Image
+     */
+    'updatedAt'?: string;
+}
 /**
  *
  * @export
@@ -95,6 +295,25 @@ export interface MenuItem {
      */
     'submenu': Array<SubmenuInner>;
 }
+/**
+ * Key/value pairs that can be used to store additional information on the product
+ * @export
+ * @interface MetaField
+ */
+export interface MetaField {
+    /**
+     * The name or key of the property
+     * @type {string}
+     * @memberof MetaField
+     */
+    'name'?: string;
+    /**
+     * The string value of the property
+     * @type {string}
+     * @memberof MetaField
+     */
+    'value'?: string;
+}
 /**
  *
  * @export
@@ -127,6 +346,275 @@ export declare const PaymentAccountMethodEnum: {
     readonly Paypal: "paypal";
 };
 export type PaymentAccountMethodEnum = typeof PaymentAccountMethodEnum[keyof typeof PaymentAccountMethodEnum];
+/**
+ * Standard price definition that defines the amount, tax rate and currency.
+ * @export
+ * @interface Price
+ */
+export interface Price {
+    /**
+     * Price including tax in the specified currency.
+     * @type {number}
+     * @memberof Price
+     */
+    'amount'?: number;
+    /**
+     * Currency code for the currency the price is valued in.
+     * @type {string}
+     * @memberof Price
+     */
+    'currencyCode'?: PriceCurrencyCodeEnum;
+}
+export declare const PriceCurrencyCodeEnum: {
+    readonly Gbp: "GBP";
+};
+export type PriceCurrencyCodeEnum = typeof PriceCurrencyCodeEnum[keyof typeof PriceCurrencyCodeEnum];
+/**
+ *
+ * @export
+ * @interface Product
+ */
+export interface Product {
+    /**
+     * Unique object identifier
+     * @type {string}
+     * @memberof Product
+     */
+    'id'?: string;
+    /**
+     * A reference to the resource location
+     * @type {string}
+     * @memberof Product
+     */
+    'ref'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Product
+     */
+    'title': string;
+    /**
+     *
+     * @type {string}
+     * @memberof Product
+     */
+    'description': string;
+    /**
+     *
+     * @type {string}
+     * @memberof Product
+     */
+    'slug'?: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof Product
+     */
+    'enabled'?: boolean;
+    /**
+     *
+     * @type {SeoMetadata}
+     * @memberof Product
+     */
+    'seoMetadata'?: SeoMetadata;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof Product
+     */
+    'tags'?: Array<string>;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof Product
+     */
+    'internalTags'?: Array<string>;
+    /**
+     *
+     * @type {string}
+     * @memberof Product
+     */
+    'createdAt'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Product
+     */
+    'updatedAt'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Product
+     */
+    'publishedAt'?: string;
+    /**
+     * Images
+     * @type {Array<Image>}
+     * @memberof Product
+     */
+    'images'?: Array<Image>;
+    /**
+     * Videos
+     * @type {Array<Video>}
+     * @memberof Product
+     */
+    'videos'?: Array<Video>;
+    /**
+     * Variants
+     * @type {Array<Variant>}
+     * @memberof Product
+     */
+    'variants'?: Array<Variant>;
+    /**
+     * Additional files attached to the product.
+     * @type {Array<ProductAdditionalFilesInner>}
+     * @memberof Product
+     */
+    'additionalFiles'?: Array<ProductAdditionalFilesInner>;
+    /**
+     * List of application sets associated with this product
+     * @type {Array<ProductApplicationSetsInner>}
+     * @memberof Product
+     */
+    'applicationSets'?: Array<ProductApplicationSetsInner>;
+    /**
+     * The average review rating. This field is only present if included in the fields query parameter
+     * @type {number}
+     * @memberof Product
+     */
+    'reviewScore'?: number | null;
+    /**
+     * A count of reviews. This field is only present if included in the fields query parameter
+     * @type {number}
+     * @memberof Product
+     */
+    'reviewCount'?: number;
+    /**
+     *
+     * @type {string}
+     * @memberof Product
+     */
+    'sku'?: string;
+    /**
+     * A count of sales. This field is only present if included in the fields query parameter
+     * @type {number}
+     * @memberof Product
+     */
+    'sales'?: number;
+    /**
+     *
+     * @type {boolean}
+     * @memberof Product
+     */
+    'includeInDataFeeds'?: boolean;
+    /**
+     *
+     * @type {ProductWarehouseProduct}
+     * @memberof Product
+     */
+    'warehouseProduct'?: ProductWarehouseProduct;
+    /**
+     *
+     * @type {Array<MetaField>}
+     * @memberof Product
+     */
+    'metafields'?: Array<MetaField>;
+}
+/**
+ *
+ * @export
+ * @interface ProductAdditionalFilesInner
+ */
+export interface ProductAdditionalFilesInner {
+    /**
+     * Unique object identifier
+     * @type {string}
+     * @memberof ProductAdditionalFilesInner
+     */
+    'id'?: string;
+    /**
+     * File URL
+     * @type {string}
+     * @memberof ProductAdditionalFilesInner
+     */
+    'src'?: string;
+}
+/**
+ *
+ * @export
+ * @interface ProductApplicationSetsInner
+ */
+export interface ProductApplicationSetsInner {
+    /**
+     * Unique object identifier
+     * @type {string}
+     * @memberof ProductApplicationSetsInner
+     */
+    'id'?: string;
+    /**
+     * A reference to the resource location
+     * @type {string}
+     * @memberof ProductApplicationSetsInner
+     */
+    'ref'?: string;
+    /**
+     * Name of the application set
+     * @type {string}
+     * @memberof ProductApplicationSetsInner
+     */
+    'name'?: string;
+}
+/**
+ *
+ * @export
+ * @interface ProductWarehouseProduct
+ */
+export interface ProductWarehouseProduct {
+    /**
+     * Unique object identifier
+     * @type {string}
+     * @memberof ProductWarehouseProduct
+     */
+    'id'?: string;
+    /**
+     * Reference to the product in the Global Fulfillment Network (GFN) catalog that will be used as a base for this product. A list of available products for the given project can be obtained from the GFN Catalog API.
+     * @type {string}
+     * @memberof ProductWarehouseProduct
+     */
+    'gfnProductRef'?: string;
+}
+/**
+ * SEO metadata for the product
+ * @export
+ * @interface SeoMetadata
+ */
+export interface SeoMetadata {
+    /**
+     * Meta title for the product. This appears in search engine results and social shares. If not provided, the product title will be used.
+     * @type {string}
+     * @memberof SeoMetadata
+     */
+    'title'?: string;
+    /**
+     * Meta description for the product. This appears in search engine results and social shares. If not provided, the product description will be used.
+     * @type {string}
+     * @memberof SeoMetadata
+     */
+    'description'?: string | null;
+}
+/**
+ *
+ * @export
+ * @interface Stock
+ */
+export interface Stock {
+    /**
+     *
+     * @type {number}
+     * @memberof Stock
+     */
+    'level'?: number;
+}
 /**
  *
  * @export
@@ -313,6 +801,171 @@ export interface UpdateMenuRequestSubmenuItem {
      */
     'order': number;
 }
+/**
+ *
+ * @export
+ * @interface Variant
+ */
+export interface Variant {
+    /**
+     * Unique object identifier
+     * @type {string}
+     * @memberof Variant
+     */
+    'id'?: string;
+    /**
+     * Attributes associated to a variant such as Colour and Size. An attribute can have thumbnail type of `text`, `color`, or `image`. Attribute tags are intended for grouping and filtering, e.g. by a group of colours.
+     * @type {Array<Attribute>}
+     * @memberof Variant
+     */
+    'attributes': Array<Attribute>;
+    /**
+     *
+     * @type {string}
+     * @memberof Variant
+     */
+    'sku': string;
+    /**
+     * A reference to the resource location
+     * @type {string}
+     * @memberof Variant
+     */
+    'ref'?: string;
+    /**
+     *
+     * @type {VariantProduct}
+     * @memberof Variant
+     */
+    'product'?: VariantProduct;
+    /**
+     *
+     * @type {number}
+     * @memberof Variant
+     */
+    'sortOrder'?: number;
+    /**
+     *
+     * @type {Price}
+     * @memberof Variant
+     */
+    'retailPrice'?: Price;
+    /**
+     *
+     * @type {Price}
+     * @memberof Variant
+     */
+    'salePrice'?: Price;
+    /**
+     *
+     * @type {Price}
+     * @memberof Variant
+     */
+    'price'?: Price;
+    /**
+     *
+     * @type {Stock}
+     * @memberof Variant
+     */
+    'stock'?: Stock;
+    /**
+     *
+     * @type {string}
+     * @memberof Variant
+     */
+    'createdAt'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Variant
+     */
+    'updatedAt'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Variant
+     */
+    'publishedAt'?: string;
+    /**
+     * Images
+     * @type {Array<Image>}
+     * @memberof Variant
+     */
+    'images'?: Array<Image>;
+    /**
+     * Design applications. If not provided, the product will be blank.
+     * @type {Array<Application>}
+     * @memberof Variant
+     */
+    'applications'?: Array<Application>;
+    /**
+     * Global Trade Item Number
+     * @type {string}
+     * @memberof Variant
+     */
+    'gtin'?: string | null;
+}
+/**
+ *
+ * @export
+ * @interface VariantProduct
+ */
+export interface VariantProduct {
+    /**
+     * Unique object identifier
+     * @type {string}
+     * @memberof VariantProduct
+     */
+    'id'?: string;
+    /**
+     * A reference to the resource location
+     * @type {string}
+     * @memberof VariantProduct
+     */
+    'ref'?: string;
+}
+/**
+ * Video object
+ * @export
+ * @interface Video
+ */
+export interface Video {
+    /**
+     * Unique object identifier
+     * @type {string}
+     * @memberof Video
+     */
+    'id'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Video
+     */
+    'src'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Video
+     */
+    'alt'?: string;
+    /**
+     *
+     * @type {number}
+     * @memberof Video
+     */
+    'sortOrder'?: number;
+    /**
+     *
+     * @type {string}
+     * @memberof Video
+     */
+    'createdAt'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Video
+     */
+    'updatedAt'?: string;
+}
 /**
  * CrossSellApi - axios parameter creator
  * @export
@@ -323,11 +976,11 @@ export declare const CrossSellApiAxiosParamCreator: (configuration?: Configurati
      * @summary Attach cross-sell products
      * @param {string} project What project it is
      * @param {string} productId Product\&#39;s unique identifier
-     * @param {Array<string>} [requestBody]
+     * @param {AttachCrossSellProductsRequest} [attachCrossSellProductsRequest]
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    attachCrossSellProducts: (project: string, productId: string, requestBody?: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    attachCrossSellProducts: (project: string, productId: string, attachCrossSellProductsRequest?: AttachCrossSellProductsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary Get cross-sell products linked to a product
@@ -348,11 +1001,11 @@ export declare const CrossSellApiFp: (configuration?: Configuration) => {
      * @summary Attach cross-sell products
      * @param {string} project What project it is
      * @param {string} productId Product\&#39;s unique identifier
-     * @param {Array<string>} [requestBody]
+     * @param {AttachCrossSellProductsRequest} [attachCrossSellProductsRequest]
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    attachCrossSellProducts(project: string, productId: string, requestBody?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
+    attachCrossSellProducts(project: string, productId: string, attachCrossSellProductsRequest?: AttachCrossSellProductsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Product>>>;
     /**
      *
      * @summary Get cross-sell products linked to a product
@@ -361,7 +1014,7 @@ export declare const CrossSellApiFp: (configuration?: Configuration) => {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getCrossSellProducts(project: string, productId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
+    getCrossSellProducts(project: string, productId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Product>>>;
 };
 /**
  * CrossSellApi - factory interface
@@ -375,7 +1028,7 @@ export declare const CrossSellApiFactory: (configuration?: Configuration, basePa
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    attachCrossSellProducts(requestParameters: CrossSellApiAttachCrossSellProductsRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<string>>;
+    attachCrossSellProducts(requestParameters: CrossSellApiAttachCrossSellProductsRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<Product>>;
     /**
      *
      * @summary Get cross-sell products linked to a product
@@ -383,7 +1036,7 @@ export declare const CrossSellApiFactory: (configuration?: Configuration, basePa
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getCrossSellProducts(requestParameters: CrossSellApiGetCrossSellProductsRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<string>>;
+    getCrossSellProducts(requestParameters: CrossSellApiGetCrossSellProductsRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<Product>>;
 };
 /**
  * Request parameters for attachCrossSellProducts operation in CrossSellApi.
@@ -405,10 +1058,10 @@ export interface CrossSellApiAttachCrossSellProductsRequest {
     readonly productId: string;
     /**
      *
-     * @type {Array<string>}
+     * @type {AttachCrossSellProductsRequest}
      * @memberof CrossSellApiAttachCrossSellProducts
      */
-    readonly requestBody?: Array<string>;
+    readonly attachCrossSellProductsRequest?: AttachCrossSellProductsRequest;
 }
 /**
  * Request parameters for getCrossSellProducts operation in CrossSellApi.
@@ -444,7 +1097,7 @@ export declare class CrossSellApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof CrossSellApi
      */
-    attachCrossSellProducts(requestParameters: CrossSellApiAttachCrossSellProductsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string[], any>>;
+    attachCrossSellProducts(requestParameters: CrossSellApiAttachCrossSellProductsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Product[], any>>;
     /**
      *
      * @summary Get cross-sell products linked to a product
@@ -453,7 +1106,7 @@ export declare class CrossSellApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof CrossSellApi
      */
-    getCrossSellProducts(requestParameters: CrossSellApiGetCrossSellProductsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string[], any>>;
+    getCrossSellProducts(requestParameters: CrossSellApiGetCrossSellProductsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Product[], any>>;
 }
 /**
  * MenuApi - axios parameter creator