@teemill/product-catalog 1.47.0 → 1.49.0

package/docs/ProductsApi.md

@@ -0,0 +1,626 @@
+# ProductsApi
+
+All URIs are relative to *https://api.podos.io*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**createProduct**](#createproduct) | **POST** /v1/catalog/products | Create product|
+|[**deleteProduct**](#deleteproduct) | **DELETE** /v1/catalog/products/{productId} | Delete catalog product|
+|[**duplicateProducts**](#duplicateproducts) | **POST** /v1/catalog/products/duplicate | Duplicate products.|
+|[**exportProducts**](#exportproducts) | **GET** /v1/catalog/products/export | Export products|
+|[**getProduct**](#getproduct) | **GET** /v1/catalog/products/{productId} | Get product|
+|[**importProducts**](#importproducts) | **POST** /v1/catalog/products/import | Import products|
+|[**listProducts**](#listproducts) | **GET** /v1/catalog/products | List products|
+|[**seoOptimiseProducts**](#seooptimiseproducts) | **POST** /v1/catalog/products/ai-seo-optimise | AI SEO optimise products.|
+|[**updateProduct**](#updateproduct) | **PATCH** /v1/catalog/products/{productId} | Update product|
+|[**updateProducts**](#updateproducts) | **PATCH** /v1/catalog/products | Update products|
+
+# **createProduct**
+> Product createProduct()
+
+Creates a new catalog product based on a given warehouse product with the variants and design applications provided. To select a warehouse product to base this product on, use the GFN Catalog API to list available options.
+
+### Example
+
+```typescript
+import {
+    ProductsApi,
+    Configuration,
+    CreateProductRequest
+} from '@teemill/product-catalog';
+
+const configuration = new Configuration();
+const apiInstance = new ProductsApi(configuration);
+
+let project: string; //What project it is (default to undefined)
+let createProductRequest: CreateProductRequest; // (optional)
+
+const { status, data } = await apiInstance.createProduct(
+    project,
+    createProductRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **createProductRequest** | **CreateProductRequest**|  | |
+| **project** | [**string**] | What project it is | defaults to undefined|
+
+
+### Return type
+
+**Product**
+
+### Authorization
+
+[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**201** | Successfully retrieved a product. |  -  |
+|**400** | Failed validation. |  -  |
+|**401** | Not authorised to access this resource. |  -  |
+|**403** | Refuse to authorize. |  -  |
+|**404** | Resource not found. |  -  |
+|**500** | Unknown server error. |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **deleteProduct**
+> deleteProduct()
+
+Deletes a catalog product
+
+### Example
+
+```typescript
+import {
+    ProductsApi,
+    Configuration
+} from '@teemill/product-catalog';
+
+const configuration = new Configuration();
+const apiInstance = new ProductsApi(configuration);
+
+let project: string; //What project it is (default to undefined)
+let productId: string; //Product\'s unique identifier (default to undefined)
+
+const { status, data } = await apiInstance.deleteProduct(
+    project,
+    productId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **project** | [**string**] | What project it is | defaults to undefined|
+| **productId** | [**string**] | Product\'s unique identifier | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**204** | Product deleted |  -  |
+|**400** | Failed validation. |  -  |
+|**401** | Not authorised to access this resource. |  -  |
+|**403** | Refuse to authorize. |  -  |
+|**404** | Refuse to authorize. |  -  |
+|**500** | Unknown server error. |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **duplicateProducts**
+> DuplicateProducts202Response duplicateProducts()
+
+Duplicate products by a set of given IDs to a set of given project IDs.
+
+### Example
+
+```typescript
+import {
+    ProductsApi,
+    Configuration,
+    DuplicateProductsRequest
+} from '@teemill/product-catalog';
+
+const configuration = new Configuration();
+const apiInstance = new ProductsApi(configuration);
+
+let project: string; //What project it is (default to undefined)
+let duplicateProductsRequest: DuplicateProductsRequest; //A set of product IDs to duplicate and the project IDs to duplicate them to. (optional)
+
+const { status, data } = await apiInstance.duplicateProducts(
+    project,
+    duplicateProductsRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **duplicateProductsRequest** | **DuplicateProductsRequest**| A set of product IDs to duplicate and the project IDs to duplicate them to. | |
+| **project** | [**string**] | What project it is | defaults to undefined|
+
+
+### Return type
+
+**DuplicateProducts202Response**
+
+### Authorization
+
+[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**202** | Products queued for duplication. |  -  |
+|**400** | Failed validation. |  -  |
+|**401** | Not authorised to access this resource. |  -  |
+|**403** | Refuse to authorize. |  -  |
+|**404** | Resource not found. |  -  |
+|**500** | Unknown server error. |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **exportProducts**
+> File exportProducts()
+
+Export the project\'s products and variants as a CSV file.
+
+### Example
+
+```typescript
+import {
+    ProductsApi,
+    Configuration
+} from '@teemill/product-catalog';
+
+const configuration = new Configuration();
+const apiInstance = new ProductsApi(configuration);
+
+let project: string; //What project it is (default to undefined)
+
+const { status, data } = await apiInstance.exportProducts(
+    project
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **project** | [**string**] | What project it is | defaults to undefined|
+
+
+### Return type
+
+**File**
+
+### Authorization
+
+[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: text/csv; charset=utf-8, application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Returns the CSV export |  -  |
+|**202** | Export started. When complete, the export will be available for download from a notification within PodOS Dashboard. |  -  |
+|**400** | Failed validation. |  -  |
+|**401** | Not authorised to access this resource. |  -  |
+|**403** | Refuse to authorize. |  -  |
+|**500** | Unknown server error. |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **getProduct**
+> Product getProduct()
+
+Gets a product by a given ID.
+
+### Example
+
+```typescript
+import {
+    ProductsApi,
+    Configuration
+} from '@teemill/product-catalog';
+
+const configuration = new Configuration();
+const apiInstance = new ProductsApi(configuration);
+
+let project: string; //What project it is (default to undefined)
+let productId: string; //Product\'s unique identifier (default to undefined)
+let fields: string; //Filter response fields to only include a subset of the resource. (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getProduct(
+    project,
+    productId,
+    fields
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **project** | [**string**] | What project it is | defaults to undefined|
+| **productId** | [**string**] | Product\'s unique identifier | defaults to undefined|
+| **fields** | [**string**] | Filter response fields to only include a subset of the resource. | (optional) defaults to undefined|
+
+
+### Return type
+
+**Product**
+
+### Authorization
+
+[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successfully retrieved a product. |  -  |
+|**400** | Failed validation. |  -  |
+|**401** | Not authorised to access this resource. |  -  |
+|**403** | Refuse to authorize. |  -  |
+|**404** | Resource not found. |  -  |
+|**500** | Unknown server error. |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **importProducts**
+> ImportProducts200Response importProducts()
+
+Initiates a product import from a CSV file. The result will be available as a notification within the dashboard.
+
+### Example
+
+```typescript
+import {
+    ProductsApi,
+    Configuration
+} from '@teemill/product-catalog';
+
+const configuration = new Configuration();
+const apiInstance = new ProductsApi(configuration);
+
+let project: string; //What project it is (default to undefined)
+let body: string; //A data URL of a CSV file containing data for one or more products. (optional)
+
+const { status, data } = await apiInstance.importProducts(
+    project,
+    body
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **body** | **string**| A data URL of a CSV file containing data for one or more products. | |
+| **project** | [**string**] | What project it is | defaults to undefined|
+
+
+### Return type
+
+**ImportProducts200Response**
+
+### Authorization
+
+[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: text/csv
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | CSV file was accepted; products will be imported asynchronously. |  -  |
+|**400** | Failed validation. |  -  |
+|**401** | Not authorised to access this resource. |  -  |
+|**403** | Refuse to authorize. |  -  |
+|**404** | Resource not found. |  -  |
+|**500** | Unknown server error. |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **listProducts**
+> ProductsResponse listProducts()
+
+Lists all store listing products attached to the given project.
+
+### Example
+
+```typescript
+import {
+    ProductsApi,
+    Configuration
+} from '@teemill/product-catalog';
+
+const configuration = new Configuration();
+const apiInstance = new ProductsApi(configuration);
+
+let project: string; //What project it is (default to undefined)
+let pageToken: number; //Page reference token (optional) (default to 1)
+let search: string; //Search query string to filter results. Supports field-specific filters like \'enabled:true\', \'uuid:<id>\', \'name:\"product name\"\', and \'tag:\"tag name\"\'. Multiple filters can be combined with spaces and commas. (optional) (default to 'enabled:true')
+let sortBy: Array<string>; //An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending. (optional) (default to undefined)
+let pageSize: number; //Max page size. This is the maximum page size that will be returned, but it might be smaller. (optional) (default to 10)
+let fields: string; //Filter response fields to only include a subset of the resource. (optional) (default to undefined)
+
+const { status, data } = await apiInstance.listProducts(
+    project,
+    pageToken,
+    search,
+    sortBy,
+    pageSize,
+    fields
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **project** | [**string**] | What project it is | defaults to undefined|
+| **pageToken** | [**number**] | Page reference token | (optional) defaults to 1|
+| **search** | [**string**] | Search query string to filter results. Supports field-specific filters like \&#39;enabled:true\&#39;, \&#39;uuid:&lt;id&gt;\&#39;, \&#39;name:\&quot;product name\&quot;\&#39;, and \&#39;tag:\&quot;tag name\&quot;\&#39;. Multiple filters can be combined with spaces and commas. | (optional) defaults to 'enabled:true'|
+| **sortBy** | **Array&lt;string&gt;** | An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending. | (optional) defaults to undefined|
+| **pageSize** | [**number**] | Max page size. This is the maximum page size that will be returned, but it might be smaller. | (optional) defaults to 10|
+| **fields** | [**string**] | Filter response fields to only include a subset of the resource. | (optional) defaults to undefined|
+
+
+### Return type
+
+**ProductsResponse**
+
+### Authorization
+
+[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successfully retrieved all products. |  -  |
+|**400** | Failed validation. |  -  |
+|**401** | Not authorised to access this resource. |  -  |
+|**403** | Refuse to authorize. |  -  |
+|**500** | Unknown server error. |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **seoOptimiseProducts**
+> SeoOptimiseProducts202Response seoOptimiseProducts()
+
+AI SEO optimises products by a set of given IDs.
+
+### Example
+
+```typescript
+import {
+    ProductsApi,
+    Configuration,
+    SeoOptimiseProductsRequest
+} from '@teemill/product-catalog';
+
+const configuration = new Configuration();
+const apiInstance = new ProductsApi(configuration);
+
+let project: string; //What project it is (default to undefined)
+let seoOptimiseProductsRequest: SeoOptimiseProductsRequest; //A set of product IDs to AI SEO optimise. (optional)
+
+const { status, data } = await apiInstance.seoOptimiseProducts(
+    project,
+    seoOptimiseProductsRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **seoOptimiseProductsRequest** | **SeoOptimiseProductsRequest**| A set of product IDs to AI SEO optimise. | |
+| **project** | [**string**] | What project it is | defaults to undefined|
+
+
+### Return type
+
+**SeoOptimiseProducts202Response**
+
+### Authorization
+
+[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**202** | Products queued for optimisation. |  -  |
+|**400** | Failed validation. |  -  |
+|**401** | Not authorised to access this resource. |  -  |
+|**403** | Refuse to authorize. |  -  |
+|**404** | Resource not found. |  -  |
+|**500** | Unknown server error. |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **updateProduct**
+> Product updateProduct()
+
+Updates a product by a given ID.
+
+### Example
+
+```typescript
+import {
+    ProductsApi,
+    Configuration,
+    UpdateProductRequest
+} from '@teemill/product-catalog';
+
+const configuration = new Configuration();
+const apiInstance = new ProductsApi(configuration);
+
+let project: string; //What project it is (default to undefined)
+let productId: string; //Product\'s unique identifier (default to undefined)
+let updateProductRequest: UpdateProductRequest; // (optional)
+
+const { status, data } = await apiInstance.updateProduct(
+    project,
+    productId,
+    updateProductRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **updateProductRequest** | **UpdateProductRequest**|  | |
+| **project** | [**string**] | What project it is | defaults to undefined|
+| **productId** | [**string**] | Product\&#39;s unique identifier | defaults to undefined|
+
+
+### Return type
+
+**Product**
+
+### Authorization
+
+[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successfully retrieved a product. |  -  |
+|**400** | Failed validation. |  -  |
+|**401** | Not authorised to access this resource. |  -  |
+|**403** | Refuse to authorize. |  -  |
+|**404** | Resource not found. |  -  |
+|**500** | Unknown server error. |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **updateProducts**
+> ProductsResponse updateProducts(updateProductsRequest)
+
+Updates catalog products for the given project.
+
+### Example
+
+```typescript
+import {
+    ProductsApi,
+    Configuration,
+    UpdateProductsRequest
+} from '@teemill/product-catalog';
+
+const configuration = new Configuration();
+const apiInstance = new ProductsApi(configuration);
+
+let project: string; //What project it is (default to undefined)
+let updateProductsRequest: UpdateProductsRequest; //Update products in bulk.
+
+const { status, data } = await apiInstance.updateProducts(
+    project,
+    updateProductsRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **updateProductsRequest** | **UpdateProductsRequest**| Update products in bulk. | |
+| **project** | [**string**] | What project it is | defaults to undefined|
+
+
+### Return type
+
+**ProductsResponse**
+
+### Authorization
+
+[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successfully retrieved all products. |  -  |
+|**400** | Failed validation. |  -  |
+|**401** | Not authorised to access this resource. |  -  |
+|**403** | Refuse to authorize. |  -  |
+|**404** | Resource not found. |  -  |
+|**500** | Unknown server error. |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+

package/docs/ProductsResponse.md

@@ -0,0 +1,22 @@
+# ProductsResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**products** | [**Array<Product>**](Product.md) |  | [optional] [default to undefined]
+**nextPageToken** | **number** | The token referencing the next page number | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ProductsResponse } from '@teemill/product-catalog';
+
+const instance: ProductsResponse = {
+    products,
+    nextPageToken,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/SEOMetadata.md

@@ -0,0 +1,23 @@
+# SEOMetadata
+
+SEO metadata for the product
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**title** | **string** | Meta title for the product. This appears in search engine results and social shares. If not provided, the product title will be used. | [optional] [default to undefined]
+**description** | **string** | Meta description for the product. This appears in search engine results and social shares. If not provided, the product description will be used. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SEOMetadata } from '@teemill/product-catalog';
+
+const instance: SEOMetadata = {
+    title,
+    description,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/SeoOptimiseProducts202Response.md

@@ -0,0 +1,20 @@
+# SeoOptimiseProducts202Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** | A message describing the optimisation status | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SeoOptimiseProducts202Response } from '@teemill/product-catalog';
+
+const instance: SeoOptimiseProducts202Response = {
+    message,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)