@teemill/product-catalog 1.81.2 → 1.83.1

package/dist/esm/index.d.ts

@@ -2,7 +2,7 @@
  * Product Catalog API
  * Manage your 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.81.2
+ * The version of the OpenAPI document: 1.83.1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/index.js

@@ -4,7 +4,7 @@
  * Product Catalog API
  * Manage your 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.81.2
+ * The version of the OpenAPI document: 1.83.1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/index.d.ts

@@ -2,7 +2,7 @@
  * Product Catalog API
  * Manage your 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.81.2
+ * The version of the OpenAPI document: 1.83.1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/index.js

@@ -5,7 +5,7 @@
  * Product Catalog API
  * Manage your 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.81.2
+ * The version of the OpenAPI document: 1.83.1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/docs/AnalyticsItem.md

@@ -0,0 +1,30 @@
+# AnalyticsItem
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Unique object identifier | [default to undefined]
+**sales** | **number** | The number of sales in the last 30 days. | [default to undefined]
+**traffic** | **number** | The traffic of the product. | [default to undefined]
+**conversionRate** | **number** | The conversion rate of the product. | [default to undefined]
+**basketRate** | **number** | The add to basket rate of the product. | [default to undefined]
+**revenue** | **number** | The revenue of the product. | [default to undefined]
+
+## Example
+
+```typescript
+import { AnalyticsItem } from '@teemill/product-catalog';
+
+const instance: AnalyticsItem = {
+    id,
+    sales,
+    traffic,
+    conversionRate,
+    basketRate,
+    revenue,
+};
+```
+
+[[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/BundleProduct.md

@@ -12,7 +12,7 @@ Name | Type | Description | Notes
 **slug** | **string** |  | [optional] [readonly] [default to undefined]
 **brand** | **string** |  | [optional] [default to undefined]
 **enabled** | **boolean** |  | [optional] [default to undefined]
-**seoMetadata** | [**SEOMetadata**](SEOMetadata.md) |  | [optional] [default to undefined]
+**seoMetadata** | [**SEOMetadata1**](SEOMetadata1.md) |  | [optional] [default to undefined]
 **targetSearchPhraseData** | [**TargetSearchPhraseData**](TargetSearchPhraseData.md) |  | [optional] [default to undefined]
 **tags** | **Array<string>** |  | [optional] [default to undefined]
 **internalTags** | **Array<string>** |  | [optional] [default to undefined]

package/docs/CreateBundleProduct.md

@@ -9,7 +9,7 @@ Name | Type | Description | Notes
 **description** | **string** | Product description | [optional] [default to undefined]
 **enabled** | **boolean** | Whether the product is enabled upon creation. | [optional] [default to undefined]
 **slug** | **string** | A custom URL slug for the product. This must be unique for each product on the project. | [optional] [default to undefined]
-**seoMetadata** | [**UpdateProductsRequestProductsInnerSeoMetadata**](UpdateProductsRequestProductsInnerSeoMetadata.md) |  | [optional] [default to undefined]
+**seoMetadata** | [**CreateBundleProductSeoMetadata**](CreateBundleProductSeoMetadata.md) |  | [optional] [default to undefined]
 **targetSearchPhrase** | **string** | The primary target search phrase for the product that you wish to rank for in search engine results.  **Note:** This field requires the website integration | [optional] [default to undefined]
 **targetSearchPhraseSynonyms** | **Array<string>** | Synonyms for the target search phrase. **Note:** This field requires the website integration | [optional] [default to undefined]
 **tags** | **Array<string>** | Additional product tags used for searching and filtering. | [optional] [default to undefined]

package/docs/CreateBundleProductSeoMetadata.md

@@ -0,0 +1,22 @@
+# CreateBundleProductSeoMetadata
+
+
+## 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 { CreateBundleProductSeoMetadata } from '@teemill/product-catalog';
+
+const instance: CreateBundleProductSeoMetadata = {
+    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/CreateProductRequest.md

@@ -11,7 +11,7 @@ Name | Type | Description | Notes
 **enabled** | **boolean** | Whether the product is enabled upon creation. | [optional] [default to undefined]
 **slug** | **string** | A custom URL slug for the product. This must be unique for each product on the project. | [optional] [default to undefined]
 **brand** | **string** | The brand of the product. | [optional] [default to undefined]
-**seoMetadata** | [**UpdateProductsRequestProductsInnerSeoMetadata**](UpdateProductsRequestProductsInnerSeoMetadata.md) |  | [optional] [default to undefined]
+**seoMetadata** | [**CreateBundleProductSeoMetadata**](CreateBundleProductSeoMetadata.md) |  | [optional] [default to undefined]
 **targetSearchPhrase** | **string** | The primary target search phrase for the product that you wish to rank for in search engine results.  **Note:** This field requires the website integration | [optional] [default to undefined]
 **targetSearchPhraseSynonyms** | **Array<string>** | Synonyms for the target search phrase. **Note:** This field requires the website integration | [optional] [default to undefined]
 **tags** | **Array<string>** | Additional product tags used for searching and filtering. | [optional] [default to undefined]

package/docs/Product.md

@@ -42,6 +42,7 @@ Name | Type | Description | Notes
 **integrationConnections** | [**Array<UpdateProductsRequestProductsInnerIntegrationConnectionsInner>**](UpdateProductsRequestProductsInnerIntegrationConnectionsInner.md) |  | [optional] [default to undefined]
 **showSaleBadge** | **boolean** | Whether to show a sale badge on the product | [optional] [default to undefined]
 **license** | [**License**](License.md) |  | [optional] [default to undefined]
+**createdBy** | **string** | The user ID of the user who created the product | [optional] [default to undefined]
 
 ## Example
 
@@ -86,6 +87,7 @@ const instance: Product = {
     integrationConnections,
     showSaleBadge,
     license,
+    createdBy,
 };
 ```
 

package/docs/ProductAnalyticsApi.md

@@ -0,0 +1,75 @@
+# ProductAnalyticsApi
+
+All URIs are relative to *https://api.podos.io*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**listProductAnalytics**](#listproductanalytics) | **GET** /v1/catalog/analytics | List product analytics|
+
+# **listProductAnalytics**
+> ProductAnalyticsResponse listProductAnalytics()
+
+Lists all product analytics items.
+
+### Example
+
+```typescript
+import {
+    ProductAnalyticsApi,
+    Configuration
+} from '@teemill/product-catalog';
+
+const configuration = new Configuration();
+const apiInstance = new ProductAnalyticsApi(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\"\', \'tag:\"tag name\"\', and \'type:product,template,bundle\'. 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 100)
+
+const { status, data } = await apiInstance.listProductAnalytics(
+    project,
+    pageToken,
+    search,
+    sortBy,
+    pageSize
+);
+```
+
+### 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;, \&#39;tag:\&quot;tag name\&quot;\&#39;, and \&#39;type:product,template,bundle\&#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 100|
+
+
+### Return type
+
+**ProductAnalyticsResponse**
+
+### 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 product analytics items. |  -  |
+|**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)
+

package/docs/ProductAnalyticsResponse.md

@@ -0,0 +1,20 @@
+# ProductAnalyticsResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**analytics** | [**Array<AnalyticsItem>**](AnalyticsItem.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ProductAnalyticsResponse } from '@teemill/product-catalog';
+
+const instance: ProductAnalyticsResponse = {
+    analytics,
+};
+```
+
+[[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/ProductBundleItemsInner.md

@@ -12,7 +12,7 @@ Name | Type | Description | Notes
 **slug** | **string** |  | [optional] [readonly] [default to undefined]
 **brand** | **string** |  | [optional] [default to undefined]
 **enabled** | **boolean** |  | [optional] [default to undefined]
-**seoMetadata** | [**SEOMetadata**](SEOMetadata.md) |  | [optional] [default to undefined]
+**seoMetadata** | [**SEOMetadata1**](SEOMetadata1.md) |  | [optional] [default to undefined]
 **targetSearchPhraseData** | [**TargetSearchPhraseData**](TargetSearchPhraseData.md) |  | [optional] [default to undefined]
 **tags** | **Array<string>** |  | [optional] [default to undefined]
 **internalTags** | **Array<string>** |  | [optional] [default to undefined]

package/docs/SEOMetadata.md

@@ -8,6 +8,7 @@ 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]
+**noIndex** | **boolean** | Whether to prevent the product from being indexed by search engines. | [optional] [default to false]
 
 ## Example
 
@@ -17,6 +18,7 @@ import { SEOMetadata } from '@teemill/product-catalog';
 const instance: SEOMetadata = {
     title,
     description,
+    noIndex,
 };
 ```
 

package/docs/SEOMetadata1.md

@@ -0,0 +1,23 @@
+# SEOMetadata1
+
+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 { SEOMetadata1 } from '@teemill/product-catalog';
+
+const instance: SEOMetadata1 = {
+    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/UpdateProductsRequestProductsInnerSeoMetadata.md

@@ -7,6 +7,7 @@ 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]
+**noIndex** | **boolean** | Whether to prevent the product from being indexed by search engines. | [optional] [default to false]
 
 ## Example
 
@@ -16,6 +17,7 @@ import { UpdateProductsRequestProductsInnerSeoMetadata } from '@teemill/product-
 const instance: UpdateProductsRequestProductsInnerSeoMetadata = {
     title,
     description,
+    noIndex,
 };
 ```
 

package/index.ts

@@ -4,7 +4,7 @@
  * Product Catalog API
  * Manage your 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.81.2
+ * The version of the OpenAPI document: 1.83.1
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@teemill/product-catalog",
-  "version": "1.81.2",
+  "version": "1.83.1",
   "description": "OpenAPI client for @teemill/product-catalog",
   "author": "OpenAPI-Generator Contributors",
   "repository": {