@teemill/product-catalog 1.9.1 → 1.11.1

package/dist/esm/models/ProductAdditionalFilesInner.d.ts

@@ -0,0 +1,37 @@
+/**
+ * Product Catalog API
+ * Manage Product Catalog  A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a warehouse product, plus listing information such as title, description and tags.
+ *
+ * The version of the OpenAPI document: 1.11.1
+ * Contact: hello@teemill.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface ProductAdditionalFilesInner
+ */
+export interface ProductAdditionalFilesInner {
+    /**
+     * Unique object identifier
+     * @type {string}
+     * @memberof ProductAdditionalFilesInner
+     */
+    id?: string;
+    /**
+     * File URL
+     * @type {string}
+     * @memberof ProductAdditionalFilesInner
+     */
+    src?: string;
+}
+/**
+ * Check if a given object implements the ProductAdditionalFilesInner interface.
+ */
+export declare function instanceOfProductAdditionalFilesInner(value: object): boolean;
+export declare function ProductAdditionalFilesInnerFromJSON(json: any): ProductAdditionalFilesInner;
+export declare function ProductAdditionalFilesInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): ProductAdditionalFilesInner;
+export declare function ProductAdditionalFilesInnerToJSON(value?: ProductAdditionalFilesInner | null): any;

package/dist/esm/models/ProductAdditionalFilesInner.js

@@ -0,0 +1,40 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Product Catalog API
+ * Manage Product Catalog  A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a warehouse product, plus listing information such as title, description and tags.
+ *
+ * The version of the OpenAPI document: 1.11.1
+ * Contact: hello@teemill.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Check if a given object implements the ProductAdditionalFilesInner interface.
+ */
+export function instanceOfProductAdditionalFilesInner(value) {
+    return true;
+}
+export function ProductAdditionalFilesInnerFromJSON(json) {
+    return ProductAdditionalFilesInnerFromJSONTyped(json, false);
+}
+export function ProductAdditionalFilesInnerFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'] == null ? undefined : json['id'],
+        'src': json['src'] == null ? undefined : json['src'],
+    };
+}
+export function ProductAdditionalFilesInnerToJSON(value) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'src': value['src'],
+    };
+}

package/dist/esm/models/ProductsResponse.d.ts

@@ -0,0 +1,38 @@
+/**
+ * Product Catalog API
+ * Manage Product Catalog  A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a warehouse product, plus listing information such as title, description and tags.
+ *
+ * The version of the OpenAPI document: 1.11.1
+ * Contact: hello@teemill.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { Product } from './Product';
+/**
+ *
+ * @export
+ * @interface ProductsResponse
+ */
+export interface ProductsResponse {
+    /**
+     *
+     * @type {Array<Product>}
+     * @memberof ProductsResponse
+     */
+    products?: Array<Product>;
+    /**
+     *
+     * @type {number}
+     * @memberof ProductsResponse
+     */
+    nextPageToken?: number;
+}
+/**
+ * Check if a given object implements the ProductsResponse interface.
+ */
+export declare function instanceOfProductsResponse(value: object): boolean;
+export declare function ProductsResponseFromJSON(json: any): ProductsResponse;
+export declare function ProductsResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ProductsResponse;
+export declare function ProductsResponseToJSON(value?: ProductsResponse | null): any;

package/dist/esm/models/ProductsResponse.js

@@ -0,0 +1,41 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Product Catalog API
+ * Manage Product Catalog  A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a warehouse product, plus listing information such as title, description and tags.
+ *
+ * The version of the OpenAPI document: 1.11.1
+ * Contact: hello@teemill.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { ProductFromJSON, ProductToJSON, } from './Product';
+/**
+ * Check if a given object implements the ProductsResponse interface.
+ */
+export function instanceOfProductsResponse(value) {
+    return true;
+}
+export function ProductsResponseFromJSON(json) {
+    return ProductsResponseFromJSONTyped(json, false);
+}
+export function ProductsResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'products': json['products'] == null ? undefined : (json['products'].map(ProductFromJSON)),
+        'nextPageToken': json['nextPageToken'] == null ? undefined : json['nextPageToken'],
+    };
+}
+export function ProductsResponseToJSON(value) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'products': value['products'] == null ? undefined : (value['products'].map(ProductToJSON)),
+        'nextPageToken': value['nextPageToken'],
+    };
+}

