@teemill/product-catalog 1.3.0 → 1.5.0

package/src/apis/ProductsApi.ts

@@ -4,7 +4,7 @@
  * Product Catalog API
  * Manage Teemill Product Catalog  For full documentation on functionality and account settings go to [teemill.com](https://teemill.com)
  *
- * The version of the OpenAPI document: 1.3.0
+ * The version of the OpenAPI document: 1.5.0
  * Contact: hello@teemill.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -16,18 +16,26 @@
 import * as runtime from '../runtime';
 import type {
   ApiError,
+  CreateProductRequest,
   Product,
   ProductsResponse,
 } from '../models/index';
 import {
     ApiErrorFromJSON,
     ApiErrorToJSON,
+    CreateProductRequestFromJSON,
+    CreateProductRequestToJSON,
     ProductFromJSON,
     ProductToJSON,
     ProductsResponseFromJSON,
     ProductsResponseToJSON,
 } from '../models/index';
 
+export interface CreateProductOperationRequest {
+    project: string;
+    createProductRequest?: CreateProductRequest;
+}
+
 export interface GetProductRequest {
     project: string;
     productId: string;
@@ -41,11 +49,75 @@ export interface GetProductsRequest {
     fields?: string;
 }
 
+export interface ImportProductsRequest {
+    project: string;
+    body?: string;
+}
+
 /**
  * 
  */
 export class ProductsApi extends runtime.BaseAPI {
 
+    /**
+     * Creates a catalog product
+     * Create catalog product
+     */
+    async createProductRaw(requestParameters: CreateProductOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Product>> {
+        if (requestParameters.project === null || requestParameters.project === undefined) {
+            throw new runtime.RequiredError('project','Required parameter requestParameters.project was null or undefined when calling createProduct.');
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters.project !== undefined) {
+            queryParameters['project'] = requestParameters.project;
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("session-oauth", []);
+        }
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // api-key authentication
+        }
+
+        const response = await this.request({
+            path: `/v1/catalog/products`,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: CreateProductRequestToJSON(requestParameters.createProductRequest),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ProductFromJSON(jsonValue));
+    }
+
+    /**
+     * Creates a catalog product
+     * Create catalog product
+     */
+    async createProduct(
+        project: string, 
+        optionalParameters: runtime.OptionalOnly<CreateProductOperationRequest> = {},
+        initOverrides?: RequestInit | runtime.InitOverrideFunction
+    ): Promise<Product> {
+        const response = await this.createProductRaw(
+            {
+                project: project,
+                ...optionalParameters,
+            },
+            initOverrides
+        );
+
+        return await response.value();
+    }
+
     /**
      * Gets a product by the given id
      * Get product
@@ -101,8 +173,7 @@ export class ProductsApi extends runtime.BaseAPI {
     ): Promise<Product> {
         const response = await this.getProductRaw(
             {
-                project: project,
-                productId: productId,
+                project: project,productId: productId,
                 ...optionalParameters,
             },
             initOverrides
@@ -179,4 +250,61 @@ export class ProductsApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Import products
+     * Initiates a product import from a CSV file. The result will be available as a notification within the dashboard.
+     */
+    async importProductsRaw(requestParameters: ImportProductsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters.project === null || requestParameters.project === undefined) {
+            throw new runtime.RequiredError('project','Required parameter requestParameters.project was null or undefined when calling importProducts.');
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters.project !== undefined) {
+            queryParameters['project'] = requestParameters.project;
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'text/csv';
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("session-oauth", []);
+        }
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // api-key authentication
+        }
+
+        const response = await this.request({
+            path: `/v1/catalog/products/import`,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: requestParameters.body as any,
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Import products
+     * Initiates a product import from a CSV file. The result will be available as a notification within the dashboard.
+     */
+    async importProducts(
+        project: string, 
+        optionalParameters: runtime.OptionalOnly<ImportProductsRequest> = {},
+        initOverrides?: RequestInit | runtime.InitOverrideFunction
+    ): Promise<void> {
+        await this.importProductsRaw(
+            {
+                project: project,
+                ...optionalParameters,
+            },
+            initOverrides
+        );
+    }
+
 }

package/src/apis/VariantsApi.ts

@@ -4,7 +4,7 @@
  * Product Catalog API
  * Manage Teemill Product Catalog  For full documentation on functionality and account settings go to [teemill.com](https://teemill.com)
  *
- * The version of the OpenAPI document: 1.3.0
+ * The version of the OpenAPI document: 1.5.0
  * Contact: hello@teemill.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -36,6 +36,7 @@ export interface GetVariantRequest {
 
 export interface ListVariantsRequest {
     project: string;
+    search?: string;
     pageToken?: number;
     pageSize?: number;
     fields?: string;
@@ -101,8 +102,7 @@ export class VariantsApi extends runtime.BaseAPI {
     ): Promise<Variant> {
         const response = await this.getVariantRaw(
             {
-                project: project,
-                variantId: variantId,
+                project: project,variantId: variantId,
                 ...optionalParameters,
             },
             initOverrides
@@ -126,6 +126,10 @@ export class VariantsApi extends runtime.BaseAPI {
             queryParameters['project'] = requestParameters.project;
         }
 
+        if (requestParameters.search !== undefined) {
+            queryParameters['search'] = requestParameters.search;
+        }
+
         if (requestParameters.pageToken !== undefined) {
             queryParameters['pageToken'] = requestParameters.pageToken;
         }

package/src/models/ApiError.ts

@@ -4,7 +4,7 @@
  * Product Catalog API
  * Manage Teemill Product Catalog  For full documentation on functionality and account settings go to [teemill.com](https://teemill.com)
  *
- * The version of the OpenAPI document: 1.3.0
+ * The version of the OpenAPI document: 1.5.0
  * Contact: hello@teemill.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/src/models/Attribute.ts

@@ -4,7 +4,7 @@
  * Product Catalog API
  * Manage Teemill Product Catalog  For full documentation on functionality and account settings go to [teemill.com](https://teemill.com)
  *
- * The version of the OpenAPI document: 1.3.0
+ * The version of the OpenAPI document: 1.5.0
  * Contact: hello@teemill.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/src/models/AttributeThumbnail.ts

@@ -4,7 +4,7 @@
  * Product Catalog API
  * Manage Teemill Product Catalog  For full documentation on functionality and account settings go to [teemill.com](https://teemill.com)
  *
- * The version of the OpenAPI document: 1.3.0
+ * The version of the OpenAPI document: 1.5.0
  * Contact: hello@teemill.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/src/models/CreateProductRequest.ts

@@ -0,0 +1,136 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Product Catalog API
+ * Manage Teemill Product Catalog  For full documentation on functionality and account settings go to [teemill.com](https://teemill.com)
+ *
+ * The version of the OpenAPI document: 1.5.0
+ * 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 { exists, mapValues } from '../runtime';
+import type { CreateProductRequestAdditionalFilesInner } from './CreateProductRequestAdditionalFilesInner';
+import {
+    CreateProductRequestAdditionalFilesInnerFromJSON,
+    CreateProductRequestAdditionalFilesInnerFromJSONTyped,
+    CreateProductRequestAdditionalFilesInnerToJSON,
+} from './CreateProductRequestAdditionalFilesInner';
+import type { CreateProductRequestVariantsInner } from './CreateProductRequestVariantsInner';
+import {
+    CreateProductRequestVariantsInnerFromJSON,
+    CreateProductRequestVariantsInnerFromJSONTyped,
+    CreateProductRequestVariantsInnerToJSON,
+} from './CreateProductRequestVariantsInner';
+
+/**
+ * 
+ * @export
+ * @interface CreateProductRequest
+ */
+export interface CreateProductRequest {
+    /**
+     * GFN product ref
+     * @type {string}
+     * @memberof CreateProductRequest
+     */
+    gfnProductRef: string;
+    /**
+     * Product title
+     * @type {string}
+     * @memberof CreateProductRequest
+     */
+    title?: string;
+    /**
+     * Product description
+     * @type {string}
+     * @memberof CreateProductRequest
+     */
+    description?: string;
+    /**
+     * Whether the product is enabled
+     * @type {boolean}
+     * @memberof CreateProductRequest
+     */
+    enabled?: boolean;
+    /**
+     * A custom url slug for the product
+     * @type {string}
+     * @memberof CreateProductRequest
+     */
+    slug?: string;
+    /**
+     * Product tags
+     * @type {Array<string>}
+     * @memberof CreateProductRequest
+     */
+    tags?: Array<string>;
+    /**
+     * Variants
+     * @type {Array<CreateProductRequestVariantsInner>}
+     * @memberof CreateProductRequest
+     */
+    variants: Array<CreateProductRequestVariantsInner>;
+    /**
+     * Additional files
+     * @type {Array<CreateProductRequestAdditionalFilesInner>}
+     * @memberof CreateProductRequest
+     */
+    additionalFiles?: Array<CreateProductRequestAdditionalFilesInner>;
+}
+
+/**
+ * Check if a given object implements the CreateProductRequest interface.
+ */
+export function instanceOfCreateProductRequest(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "gfnProductRef" in value;
+    isInstance = isInstance && "variants" in value;
+
+    return isInstance;
+}
+
+export function CreateProductRequestFromJSON(json: any): CreateProductRequest {
+    return CreateProductRequestFromJSONTyped(json, false);
+}
+
+export function CreateProductRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateProductRequest {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'gfnProductRef': json['gfnProductRef'],
+        'title': !exists(json, 'title') ? undefined : json['title'],
+        'description': !exists(json, 'description') ? undefined : json['description'],
+        'enabled': !exists(json, 'enabled') ? undefined : json['enabled'],
+        'slug': !exists(json, 'slug') ? undefined : json['slug'],
+        'tags': !exists(json, 'tags') ? undefined : json['tags'],
+        'variants': ((json['variants'] as Array<any>).map(CreateProductRequestVariantsInnerFromJSON)),
+        'additionalFiles': !exists(json, 'additionalFiles') ? undefined : ((json['additionalFiles'] as Array<any>).map(CreateProductRequestAdditionalFilesInnerFromJSON)),
+    };
+}
+
+export function CreateProductRequestToJSON(value?: CreateProductRequest | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'gfnProductRef': value.gfnProductRef,
+        'title': value.title,
+        'description': value.description,
+        'enabled': value.enabled,
+        'slug': value.slug,
+        'tags': value.tags,
+        'variants': ((value.variants as Array<any>).map(CreateProductRequestVariantsInnerToJSON)),
+        'additionalFiles': value.additionalFiles === undefined ? undefined : ((value.additionalFiles as Array<any>).map(CreateProductRequestAdditionalFilesInnerToJSON)),
+    };
+}
+

package/src/models/CreateProductRequestAdditionalFilesInner.ts

@@ -0,0 +1,65 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Product Catalog API
+ * Manage Teemill Product Catalog  For full documentation on functionality and account settings go to [teemill.com](https://teemill.com)
+ *
+ * The version of the OpenAPI document: 1.5.0
+ * 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 { exists, mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface CreateProductRequestAdditionalFilesInner
+ */
+export interface CreateProductRequestAdditionalFilesInner {
+    /**
+     * File url
+     * @type {string}
+     * @memberof CreateProductRequestAdditionalFilesInner
+     */
+    src?: string;
+}
+
+/**
+ * Check if a given object implements the CreateProductRequestAdditionalFilesInner interface.
+ */
+export function instanceOfCreateProductRequestAdditionalFilesInner(value: object): boolean {
+    let isInstance = true;
+
+    return isInstance;
+}
+
+export function CreateProductRequestAdditionalFilesInnerFromJSON(json: any): CreateProductRequestAdditionalFilesInner {
+    return CreateProductRequestAdditionalFilesInnerFromJSONTyped(json, false);
+}
+
+export function CreateProductRequestAdditionalFilesInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateProductRequestAdditionalFilesInner {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'src': !exists(json, 'src') ? undefined : json['src'],
+    };
+}
+
+export function CreateProductRequestAdditionalFilesInnerToJSON(value?: CreateProductRequestAdditionalFilesInner | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'src': value.src,
+    };
+}
+

package/src/models/CreateProductRequestVariantsInner.ts

@@ -0,0 +1,108 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Product Catalog API
+ * Manage Teemill Product Catalog  For full documentation on functionality and account settings go to [teemill.com](https://teemill.com)
+ *
+ * The version of the OpenAPI document: 1.5.0
+ * 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 { exists, mapValues } from '../runtime';
+import type { CreateProductRequestVariantsInnerApplicationsInner } from './CreateProductRequestVariantsInnerApplicationsInner';
+import {
+    CreateProductRequestVariantsInnerApplicationsInnerFromJSON,
+    CreateProductRequestVariantsInnerApplicationsInnerFromJSONTyped,
+    CreateProductRequestVariantsInnerApplicationsInnerToJSON,
+} from './CreateProductRequestVariantsInnerApplicationsInner';
+import type { CreateProductRequestVariantsInnerAttributesInner } from './CreateProductRequestVariantsInnerAttributesInner';
+import {
+    CreateProductRequestVariantsInnerAttributesInnerFromJSON,
+    CreateProductRequestVariantsInnerAttributesInnerFromJSONTyped,
+    CreateProductRequestVariantsInnerAttributesInnerToJSON,
+} from './CreateProductRequestVariantsInnerAttributesInner';
+import type { Price } from './Price';
+import {
+    PriceFromJSON,
+    PriceFromJSONTyped,
+    PriceToJSON,
+} from './Price';
+
+/**
+ * 
+ * @export
+ * @interface CreateProductRequestVariantsInner
+ */
+export interface CreateProductRequestVariantsInner {
+    /**
+     * Variant attributes
+     * @type {Array<CreateProductRequestVariantsInnerAttributesInner>}
+     * @memberof CreateProductRequestVariantsInner
+     */
+    attributes?: Array<CreateProductRequestVariantsInnerAttributesInner>;
+    /**
+     * 
+     * @type {Price}
+     * @memberof CreateProductRequestVariantsInner
+     */
+    retailPrice?: Price;
+    /**
+     * A custom sku
+     * @type {string}
+     * @memberof CreateProductRequestVariantsInner
+     */
+    sku?: string;
+    /**
+     * Design applications.
+     * @type {Array<CreateProductRequestVariantsInnerApplicationsInner>}
+     * @memberof CreateProductRequestVariantsInner
+     */
+    applications?: Array<CreateProductRequestVariantsInnerApplicationsInner>;
+}
+
+/**
+ * Check if a given object implements the CreateProductRequestVariantsInner interface.
+ */
+export function instanceOfCreateProductRequestVariantsInner(value: object): boolean {
+    let isInstance = true;
+
+    return isInstance;
+}
+
+export function CreateProductRequestVariantsInnerFromJSON(json: any): CreateProductRequestVariantsInner {
+    return CreateProductRequestVariantsInnerFromJSONTyped(json, false);
+}
+
+export function CreateProductRequestVariantsInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateProductRequestVariantsInner {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'attributes': !exists(json, 'attributes') ? undefined : ((json['attributes'] as Array<any>).map(CreateProductRequestVariantsInnerAttributesInnerFromJSON)),
+        'retailPrice': !exists(json, 'retailPrice') ? undefined : PriceFromJSON(json['retailPrice']),
+        'sku': !exists(json, 'sku') ? undefined : json['sku'],
+        'applications': !exists(json, 'applications') ? undefined : ((json['applications'] as Array<any>).map(CreateProductRequestVariantsInnerApplicationsInnerFromJSON)),
+    };
+}
+
+export function CreateProductRequestVariantsInnerToJSON(value?: CreateProductRequestVariantsInner | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'attributes': value.attributes === undefined ? undefined : ((value.attributes as Array<any>).map(CreateProductRequestVariantsInnerAttributesInnerToJSON)),
+        'retailPrice': PriceToJSON(value.retailPrice),
+        'sku': value.sku,
+        'applications': value.applications === undefined ? undefined : ((value.applications as Array<any>).map(CreateProductRequestVariantsInnerApplicationsInnerToJSON)),
+    };
+}
+

package/src/models/CreateProductRequestVariantsInnerApplicationsInner.ts

@@ -0,0 +1,101 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Product Catalog API
+ * Manage Teemill Product Catalog  For full documentation on functionality and account settings go to [teemill.com](https://teemill.com)
+ *
+ * The version of the OpenAPI document: 1.5.0
+ * 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 { exists, mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface CreateProductRequestVariantsInnerApplicationsInner
+ */
+export interface CreateProductRequestVariantsInnerApplicationsInner {
+    /**
+     * Technology to use for the application
+     * @type {string}
+     * @memberof CreateProductRequestVariantsInnerApplicationsInner
+     */
+    technology?: CreateProductRequestVariantsInnerApplicationsInnerTechnologyEnum;
+    /**
+     * Placement of the application
+     * @type {string}
+     * @memberof CreateProductRequestVariantsInnerApplicationsInner
+     */
+    placement?: CreateProductRequestVariantsInnerApplicationsInnerPlacementEnum;
+    /**
+     * Design file as either a url or base64 encoded string
+     * @type {string}
+     * @memberof CreateProductRequestVariantsInnerApplicationsInner
+     */
+    src?: string;
+}
+
+
+/**
+ * @export
+ */
+export const CreateProductRequestVariantsInnerApplicationsInnerTechnologyEnum = {
+    Dtg: 'dtg',
+    Embroidery: 'embroidery'
+} as const;
+export type CreateProductRequestVariantsInnerApplicationsInnerTechnologyEnum = typeof CreateProductRequestVariantsInnerApplicationsInnerTechnologyEnum[keyof typeof CreateProductRequestVariantsInnerApplicationsInnerTechnologyEnum];
+
+/**
+ * @export
+ */
+export const CreateProductRequestVariantsInnerApplicationsInnerPlacementEnum = {
+    Front: 'front',
+    Back: 'back'
+} as const;
+export type CreateProductRequestVariantsInnerApplicationsInnerPlacementEnum = typeof CreateProductRequestVariantsInnerApplicationsInnerPlacementEnum[keyof typeof CreateProductRequestVariantsInnerApplicationsInnerPlacementEnum];
+
+
+/**
+ * Check if a given object implements the CreateProductRequestVariantsInnerApplicationsInner interface.
+ */
+export function instanceOfCreateProductRequestVariantsInnerApplicationsInner(value: object): boolean {
+    let isInstance = true;
+
+    return isInstance;
+}
+
+export function CreateProductRequestVariantsInnerApplicationsInnerFromJSON(json: any): CreateProductRequestVariantsInnerApplicationsInner {
+    return CreateProductRequestVariantsInnerApplicationsInnerFromJSONTyped(json, false);
+}
+
+export function CreateProductRequestVariantsInnerApplicationsInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateProductRequestVariantsInnerApplicationsInner {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'technology': !exists(json, 'technology') ? undefined : json['technology'],
+        'placement': !exists(json, 'placement') ? undefined : json['placement'],
+        'src': !exists(json, 'src') ? undefined : json['src'],
+    };
+}
+
+export function CreateProductRequestVariantsInnerApplicationsInnerToJSON(value?: CreateProductRequestVariantsInnerApplicationsInner | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'technology': value.technology,
+        'placement': value.placement,
+        'src': value.src,
+    };
+}
+