@teemill/product-catalog 1.64.1 → 1.66.0

package/docs/ApplicationGroup.md

@@ -0,0 +1,28 @@
+# ApplicationGroup
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Unique object identifier | [default to undefined]
+**ref** | **string** | A reference to the application group resource location | [default to undefined]
+**name** | **string** | Name of the application group | [default to undefined]
+**createdAt** | **string** |  | [default to undefined]
+**updatedAt** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { ApplicationGroup } from '@teemill/product-catalog';
+
+const instance: ApplicationGroup = {
+    id,
+    ref,
+    name,
+    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/ApplicationGroupsApi.md

@@ -0,0 +1,317 @@
+# ApplicationGroupsApi
+
+All URIs are relative to *https://api.podos.io*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**createApplicationGroup**](#createapplicationgroup) | **POST** /v1/catalog/applications/groups | Create application group|
+|[**deleteApplicationGroup**](#deleteapplicationgroup) | **DELETE** /v1/catalog/applications/groups/{applicationGroupId} | Delete an application group|
+|[**getApplicationGroup**](#getapplicationgroup) | **GET** /v1/catalog/applications/groups/{applicationGroupId} | Get an application group|
+|[**listApplicationGroups**](#listapplicationgroups) | **GET** /v1/catalog/applications/groups | List application groups|
+|[**updateApplicationGroup**](#updateapplicationgroup) | **PATCH** /v1/catalog/applications/groups/{applicationGroupId} | Update application group|
+
+# **createApplicationGroup**
+> ApplicationGroup createApplicationGroup()
+
+Creates a new application group. Application groups are used to organize design applications that share the same source file, particularly useful for DTF (Direct to Film) transfers where the same transfer can be used across multiple products or variants.
+
+### Example
+
+```typescript
+import {
+    ApplicationGroupsApi,
+    Configuration,
+    CreateApplicationGroupRequest
+} from '@teemill/product-catalog';
+
+const configuration = new Configuration();
+const apiInstance = new ApplicationGroupsApi(configuration);
+
+let project: string; //What project it is (default to undefined)
+let createApplicationGroupRequest: CreateApplicationGroupRequest; //Create a new application group. (optional)
+
+const { status, data } = await apiInstance.createApplicationGroup(
+    project,
+    createApplicationGroupRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **createApplicationGroupRequest** | **CreateApplicationGroupRequest**| Create a new application group. | |
+| **project** | [**string**] | What project it is | defaults to undefined|
+
+
+### Return type
+
+**ApplicationGroup**
+
+### 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 an application group. |  -  |
+|**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)
+
+# **deleteApplicationGroup**
+> deleteApplicationGroup()
+
+Deletes an existing application group.
+
+### Example
+
+```typescript
+import {
+    ApplicationGroupsApi,
+    Configuration
+} from '@teemill/product-catalog';
+
+const configuration = new Configuration();
+const apiInstance = new ApplicationGroupsApi(configuration);
+
+let project: string; //What project it is (default to undefined)
+let applicationGroupId: string; //Application group\'s unique identifier (default to undefined)
+
+const { status, data } = await apiInstance.deleteApplicationGroup(
+    project,
+    applicationGroupId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **project** | [**string**] | What project it is | defaults to undefined|
+| **applicationGroupId** | [**string**] | Application group\'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** | Set deleted |  -  |
+|**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)
+
+# **getApplicationGroup**
+> ApplicationGroup getApplicationGroup()
+
+Get an application group by the given id. Application groups are used to organize design applications that share the same source file, particularly useful for DTF (Direct to Film) transfers where the same transfer can be used across multiple products or variants.
+
+### Example
+
+```typescript
+import {
+    ApplicationGroupsApi,
+    Configuration
+} from '@teemill/product-catalog';
+
+const configuration = new Configuration();
+const apiInstance = new ApplicationGroupsApi(configuration);
+
+let project: string; //What project it is (default to undefined)
+let applicationGroupId: string; //Application group\'s unique identifier (default to undefined)
+
+const { status, data } = await apiInstance.getApplicationGroup(
+    project,
+    applicationGroupId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **project** | [**string**] | What project it is | defaults to undefined|
+| **applicationGroupId** | [**string**] | Application group\'s unique identifier | defaults to undefined|
+
+
+### Return type
+
+**ApplicationGroup**
+
+### 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 an application group. |  -  |
+|**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)
+
+# **listApplicationGroups**
+> ApplicationGroupsResponse listApplicationGroups()
+
+Lists all application groups that belong to the given project. Application groups are used to organize design applications that share the same source file, particularly useful for DTF (Direct to Film) transfers where the same transfer can be used across multiple products or variants.
+
+### Example
+
+```typescript
+import {
+    ApplicationGroupsApi,
+    Configuration
+} from '@teemill/product-catalog';
+
+const configuration = new Configuration();
+const apiInstance = new ApplicationGroupsApi(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 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.listApplicationGroups(
+    project,
+    pageToken,
+    search,
+    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;, and \&#39;tag:\&quot;tag name\&quot;\&#39;. Multiple filters can be combined with spaces and commas. | (optional) defaults to 'enabled:true'|
+| **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
+
+**ApplicationGroupsResponse**
+
+### 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 application groups. |  -  |
+|**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)
+
+# **updateApplicationGroup**
+> ApplicationGroup updateApplicationGroup()
+
+Updates an existing application group.
+
+### Example
+
+```typescript
+import {
+    ApplicationGroupsApi,
+    Configuration,
+    UpdateApplicationGroupRequest
+} from '@teemill/product-catalog';
+
+const configuration = new Configuration();
+const apiInstance = new ApplicationGroupsApi(configuration);
+
+let project: string; //What project it is (default to undefined)
+let applicationGroupId: string; //Application group\'s unique identifier (default to undefined)
+let updateApplicationGroupRequest: UpdateApplicationGroupRequest; //Update an existing application group. (optional)
+
+const { status, data } = await apiInstance.updateApplicationGroup(
+    project,
+    applicationGroupId,
+    updateApplicationGroupRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **updateApplicationGroupRequest** | **UpdateApplicationGroupRequest**| Update an existing application group. | |
+| **project** | [**string**] | What project it is | defaults to undefined|
+| **applicationGroupId** | [**string**] | Application group\&#39;s unique identifier | defaults to undefined|
+
+
+### Return type
+
+**ApplicationGroup**
+
+### 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 an application group. |  -  |
+|**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/ApplicationGroupsResponse.md

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

@@ -306,7 +306,7 @@ const { status, data } = await apiInstance.updateApplicationSet(
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-|**201** | Successfully retrieved an application set. |  -  |
+|**200** | Successfully retrieved an application set. |  -  |
 |**400** | Failed validation. |  -  |
 |**401** | Not authorised to access this resource. |  -  |
 |**403** | Refuse to authorize. |  -  |

package/docs/CreateApplication.md

@@ -9,7 +9,7 @@ Name | Type | Description | Notes
 **placement** | **string** | Placement of the application. Available placements depend on the chosen product and technology. | [default to undefined]
 **additionalInstructions** | **string** | Any additional instructions for the application | [optional] [default to undefined]
 **src** | **string** | Publicly available design file URL. This will fill the design area of the warehouse product. It will be centered horizontally and aligned to the top of the design area. | [default to undefined]
-**group** | **string** | The group of the application. The src across all applications in the same group will be considered the same src. The is useful for DTF when using the same transfer across multiple products. | [optional] [default to undefined]
+**groupRef** | **string** | A reference to the application group. The src across all applications in the same group will be considered the same src. The is useful for DTF when using the same transfer across multiple products. | [optional] [default to undefined]
 **stockedOnly** | **boolean** | If set to true, transfers for this application will not be printed on demand, and will need to be stocked in trays in the factory. Note that this can only be set if the technology is stockable, such as DTF. | [optional] [default to undefined]
 **properties** | [**CreateApplicationProperties**](CreateApplicationProperties.md) |  | [optional] [default to undefined]
 
@@ -23,7 +23,7 @@ const instance: CreateApplication = {
     placement,
     additionalInstructions,
     src,
-    group,
+    groupRef,
     stockedOnly,
     properties,
 };

package/docs/CreateApplicationGroupRequest.md

@@ -0,0 +1,20 @@
+# CreateApplicationGroupRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** | Name of the application group | [default to undefined]
+
+## Example
+
+```typescript
+import { CreateApplicationGroupRequest } from '@teemill/product-catalog';
+
+const instance: CreateApplicationGroupRequest = {
+    name,
+};
+```
+
+[[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/UpdateApplicationGroupRequest.md

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