package/dist/esm/models/SeoMetadata.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Product Catalog API
+ * Manage Product Catalog  A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a warehouse product, plus listing information such as title, description and tags.
+ *
+ * The version of the OpenAPI document: 1.11.1
+ * Contact: hello@teemill.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * 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;
+}
+/**
+ * Check if a given object implements the SeoMetadata interface.
+ */
+export declare function instanceOfSeoMetadata(value: object): boolean;
+export declare function SeoMetadataFromJSON(json: any): SeoMetadata;
+export declare function SeoMetadataFromJSONTyped(json: any, ignoreDiscriminator: boolean): SeoMetadata;
+export declare function SeoMetadataToJSON(value?: SeoMetadata | null): any;

package/dist/esm/models/SeoMetadata.js

@@ -0,0 +1,38 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Product Catalog API
+ * Manage Product Catalog  A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a warehouse product, plus listing information such as title, description and tags.
+ *
+ * The version of the OpenAPI document: 1.11.1
+ * Contact: hello@teemill.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Check if a given object implements the SeoMetadata interface.
+ */
+export function instanceOfSeoMetadata(value) {
+    return true;
+}
+export function SeoMetadataFromJSON(json) {
+    return SeoMetadataFromJSONTyped(json, false);
+}
+export function SeoMetadataFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'title': json['title'] == null ? undefined : json['title'],
+    };
+}
+export function SeoMetadataToJSON(value) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'title': value['title'],
+    };
+}

package/dist/esm/models/Stock.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Product Catalog API
+ * Manage Product Catalog  A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a warehouse product, plus listing information such as title, description and tags.
+ *
+ * The version of the OpenAPI document: 1.11.1
+ * Contact: hello@teemill.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface Stock
+ */
+export interface Stock {
+    /**
+     *
+     * @type {number}
+     * @memberof Stock
+     */
+    level?: number;
+}
+/**
+ * Check if a given object implements the Stock interface.
+ */
+export declare function instanceOfStock(value: object): boolean;
+export declare function StockFromJSON(json: any): Stock;
+export declare function StockFromJSONTyped(json: any, ignoreDiscriminator: boolean): Stock;
+export declare function StockToJSON(value?: Stock | null): any;

package/dist/esm/models/Stock.js

@@ -0,0 +1,38 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Product Catalog API
+ * Manage Product Catalog  A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a warehouse product, plus listing information such as title, description and tags.
+ *
+ * The version of the OpenAPI document: 1.11.1
+ * Contact: hello@teemill.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Check if a given object implements the Stock interface.
+ */
+export function instanceOfStock(value) {
+    return true;
+}
+export function StockFromJSON(json) {
+    return StockFromJSONTyped(json, false);
+}
+export function StockFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'level': json['level'] == null ? undefined : json['level'],
+    };
+}
+export function StockToJSON(value) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'level': value['level'],
+    };
+}

package/dist/esm/models/UpdateProductRequest.d.ts

@@ -0,0 +1,87 @@
+/**
+ * Product Catalog API
+ * Manage Product Catalog  A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a warehouse product, plus listing information such as title, description and tags.
+ *
+ * The version of the OpenAPI document: 1.11.1
+ * Contact: hello@teemill.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { CreateProductRequestSeoMetadata } from './CreateProductRequestSeoMetadata';
+import type { CreateProductVariant } from './CreateProductVariant';
+/**
+ *
+ * @export
+ * @interface UpdateProductRequest
+ */
+export interface UpdateProductRequest {
+    /**
+     * Reference to the product in the 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 UpdateProductRequest
+     */
+    gfnProductRef?: string;
+    /**
+     * Product title
+     * @type {string}
+     * @memberof UpdateProductRequest
+     */
+    title?: string;
+    /**
+     * Product description
+     * @type {string}
+     * @memberof UpdateProductRequest
+     */
+    description?: string;
+    /**
+     * Whether the product is enabled upon creation.
+     * @type {boolean}
+     * @memberof UpdateProductRequest
+     */
+    enabled?: boolean;
+    /**
+     * A custom URL slug for the product. This must be unique for each product on the project.
+     * @type {string}
+     * @memberof UpdateProductRequest
+     */
+    slug?: string;
+    /**
+     *
+     * @type {CreateProductRequestSeoMetadata}
+     * @memberof UpdateProductRequest
+     */
+    seoMetadata?: CreateProductRequestSeoMetadata;
+    /**
+     * Additional product tags used for searching and filtering.
+     * @type {Array<string>}
+     * @memberof UpdateProductRequest
+     */
+    tags?: Array<string>;
+    /**
+     * Variants
+     * @type {Array<CreateProductVariant>}
+     * @memberof UpdateProductRequest
+     */
+    variants?: Array<CreateProductVariant>;
+    /**
+     * Images to attach to the product. For example, photos of models using/wearing the product.
+     * @type {Array<any>}
+     * @memberof UpdateProductRequest
+     */
+    images?: Array<any>;
+    /**
+     * Additional files to attach to the product. For example, original design files e.g. PSD, AI, etc.
+     * @type {Array<any>}
+     * @memberof UpdateProductRequest
+     */
+    additionalFiles?: Array<any>;
+}
+/**
+ * Check if a given object implements the UpdateProductRequest interface.
+ */
+export declare function instanceOfUpdateProductRequest(value: object): boolean;
+export declare function UpdateProductRequestFromJSON(json: any): UpdateProductRequest;
+export declare function UpdateProductRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateProductRequest;
+export declare function UpdateProductRequestToJSON(value?: UpdateProductRequest | null): any;

