@teemill/product-catalog 1.95.0 → 1.96.0

package/docs/BulkUpdateMarketplaceListingProduct.md

@@ -0,0 +1,33 @@
+# BulkUpdateMarketplaceListingProduct
+
+Marketplace listing fields to update for a single product within a marketplace group.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Unique object identifier | [default to undefined]
+**title** | **string** |  | [optional] [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+**metaTitle** | **string** |  | [optional] [default to undefined]
+**metaDescription** | **string** |  | [optional] [default to undefined]
+**price** | **number** |  | [optional] [default to undefined]
+**images** | [**Array<ImageFile>**](ImageFile.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { BulkUpdateMarketplaceListingProduct } from '@teemill/product-catalog';
+
+const instance: BulkUpdateMarketplaceListingProduct = {
+    id,
+    title,
+    description,
+    metaTitle,
+    metaDescription,
+    price,
+    images,
+};
+```
+
+[[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/BulkUpdateMarketplaceListingRequest.md

@@ -0,0 +1,21 @@
+# BulkUpdateMarketplaceListingRequest
+
+Listing updates scoped to exactly one marketplace per HTTP request. To change another marketplace, issue another request.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**marketplace** | [**Array<BulkUpdateMarketplaceListing>**](BulkUpdateMarketplaceListing.md) | Must contain exactly one marketplace group (`code` plus the `products` to update). | [default to undefined]
+
+## Example
+
+```typescript
+import { BulkUpdateMarketplaceListingRequest } from '@teemill/product-catalog';
+
+const instance: BulkUpdateMarketplaceListingRequest = {
+    marketplace,
+};
+```
+
+[[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/BulkUpdateMarketplaceListingResponse.md

@@ -0,0 +1,21 @@
+# BulkUpdateMarketplaceListingResponse
+
+Updated marketplace listing data grouped by marketplace.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**marketplaceListings** | [**Array<BulkUpdatedMarketplaceListings>**](BulkUpdatedMarketplaceListings.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { BulkUpdateMarketplaceListingResponse } from '@teemill/product-catalog';
+
+const instance: BulkUpdateMarketplaceListingResponse = {
+    marketplaceListings,
+};
+```
+
+[[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/BulkUpdatedMarketplaceListing.md

@@ -0,0 +1,23 @@
+# BulkUpdatedMarketplaceListing
+
+Updated marketplace listing data for a product.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Unique object identifier | [default to undefined]
+**listing** | [**MarketplaceListingFields**](MarketplaceListingFields.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { BulkUpdatedMarketplaceListing } from '@teemill/product-catalog';
+
+const instance: BulkUpdatedMarketplaceListing = {
+    id,
+    listing,
+};
+```
+
+[[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/BulkUpdatedMarketplaceListings.md

@@ -0,0 +1,23 @@
+# BulkUpdatedMarketplaceListings
+
+Updated product listings for a marketplace.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **string** |  | [default to undefined]
+**products** | [**Array<BulkUpdatedMarketplaceListing>**](BulkUpdatedMarketplaceListing.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { BulkUpdatedMarketplaceListings } from '@teemill/product-catalog';
+
+const instance: BulkUpdatedMarketplaceListings = {
+    code,
+    products,
+};
+```
+
+[[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/CreateApplication.md

@@ -6,7 +6,7 @@ The payload for creating a new design application on a product variant.
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**technology** | **string** | The application technology used for this design application. `mug_sublimation` is deprecated. Use `sublimation_small` instead. | [default to undefined]
+**technology** | **string** | The application technology used for this design application. `mug_sublimation` is deprecated. Use `mini_sublimation` instead. | [default to undefined]
 **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 production print file URL for this application. For raster-only applications, this can also be used directly as the display image. | [default to undefined]

package/docs/MarketplaceListing.md

@@ -0,0 +1,35 @@
+# MarketplaceListing
+
+Product listing data for a marketplace.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **string** | The marketplace code. | [default to undefined]
+**name** | **string** | The display name of the marketplace. | [default to undefined]
+**title** | **string** |  | [optional] [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+**metaTitle** | **string** |  | [optional] [default to undefined]
+**metaDescription** | **string** |  | [optional] [default to undefined]
+**price** | **number** |  | [optional] [default to undefined]
+**images** | [**Array<Image>**](Image.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { MarketplaceListing } from '@teemill/product-catalog';
+
+const instance: MarketplaceListing = {
+    code,
+    name,
+    title,
+    description,
+    metaTitle,
+    metaDescription,
+    price,
+    images,
+};
+```
+
+[[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/MarketplaceListingFields.md

@@ -0,0 +1,31 @@
+# MarketplaceListingFields
+
+Product listing fields for a marketplace.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**title** | **string** |  | [optional] [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+**metaTitle** | **string** |  | [optional] [default to undefined]
+**metaDescription** | **string** |  | [optional] [default to undefined]
+**price** | **number** |  | [optional] [default to undefined]
+**images** | [**Array<Image>**](Image.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { MarketplaceListingFields } from '@teemill/product-catalog';
+
+const instance: MarketplaceListingFields = {
+    title,
+    description,
+    metaTitle,
+    metaDescription,
+    price,
+    images,
+};
+```
+
+[[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/MarketplaceListingsResponse.md

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

@@ -43,6 +43,7 @@ Name | Type | Description | Notes
 **personalizationTemplate** | **string** | a JSON string representing the personalization template for the product | [optional] [default to undefined]
 **optimisationHistory** | [**Array<OptimisationHistoryItem>**](OptimisationHistoryItem.md) | History of AI optimisations performed on the product | [optional] [default to undefined]
 **integrationConnections** | [**Array<UpdateProductsRequestProductsInnerIntegrationConnectionsInner>**](UpdateProductsRequestProductsInnerIntegrationConnectionsInner.md) |  | [optional] [default to undefined]
+**marketplaceListings** | [**Array<MarketplaceListing>**](MarketplaceListing.md) | Marketplace-specific listing data that can override product fields during integration syncs. | [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]
@@ -93,6 +94,7 @@ const instance: Product = {
     personalizationTemplate,
     optimisationHistory,
     integrationConnections,
+    marketplaceListings,
     showSaleBadge,
     license,
     createdBy,

package/docs/ProductsApi.md

@@ -5,15 +5,18 @@ All URIs are relative to *https://api.podos.io*
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
 |[**autoMerchProducts**](#automerchproducts) | **POST** /v1/catalog/products/auto-merch | AI auto merchandise products.|
+|[**bulkUpdateProductMarketplaceListings**](#bulkupdateproductmarketplacelistings) | **PATCH** /v1/catalog/products/marketplace-listings | Bulk update product marketplaces|
 |[**createProduct**](#createproduct) | **POST** /v1/catalog/products | Create product|
 |[**deleteProduct**](#deleteproduct) | **DELETE** /v1/catalog/products/{productId} | Delete catalog product|
 |[**deleteProducts**](#deleteproducts) | **DELETE** /v1/catalog/products | Delete products|
 |[**duplicateProducts**](#duplicateproducts) | **POST** /v1/catalog/products/duplicate | Duplicate products.|
 |[**exportProducts**](#exportproducts) | **GET** /v1/catalog/products/export | Export products|
+|[**getMarketplaceListings**](#getmarketplacelistings) | **GET** /v1/catalog/products/{productId}/marketplace-listings | Get product marketplaces|
 |[**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.|
+|[**updateMarketplaceListings**](#updatemarketplacelistings) | **PATCH** /v1/catalog/products/{productId}/marketplace-listings | Update product marketplaces|
 |[**updateProduct**](#updateproduct) | **PATCH** /v1/catalog/products/{productId} | Update product|
 |[**updateProducts**](#updateproducts) | **PATCH** /v1/catalog/products | Update products|
 
@@ -77,6 +80,66 @@ const { status, data } = await apiInstance.autoMerchProducts(
 
 [[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)
 
+# **bulkUpdateProductMarketplaceListings**
+> BulkUpdateMarketplaceListingResponse bulkUpdateProductMarketplaceListings(bulkUpdateMarketplaceListingRequest)
+
+Updates marketplace listing data for multiple products under a single marketplace. Each request carries exactly one marketplace group (see `BulkUpdateMarketplaceListingRequest.marketplace`); send additional requests to update another marketplace code.
+
+### Example
+
+```typescript
+import {
+    ProductsApi,
+    Configuration,
+    BulkUpdateMarketplaceListingRequest
+} from '@teemill/product-catalog';
+
+const configuration = new Configuration();
+const apiInstance = new ProductsApi(configuration);
+
+let project: string; //What project it is (default to undefined)
+let bulkUpdateMarketplaceListingRequest: BulkUpdateMarketplaceListingRequest; //Update marketplace listing fields for multiple products for one marketplace only. The `marketplaces` array must contain exactly one item (one `code` and its `products`).
+
+const { status, data } = await apiInstance.bulkUpdateProductMarketplaceListings(
+    project,
+    bulkUpdateMarketplaceListingRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **bulkUpdateMarketplaceListingRequest** | **BulkUpdateMarketplaceListingRequest**| Update marketplace listing fields for multiple products for one marketplace only. The `marketplaces` array must contain exactly one item (one `code` and its `products`). | |
+| **project** | [**string**] | What project it is | defaults to undefined|
+
+
+### Return type
+
+**BulkUpdateMarketplaceListingResponse**
+
+### 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 updated product marketplace data. |  -  |
+|**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)
+
 # **createProduct**
 > Product createProduct()
 
@@ -339,6 +402,7 @@ let end: string; //End of date range to filter (optional) (default to undefined)
 let dateFilterType: 'createdAt' | 'updatedAt'; //Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query. (optional) (default to 'createdAt')
 let maxRetailPrice: number; //Specify the maximum retail price to filter by. Products will be included so long as either at least one variant or the product itself (in the case of bundles) has a retail price less than or equal to the specified value. (optional) (default to undefined)
 let minRetailPrice: number; //Specify the minimum retail price to filter by. Products will be included so long as either at least one variant or the product itself (in the case of bundles) has a retail price greater than or equal to the specified value. (optional) (default to undefined)
+let marketplaceCode: string; //Export product data in the listing format for the selected marketplace code. (optional) (default to undefined)
 
 const { status, data } = await apiInstance.exportProducts(
     project,
@@ -347,7 +411,8 @@ const { status, data } = await apiInstance.exportProducts(
     end,
     dateFilterType,
     maxRetailPrice,
-    minRetailPrice
+    minRetailPrice,
+    marketplaceCode
 );
 ```
 
@@ -362,6 +427,7 @@ const { status, data } = await apiInstance.exportProducts(
 | **dateFilterType** | [**&#39;createdAt&#39; | &#39;updatedAt&#39;**]**Array<&#39;createdAt&#39; &#124; &#39;updatedAt&#39;>** | Specifies the type of date range filter to apply. Determines which date field the &#x60;start&#x60; and &#x60;end&#x60; fields should query. | (optional) defaults to 'createdAt'|
 | **maxRetailPrice** | [**number**] | Specify the maximum retail price to filter by. Products will be included so long as either at least one variant or the product itself (in the case of bundles) has a retail price less than or equal to the specified value. | (optional) defaults to undefined|
 | **minRetailPrice** | [**number**] | Specify the minimum retail price to filter by. Products will be included so long as either at least one variant or the product itself (in the case of bundles) has a retail price greater than or equal to the specified value. | (optional) defaults to undefined|
+| **marketplaceCode** | [**string**] | Export product data in the listing format for the selected marketplace code. | (optional) defaults to undefined|
 
 
 ### Return type
@@ -391,6 +457,65 @@ const { status, data } = await apiInstance.exportProducts(
 
 [[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)
 
+# **getMarketplaceListings**
+> MarketplaceListingsResponse getMarketplaceListings()
+
+Gets marketplace listing data for a 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.getMarketplaceListings(
+    project,
+    productId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **project** | [**string**] | What project it is | defaults to undefined|
+| **productId** | [**string**] | Product\&#39;s unique identifier | defaults to undefined|
+
+
+### Return type
+
+**MarketplaceListingsResponse**
+
+### 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 marketplace data. |  -  |
+|**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)
+
 # **getProduct**
 > Product getProduct()
 
@@ -699,6 +824,69 @@ const { status, data } = await apiInstance.seoOptimiseProducts(
 
 [[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)
 
+# **updateMarketplaceListings**
+> MarketplaceListingsResponse updateMarketplaceListings()
+
+Updates marketplace listing data for a product.
+
+### Example
+
+```typescript
+import {
+    ProductsApi,
+    Configuration,
+    UpdateMarketplaceListingRequest
+} 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 updateMarketplaceListingRequest: UpdateMarketplaceListingRequest; //The marketplace listing fields to update. Only the fields provided will be modified. (optional)
+
+const { status, data } = await apiInstance.updateMarketplaceListings(
+    project,
+    productId,
+    updateMarketplaceListingRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **updateMarketplaceListingRequest** | **UpdateMarketplaceListingRequest**| The marketplace listing fields to update. Only the fields provided will be modified. | |
+| **project** | [**string**] | What project it is | defaults to undefined|
+| **productId** | [**string**] | Product\&#39;s unique identifier | defaults to undefined|
+
+
+### Return type
+
+**MarketplaceListingsResponse**
+
+### 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 product marketplace data. |  -  |
+|**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()
 

package/docs/UpdateMarketplaceListing.md

@@ -0,0 +1,33 @@
+# UpdateMarketplaceListing
+
+Marketplace listing fields to update for a product.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **string** | The marketplace code to update. | [default to undefined]
+**title** | **string** |  | [optional] [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+**metaTitle** | **string** |  | [optional] [default to undefined]
+**metaDescription** | **string** |  | [optional] [default to undefined]
+**price** | **number** |  | [optional] [default to undefined]
+**images** | [**Array<ImageFile>**](ImageFile.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UpdateMarketplaceListing } from '@teemill/product-catalog';
+
+const instance: UpdateMarketplaceListing = {
+    code,
+    title,
+    description,
+    metaTitle,
+    metaDescription,
+    price,
+    images,
+};
+```
+
+[[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/UpdateMarketplaceListingRequest.md

@@ -0,0 +1,21 @@
+# UpdateMarketplaceListingRequest
+
+Marketplace listings to update for a product.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**marketplaces** | [**Array<UpdateMarketplaceListing>**](UpdateMarketplaceListing.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { UpdateMarketplaceListingRequest } from '@teemill/product-catalog';
+
+const instance: UpdateMarketplaceListingRequest = {
+    marketplaces,
+};
+```
+
+[[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
  * 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 product from the GFN Catalog, plus listing information such as title, description and tags.
  *
- * The version of the OpenAPI document: 1.95.0
+ * The version of the OpenAPI document: 1.96.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.95.0",
+  "version": "1.96.0",
   "description": "OpenAPI client for @teemill/product-catalog",
   "author": "OpenAPI-Generator Contributors",
   "repository": {
@@ -24,7 +24,7 @@
     "prepare": "npm run build"
   },
   "dependencies": {
-    "axios": "1.15.0"
+    "axios": "^1.16.0"
   },
   "devDependencies": {
     "@types/node": "12.11.5 - 12.20.42",