@teemill/product-catalog 1.48.0 → 1.50.0

package/docs/VariantsApi.md

@@ -0,0 +1,138 @@
+# VariantsApi
+
+All URIs are relative to *https://api.podos.io*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getVariant**](#getvariant) | **GET** /v1/catalog/variants/{variantId} | Get variant|
+|[**listVariants**](#listvariants) | **GET** /v1/catalog/variants | List variants|
+
+# **getVariant**
+> Variant getVariant()
+
+Gets a variant by a given ID.
+
+### Example
+
+```typescript
+import {
+    VariantsApi,
+    Configuration
+} from '@teemill/product-catalog';
+
+const configuration = new Configuration();
+const apiInstance = new VariantsApi(configuration);
+
+let project: string; //What project it is (default to undefined)
+let variantId: string; //Variants 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.getVariant(
+    project,
+    variantId,
+    fields
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **project** | [**string**] | What project it is | defaults to undefined|
+| **variantId** | [**string**] | Variants unique identifier | defaults to undefined|
+| **fields** | [**string**] | Filter response fields to only include a subset of the resource. | (optional) defaults to undefined|
+
+
+### Return type
+
+**Variant**
+
+### 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 variant. |  -  |
+|**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)
+
+# **listVariants**
+> VariantsResponse listVariants()
+
+Lists all variants that belong to enabled products attached to the given project.
+
+### Example
+
+```typescript
+import {
+    VariantsApi,
+    Configuration
+} from '@teemill/product-catalog';
+
+const configuration = new Configuration();
+const apiInstance = new VariantsApi(configuration);
+
+let project: string; //What project it is (default to undefined)
+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 pageToken: number; //Page reference token (optional) (default to 1)
+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)
+let fields: string; //Filter response fields to only include a subset of the resource. (optional) (default to undefined)
+
+const { status, data } = await apiInstance.listVariants(
+    project,
+    search,
+    pageToken,
+    pageSize,
+    fields
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **project** | [**string**] | What project it is | defaults to undefined|
+| **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'|
+| **pageToken** | [**number**] | Page reference token | (optional) defaults to 1|
+| **pageSize** | [**number**] | Max page size. This is the maximum page size that will be returned, but it might be smaller. | (optional) defaults to 100|
+| **fields** | [**string**] | Filter response fields to only include a subset of the resource. | (optional) defaults to undefined|
+
+
+### Return type
+
+**VariantsResponse**
+
+### 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 variants. |  -  |
+|**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/VariantsResponse.md

@@ -0,0 +1,22 @@
+# VariantsResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**variants** | [**Array<Variant>**](Variant.md) |  | [optional] [default to undefined]
+**nextPageToken** | **number** | The token referencing the next page number | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { VariantsResponse } from '@teemill/product-catalog';
+
+const instance: VariantsResponse = {
+    variants,
+    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/Video.md

@@ -0,0 +1,31 @@
+# Video
+
+Video object
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Unique object identifier | [optional] [default to undefined]
+**src** | **string** |  | [optional] [default to undefined]
+**alt** | **string** |  | [optional] [default to undefined]
+**sortOrder** | **number** |  | [optional] [default to undefined]
+**createdAt** | **string** |  | [optional] [default to undefined]
+**updatedAt** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Video } from '@teemill/product-catalog';
+
+const instance: Video = {
+    id,
+    src,
+    alt,
+    sortOrder,
+    createdAt,
+    updatedAt,
+};
+```
+
+[[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/VideoFile.md

@@ -0,0 +1,20 @@
+# VideoFile
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**src** | **string** | Publicly available file URL. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { VideoFile } from '@teemill/product-catalog';
+
+const instance: VideoFile = {
+    src,
+};
+```
+
+[[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/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.48.0
+ * The version of the OpenAPI document: 1.50.0
  * 
  *
  * 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.48.0",
+  "version": "1.50.0",
   "description": "OpenAPI client for @teemill/product-catalog",
   "author": "OpenAPI-Generator Contributors",
   "repository": {