package/dist/esm/models/UpdateProductRequest.js

@@ -0,0 +1,58 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Product Catalog API
+ * Manage Product Catalog  A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a warehouse product, plus listing information such as title, description and tags.
+ *
+ * The version of the OpenAPI document: 1.11.1
+ * Contact: hello@teemill.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { CreateProductRequestSeoMetadataFromJSON, CreateProductRequestSeoMetadataToJSON, } from './CreateProductRequestSeoMetadata';
+import { CreateProductVariantFromJSON, CreateProductVariantToJSON, } from './CreateProductVariant';
+/**
+ * Check if a given object implements the UpdateProductRequest interface.
+ */
+export function instanceOfUpdateProductRequest(value) {
+    return true;
+}
+export function UpdateProductRequestFromJSON(json) {
+    return UpdateProductRequestFromJSONTyped(json, false);
+}
+export function UpdateProductRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'gfnProductRef': json['gfnProductRef'] == null ? undefined : json['gfnProductRef'],
+        'title': json['title'] == null ? undefined : json['title'],
+        'description': json['description'] == null ? undefined : json['description'],
+        'enabled': json['enabled'] == null ? undefined : json['enabled'],
+        'slug': json['slug'] == null ? undefined : json['slug'],
+        'seoMetadata': json['seoMetadata'] == null ? undefined : CreateProductRequestSeoMetadataFromJSON(json['seoMetadata']),
+        'tags': json['tags'] == null ? undefined : json['tags'],
+        'variants': json['variants'] == null ? undefined : (json['variants'].map(CreateProductVariantFromJSON)),
+        'images': json['images'] == null ? undefined : json['images'],
+        'additionalFiles': json['additionalFiles'] == null ? undefined : json['additionalFiles'],
+    };
+}
+export function UpdateProductRequestToJSON(value) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'gfnProductRef': value['gfnProductRef'],
+        'title': value['title'],
+        'description': value['description'],
+        'enabled': value['enabled'],
+        'slug': value['slug'],
+        'seoMetadata': CreateProductRequestSeoMetadataToJSON(value['seoMetadata']),
+        'tags': value['tags'],
+        'variants': value['variants'] == null ? undefined : (value['variants'].map(CreateProductVariantToJSON)),
+        'images': value['images'],
+        'additionalFiles': value['additionalFiles'],
+    };
+}

package/dist/esm/models/Variant.d.ts

@@ -0,0 +1,114 @@
+/**
+ * Product Catalog API
+ * Manage Product Catalog  A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a warehouse product, plus listing information such as title, description and tags.
+ *
+ * The version of the OpenAPI document: 1.11.1
+ * Contact: hello@teemill.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { Attribute } from './Attribute';
+import type { Image } from './Image';
+import type { Price } from './Price';
+import type { Stock } from './Stock';
+import type { VariantProduct } from './VariantProduct';
+/**
+ *
+ * @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
+     */
+    readonly sortOrder?: number;
+    /**
+     *
+     * @type {Price}
+     * @memberof Variant
+     */
+    retailPrice?: Price;
+    /**
+     *
+     * @type {Price}
+     * @memberof Variant
+     */
+    salePrice?: Price;
+    /**
+     *
+     * @type {Price}
+     * @memberof Variant
+     */
+    readonly price?: Price;
+    /**
+     *
+     * @type {Stock}
+     * @memberof Variant
+     */
+    stock?: Stock;
+    /**
+     *
+     * @type {Date}
+     * @memberof Variant
+     */
+    createdAt?: Date;
+    /**
+     *
+     * @type {Date}
+     * @memberof Variant
+     */
+    updatedAt?: Date;
+    /**
+     *
+     * @type {Date}
+     * @memberof Variant
+     */
+    publishedAt?: Date;
+    /**
+     * Images
+     * @type {Array<Image>}
+     * @memberof Variant
+     */
+    images?: Array<Image>;
+}
+/**
+ * Check if a given object implements the Variant interface.
+ */
+export declare function instanceOfVariant(value: object): boolean;
+export declare function VariantFromJSON(json: any): Variant;
+export declare function VariantFromJSONTyped(json: any, ignoreDiscriminator: boolean): Variant;
+export declare function VariantToJSON(value?: Omit<Variant, 'sortOrder' | 'price'> | null): any;

