@teemill/product-catalog 1.96.0 → 1.97.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +0 -10
- package/README.md +2 -15
- package/api.ts +1 -397
- package/base.ts +1 -1
- package/common.ts +2 -2
- package/configuration.ts +1 -1
- package/dist/api.d.ts +1 -240
- package/dist/api.js +1 -240
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +2 -2
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +1 -240
- package/dist/esm/api.js +1 -240
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +2 -2
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/docs/ProductsApi.md +0 -185
- package/index.ts +1 -1
- package/package.json +1 -1
package/docs/ProductsApi.md
CHANGED
|
@@ -5,18 +5,15 @@ All URIs are relative to *https://api.podos.io*
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
7
|
|[**autoMerchProducts**](#automerchproducts) | **POST** /v1/catalog/products/auto-merch | AI auto merchandise products.|
|
|
8
|
-
|[**bulkUpdateProductMarketplaceListings**](#bulkupdateproductmarketplacelistings) | **PATCH** /v1/catalog/products/marketplace-listings | Bulk update product marketplaces|
|
|
9
8
|
|[**createProduct**](#createproduct) | **POST** /v1/catalog/products | Create product|
|
|
10
9
|
|[**deleteProduct**](#deleteproduct) | **DELETE** /v1/catalog/products/{productId} | Delete catalog product|
|
|
11
10
|
|[**deleteProducts**](#deleteproducts) | **DELETE** /v1/catalog/products | Delete products|
|
|
12
11
|
|[**duplicateProducts**](#duplicateproducts) | **POST** /v1/catalog/products/duplicate | Duplicate products.|
|
|
13
12
|
|[**exportProducts**](#exportproducts) | **GET** /v1/catalog/products/export | Export products|
|
|
14
|
-
|[**getMarketplaceListings**](#getmarketplacelistings) | **GET** /v1/catalog/products/{productId}/marketplace-listings | Get product marketplaces|
|
|
15
13
|
|[**getProduct**](#getproduct) | **GET** /v1/catalog/products/{productId} | Get product|
|
|
16
14
|
|[**importProducts**](#importproducts) | **POST** /v1/catalog/products/import | Import products|
|
|
17
15
|
|[**listProducts**](#listproducts) | **GET** /v1/catalog/products | List products|
|
|
18
16
|
|[**seoOptimiseProducts**](#seooptimiseproducts) | **POST** /v1/catalog/products/ai-seo-optimise | AI SEO optimise products.|
|
|
19
|
-
|[**updateMarketplaceListings**](#updatemarketplacelistings) | **PATCH** /v1/catalog/products/{productId}/marketplace-listings | Update product marketplaces|
|
|
20
17
|
|[**updateProduct**](#updateproduct) | **PATCH** /v1/catalog/products/{productId} | Update product|
|
|
21
18
|
|[**updateProducts**](#updateproducts) | **PATCH** /v1/catalog/products | Update products|
|
|
22
19
|
|
|
@@ -80,66 +77,6 @@ const { status, data } = await apiInstance.autoMerchProducts(
|
|
|
80
77
|
|
|
81
78
|
[[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)
|
|
82
79
|
|
|
83
|
-
# **bulkUpdateProductMarketplaceListings**
|
|
84
|
-
> BulkUpdateMarketplaceListingResponse bulkUpdateProductMarketplaceListings(bulkUpdateMarketplaceListingRequest)
|
|
85
|
-
|
|
86
|
-
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.
|
|
87
|
-
|
|
88
|
-
### Example
|
|
89
|
-
|
|
90
|
-
```typescript
|
|
91
|
-
import {
|
|
92
|
-
ProductsApi,
|
|
93
|
-
Configuration,
|
|
94
|
-
BulkUpdateMarketplaceListingRequest
|
|
95
|
-
} from '@teemill/product-catalog';
|
|
96
|
-
|
|
97
|
-
const configuration = new Configuration();
|
|
98
|
-
const apiInstance = new ProductsApi(configuration);
|
|
99
|
-
|
|
100
|
-
let project: string; //What project it is (default to undefined)
|
|
101
|
-
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`).
|
|
102
|
-
|
|
103
|
-
const { status, data } = await apiInstance.bulkUpdateProductMarketplaceListings(
|
|
104
|
-
project,
|
|
105
|
-
bulkUpdateMarketplaceListingRequest
|
|
106
|
-
);
|
|
107
|
-
```
|
|
108
|
-
|
|
109
|
-
### Parameters
|
|
110
|
-
|
|
111
|
-
|Name | Type | Description | Notes|
|
|
112
|
-
|------------- | ------------- | ------------- | -------------|
|
|
113
|
-
| **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`). | |
|
|
114
|
-
| **project** | [**string**] | What project it is | defaults to undefined|
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
### Return type
|
|
118
|
-
|
|
119
|
-
**BulkUpdateMarketplaceListingResponse**
|
|
120
|
-
|
|
121
|
-
### Authorization
|
|
122
|
-
|
|
123
|
-
[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
|
|
124
|
-
|
|
125
|
-
### HTTP request headers
|
|
126
|
-
|
|
127
|
-
- **Content-Type**: application/json
|
|
128
|
-
- **Accept**: application/json
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
### HTTP response details
|
|
132
|
-
| Status code | Description | Response headers |
|
|
133
|
-
|-------------|-------------|------------------|
|
|
134
|
-
|**200** | Successfully updated product marketplace data. | - |
|
|
135
|
-
|**400** | Failed validation. | - |
|
|
136
|
-
|**401** | Not authorised to access this resource. | - |
|
|
137
|
-
|**403** | Refuse to authorize. | - |
|
|
138
|
-
|**404** | Resource not found. | - |
|
|
139
|
-
|**500** | Unknown server error. | - |
|
|
140
|
-
|
|
141
|
-
[[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)
|
|
142
|
-
|
|
143
80
|
# **createProduct**
|
|
144
81
|
> Product createProduct()
|
|
145
82
|
|
|
@@ -457,65 +394,6 @@ const { status, data } = await apiInstance.exportProducts(
|
|
|
457
394
|
|
|
458
395
|
[[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)
|
|
459
396
|
|
|
460
|
-
# **getMarketplaceListings**
|
|
461
|
-
> MarketplaceListingsResponse getMarketplaceListings()
|
|
462
|
-
|
|
463
|
-
Gets marketplace listing data for a product.
|
|
464
|
-
|
|
465
|
-
### Example
|
|
466
|
-
|
|
467
|
-
```typescript
|
|
468
|
-
import {
|
|
469
|
-
ProductsApi,
|
|
470
|
-
Configuration
|
|
471
|
-
} from '@teemill/product-catalog';
|
|
472
|
-
|
|
473
|
-
const configuration = new Configuration();
|
|
474
|
-
const apiInstance = new ProductsApi(configuration);
|
|
475
|
-
|
|
476
|
-
let project: string; //What project it is (default to undefined)
|
|
477
|
-
let productId: string; //Product\'s unique identifier (default to undefined)
|
|
478
|
-
|
|
479
|
-
const { status, data } = await apiInstance.getMarketplaceListings(
|
|
480
|
-
project,
|
|
481
|
-
productId
|
|
482
|
-
);
|
|
483
|
-
```
|
|
484
|
-
|
|
485
|
-
### Parameters
|
|
486
|
-
|
|
487
|
-
|Name | Type | Description | Notes|
|
|
488
|
-
|------------- | ------------- | ------------- | -------------|
|
|
489
|
-
| **project** | [**string**] | What project it is | defaults to undefined|
|
|
490
|
-
| **productId** | [**string**] | Product\'s unique identifier | defaults to undefined|
|
|
491
|
-
|
|
492
|
-
|
|
493
|
-
### Return type
|
|
494
|
-
|
|
495
|
-
**MarketplaceListingsResponse**
|
|
496
|
-
|
|
497
|
-
### Authorization
|
|
498
|
-
|
|
499
|
-
[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
|
|
500
|
-
|
|
501
|
-
### HTTP request headers
|
|
502
|
-
|
|
503
|
-
- **Content-Type**: Not defined
|
|
504
|
-
- **Accept**: application/json
|
|
505
|
-
|
|
506
|
-
|
|
507
|
-
### HTTP response details
|
|
508
|
-
| Status code | Description | Response headers |
|
|
509
|
-
|-------------|-------------|------------------|
|
|
510
|
-
|**200** | Successfully retrieved product marketplace data. | - |
|
|
511
|
-
|**400** | Failed validation. | - |
|
|
512
|
-
|**401** | Not authorised to access this resource. | - |
|
|
513
|
-
|**403** | Refuse to authorize. | - |
|
|
514
|
-
|**404** | Resource not found. | - |
|
|
515
|
-
|**500** | Unknown server error. | - |
|
|
516
|
-
|
|
517
|
-
[[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)
|
|
518
|
-
|
|
519
397
|
# **getProduct**
|
|
520
398
|
> Product getProduct()
|
|
521
399
|
|
|
@@ -824,69 +702,6 @@ const { status, data } = await apiInstance.seoOptimiseProducts(
|
|
|
824
702
|
|
|
825
703
|
[[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)
|
|
826
704
|
|
|
827
|
-
# **updateMarketplaceListings**
|
|
828
|
-
> MarketplaceListingsResponse updateMarketplaceListings()
|
|
829
|
-
|
|
830
|
-
Updates marketplace listing data for a product.
|
|
831
|
-
|
|
832
|
-
### Example
|
|
833
|
-
|
|
834
|
-
```typescript
|
|
835
|
-
import {
|
|
836
|
-
ProductsApi,
|
|
837
|
-
Configuration,
|
|
838
|
-
UpdateMarketplaceListingRequest
|
|
839
|
-
} from '@teemill/product-catalog';
|
|
840
|
-
|
|
841
|
-
const configuration = new Configuration();
|
|
842
|
-
const apiInstance = new ProductsApi(configuration);
|
|
843
|
-
|
|
844
|
-
let project: string; //What project it is (default to undefined)
|
|
845
|
-
let productId: string; //Product\'s unique identifier (default to undefined)
|
|
846
|
-
let updateMarketplaceListingRequest: UpdateMarketplaceListingRequest; //The marketplace listing fields to update. Only the fields provided will be modified. (optional)
|
|
847
|
-
|
|
848
|
-
const { status, data } = await apiInstance.updateMarketplaceListings(
|
|
849
|
-
project,
|
|
850
|
-
productId,
|
|
851
|
-
updateMarketplaceListingRequest
|
|
852
|
-
);
|
|
853
|
-
```
|
|
854
|
-
|
|
855
|
-
### Parameters
|
|
856
|
-
|
|
857
|
-
|Name | Type | Description | Notes|
|
|
858
|
-
|------------- | ------------- | ------------- | -------------|
|
|
859
|
-
| **updateMarketplaceListingRequest** | **UpdateMarketplaceListingRequest**| The marketplace listing fields to update. Only the fields provided will be modified. | |
|
|
860
|
-
| **project** | [**string**] | What project it is | defaults to undefined|
|
|
861
|
-
| **productId** | [**string**] | Product\'s unique identifier | defaults to undefined|
|
|
862
|
-
|
|
863
|
-
|
|
864
|
-
### Return type
|
|
865
|
-
|
|
866
|
-
**MarketplaceListingsResponse**
|
|
867
|
-
|
|
868
|
-
### Authorization
|
|
869
|
-
|
|
870
|
-
[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
|
|
871
|
-
|
|
872
|
-
### HTTP request headers
|
|
873
|
-
|
|
874
|
-
- **Content-Type**: application/json
|
|
875
|
-
- **Accept**: application/json
|
|
876
|
-
|
|
877
|
-
|
|
878
|
-
### HTTP response details
|
|
879
|
-
| Status code | Description | Response headers |
|
|
880
|
-
|-------------|-------------|------------------|
|
|
881
|
-
|**200** | Successfully retrieved product marketplace data. | - |
|
|
882
|
-
|**400** | Failed validation. | - |
|
|
883
|
-
|**401** | Not authorised to access this resource. | - |
|
|
884
|
-
|**403** | Refuse to authorize. | - |
|
|
885
|
-
|**404** | Resource not found. | - |
|
|
886
|
-
|**500** | Unknown server error. | - |
|
|
887
|
-
|
|
888
|
-
[[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)
|
|
889
|
-
|
|
890
705
|
# **updateProduct**
|
|
891
706
|
> Product updateProduct()
|
|
892
707
|
|
package/index.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Product Catalog
|
|
5
5
|
* 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.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.
|
|
7
|
+
* The version of the OpenAPI document: 1.97.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|