package/dist/esm/models/Variant.js

@@ -0,0 +1,71 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Product Catalog API
+ * Manage Product Catalog  A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a warehouse product, plus listing information such as title, description and tags.
+ *
+ * The version of the OpenAPI document: 1.11.1
+ * Contact: hello@teemill.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { AttributeFromJSON, AttributeToJSON, } from './Attribute';
+import { ImageFromJSON, ImageToJSON, } from './Image';
+import { PriceFromJSON, PriceToJSON, } from './Price';
+import { StockFromJSON, StockToJSON, } from './Stock';
+import { VariantProductFromJSON, VariantProductToJSON, } from './VariantProduct';
+/**
+ * Check if a given object implements the Variant interface.
+ */
+export function instanceOfVariant(value) {
+    if (!('attributes' in value))
+        return false;
+    if (!('sku' in value))
+        return false;
+    return true;
+}
+export function VariantFromJSON(json) {
+    return VariantFromJSONTyped(json, false);
+}
+export function VariantFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'] == null ? undefined : json['id'],
+        'attributes': (json['attributes'].map(AttributeFromJSON)),
+        'sku': json['sku'],
+        'ref': json['ref'] == null ? undefined : json['ref'],
+        'product': json['product'] == null ? undefined : VariantProductFromJSON(json['product']),
+        'sortOrder': json['sortOrder'] == null ? undefined : json['sortOrder'],
+        'retailPrice': json['retailPrice'] == null ? undefined : PriceFromJSON(json['retailPrice']),
+        'salePrice': json['salePrice'] == null ? undefined : PriceFromJSON(json['salePrice']),
+        'price': json['price'] == null ? undefined : PriceFromJSON(json['price']),
+        'stock': json['stock'] == null ? undefined : StockFromJSON(json['stock']),
+        'createdAt': json['createdAt'] == null ? undefined : (new Date(json['createdAt'])),
+        'updatedAt': json['updatedAt'] == null ? undefined : (new Date(json['updatedAt'])),
+        'publishedAt': json['publishedAt'] == null ? undefined : (new Date(json['publishedAt'])),
+        'images': json['images'] == null ? undefined : (json['images'].map(ImageFromJSON)),
+    };
+}
+export function VariantToJSON(value) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'attributes': (value['attributes'].map(AttributeToJSON)),
+        'sku': value['sku'],
+        'ref': value['ref'],
+        'product': VariantProductToJSON(value['product']),
+        'retailPrice': PriceToJSON(value['retailPrice']),
+        'salePrice': PriceToJSON(value['salePrice']),
+        'stock': StockToJSON(value['stock']),
+        'createdAt': value['createdAt'] == null ? undefined : ((value['createdAt']).toISOString()),
+        'updatedAt': value['updatedAt'] == null ? undefined : ((value['updatedAt']).toISOString()),
+        'publishedAt': value['publishedAt'] == null ? undefined : ((value['publishedAt']).toISOString()),
+        'images': value['images'] == null ? undefined : (value['images'].map(ImageToJSON)),
+    };
+}

package/dist/esm/models/VariantProduct.d.ts

@@ -0,0 +1,37 @@
+/**
+ * Product Catalog API
+ * Manage Product Catalog  A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a warehouse product, plus listing information such as title, description and tags.
+ *
+ * The version of the OpenAPI document: 1.11.1
+ * Contact: hello@teemill.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @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;
+}
+/**
+ * Check if a given object implements the VariantProduct interface.
+ */
+export declare function instanceOfVariantProduct(value: object): boolean;
+export declare function VariantProductFromJSON(json: any): VariantProduct;
+export declare function VariantProductFromJSONTyped(json: any, ignoreDiscriminator: boolean): VariantProduct;
+export declare function VariantProductToJSON(value?: VariantProduct | null): any;