@teemill/product-catalog 1.48.0 → 1.49.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/README.md +115 -2
- package/api.ts +7 -1
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +7 -1
- package/dist/api.js +1 -1
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +7 -1
- package/dist/esm/api.js +1 -1
- 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 +1 -1
- 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/AdditionalFile.md +20 -0
- package/docs/ApiError.md +22 -0
- package/docs/Application.md +28 -0
- package/docs/ApplicationMockup.md +22 -0
- package/docs/ApplicationSet.md +38 -0
- package/docs/ApplicationSet1.md +22 -0
- package/docs/ApplicationSetRecord.md +26 -0
- package/docs/ApplicationSetsApi.md +317 -0
- package/docs/ApplicationSetsResponse.md +22 -0
- package/docs/Attribute.md +26 -0
- package/docs/AttributeThumbnail.md +23 -0
- package/docs/Attributes1Inner.md +22 -0
- package/docs/CreateApplication.md +24 -0
- package/docs/CreateApplicationSetRequest.md +30 -0
- package/docs/CreateApplicationSetRequestRecordsInner.md +22 -0
- package/docs/CreateApplicationSetRequestRecordsInnerAttributesInner.md +22 -0
- package/docs/CreateBundleProduct.md +54 -0
- package/docs/CreateProduct.md +56 -0
- package/docs/CreateProductAdditionalFilesInner.md +20 -0
- package/docs/CreateProductImagesInner.md +22 -0
- package/docs/CreateProductRequest.md +64 -0
- package/docs/CreateProductVariant.md +36 -0
- package/docs/CreateProductVariantImagesInner.md +20 -0
- package/docs/CreateProductVideosInner.md +20 -0
- package/docs/DuplicateProducts202Response.md +20 -0
- package/docs/DuplicateProductsRequest.md +22 -0
- package/docs/ExportProducts202Response.md +20 -0
- package/docs/Image.md +35 -0
- package/docs/ImageFile.md +22 -0
- package/docs/ImportProducts200Response.md +20 -0
- package/docs/Location.md +22 -0
- package/docs/MetaField.md +23 -0
- package/docs/OptimisationHistoryItem.md +22 -0
- package/docs/Price.md +23 -0
- package/docs/Product.md +86 -0
- package/docs/ProductAdditionalFilesInner.md +22 -0
- package/docs/ProductApplicationSetsInner.md +24 -0
- package/docs/ProductWarehouseProduct.md +22 -0
- package/docs/ProductsApi.md +626 -0
- package/docs/ProductsResponse.md +22 -0
- package/docs/SEOMetadata.md +23 -0
- package/docs/SeoOptimiseProducts202Response.md +20 -0
- package/docs/SeoOptimiseProductsRequest.md +22 -0
- package/docs/Stock.md +22 -0
- package/docs/TargetSearchPhraseData.md +22 -0
- package/docs/UpdateApplicationSetRequest.md +30 -0
- package/docs/UpdateApplicationSetRequestRecordsInner.md +22 -0
- package/docs/UpdateApplicationSetRequestRecordsInnerAttributesInner.md +22 -0
- package/docs/UpdateProductRequest.md +64 -0
- package/docs/UpdateProductRequestIntegrationConnectionsInner.md +22 -0
- package/docs/UpdateProductsRequest.md +20 -0
- package/docs/UpdateProductsRequestProductsInner.md +42 -0
- package/docs/UpdateProductsRequestProductsInnerIntegrationConnectionsInner.md +22 -0
- package/docs/UpdateProductsRequestProductsInnerSeoMetadata.md +22 -0
- package/docs/UpdateProductsRequestProductsInnerVariantsInner.md +30 -0
- package/docs/UpdateProductsRequestProductsInnerVariantsInnerAttributesInner.md +22 -0
- package/docs/UpdateProductsRequestProductsInnerVariantsInnerIntegrationConnectionsInner.md +22 -0
- package/docs/UpdateProductsRequestProductsInnerVariantsInnerRetailPrice.md +23 -0
- package/docs/UpdateProductsRequestProductsInnerVariantsInnerSalePrice.md +23 -0
- package/docs/Variant.md +58 -0
- package/docs/VariantIntegrationConnectionsInner.md +22 -0
- package/docs/VariantProduct.md +22 -0
- package/docs/VariantsApi.md +138 -0
- package/docs/VariantsResponse.md +22 -0
- package/docs/Video.md +31 -0
- package/docs/VideoFile.md +20 -0
- package/index.ts +1 -1
- package/package.json +1 -1
|
@@ -0,0 +1,317 @@
|
|
|
1
|
+
# ApplicationSetsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.podos.io*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**createApplicationSet**](#createapplicationset) | **POST** /v1/catalog/applications/sets | Create application set|
|
|
8
|
+
|[**deleteApplicationSet**](#deleteapplicationset) | **DELETE** /v1/catalog/applications/sets/{applicationSetId} | Delete an application set|
|
|
9
|
+
|[**getApplicationSet**](#getapplicationset) | **GET** /v1/catalog/applications/sets/{applicationSetId} | Get an application set|
|
|
10
|
+
|[**listApplicationSets**](#listapplicationsets) | **GET** /v1/catalog/applications/sets | List application sets|
|
|
11
|
+
|[**updateApplicationSet**](#updateapplicationset) | **PATCH** /v1/catalog/applications/sets/{applicationSetId} | Update application set|
|
|
12
|
+
|
|
13
|
+
# **createApplicationSet**
|
|
14
|
+
> ApplicationSet createApplicationSet()
|
|
15
|
+
|
|
16
|
+
Creates a new application set.
|
|
17
|
+
|
|
18
|
+
### Example
|
|
19
|
+
|
|
20
|
+
```typescript
|
|
21
|
+
import {
|
|
22
|
+
ApplicationSetsApi,
|
|
23
|
+
Configuration,
|
|
24
|
+
CreateApplicationSetRequest
|
|
25
|
+
} from '@teemill/product-catalog';
|
|
26
|
+
|
|
27
|
+
const configuration = new Configuration();
|
|
28
|
+
const apiInstance = new ApplicationSetsApi(configuration);
|
|
29
|
+
|
|
30
|
+
let project: string; //What project it is (default to undefined)
|
|
31
|
+
let createApplicationSetRequest: CreateApplicationSetRequest; //Create a new application set. (optional)
|
|
32
|
+
|
|
33
|
+
const { status, data } = await apiInstance.createApplicationSet(
|
|
34
|
+
project,
|
|
35
|
+
createApplicationSetRequest
|
|
36
|
+
);
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
### Parameters
|
|
40
|
+
|
|
41
|
+
|Name | Type | Description | Notes|
|
|
42
|
+
|------------- | ------------- | ------------- | -------------|
|
|
43
|
+
| **createApplicationSetRequest** | **CreateApplicationSetRequest**| Create a new application set. | |
|
|
44
|
+
| **project** | [**string**] | What project it is | defaults to undefined|
|
|
45
|
+
|
|
46
|
+
|
|
47
|
+
### Return type
|
|
48
|
+
|
|
49
|
+
**ApplicationSet**
|
|
50
|
+
|
|
51
|
+
### Authorization
|
|
52
|
+
|
|
53
|
+
[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
|
|
54
|
+
|
|
55
|
+
### HTTP request headers
|
|
56
|
+
|
|
57
|
+
- **Content-Type**: application/json
|
|
58
|
+
- **Accept**: application/json
|
|
59
|
+
|
|
60
|
+
|
|
61
|
+
### HTTP response details
|
|
62
|
+
| Status code | Description | Response headers |
|
|
63
|
+
|-------------|-------------|------------------|
|
|
64
|
+
|**201** | Successfully retrieved an application set. | - |
|
|
65
|
+
|**400** | Failed validation. | - |
|
|
66
|
+
|**401** | Not authorised to access this resource. | - |
|
|
67
|
+
|**403** | Refuse to authorize. | - |
|
|
68
|
+
|**404** | Resource not found. | - |
|
|
69
|
+
|**500** | Unknown server error. | - |
|
|
70
|
+
|
|
71
|
+
[[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)
|
|
72
|
+
|
|
73
|
+
# **deleteApplicationSet**
|
|
74
|
+
> deleteApplicationSet()
|
|
75
|
+
|
|
76
|
+
Deletes an existing application set.
|
|
77
|
+
|
|
78
|
+
### Example
|
|
79
|
+
|
|
80
|
+
```typescript
|
|
81
|
+
import {
|
|
82
|
+
ApplicationSetsApi,
|
|
83
|
+
Configuration
|
|
84
|
+
} from '@teemill/product-catalog';
|
|
85
|
+
|
|
86
|
+
const configuration = new Configuration();
|
|
87
|
+
const apiInstance = new ApplicationSetsApi(configuration);
|
|
88
|
+
|
|
89
|
+
let project: string; //What project it is (default to undefined)
|
|
90
|
+
let applicationSetId: string; //Application set\'s unique identifier (default to undefined)
|
|
91
|
+
|
|
92
|
+
const { status, data } = await apiInstance.deleteApplicationSet(
|
|
93
|
+
project,
|
|
94
|
+
applicationSetId
|
|
95
|
+
);
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
### Parameters
|
|
99
|
+
|
|
100
|
+
|Name | Type | Description | Notes|
|
|
101
|
+
|------------- | ------------- | ------------- | -------------|
|
|
102
|
+
| **project** | [**string**] | What project it is | defaults to undefined|
|
|
103
|
+
| **applicationSetId** | [**string**] | Application set\'s unique identifier | defaults to undefined|
|
|
104
|
+
|
|
105
|
+
|
|
106
|
+
### Return type
|
|
107
|
+
|
|
108
|
+
void (empty response body)
|
|
109
|
+
|
|
110
|
+
### Authorization
|
|
111
|
+
|
|
112
|
+
[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
|
|
113
|
+
|
|
114
|
+
### HTTP request headers
|
|
115
|
+
|
|
116
|
+
- **Content-Type**: Not defined
|
|
117
|
+
- **Accept**: application/json
|
|
118
|
+
|
|
119
|
+
|
|
120
|
+
### HTTP response details
|
|
121
|
+
| Status code | Description | Response headers |
|
|
122
|
+
|-------------|-------------|------------------|
|
|
123
|
+
|**204** | Set deleted | - |
|
|
124
|
+
|**400** | Failed validation. | - |
|
|
125
|
+
|**401** | Not authorised to access this resource. | - |
|
|
126
|
+
|**403** | Refuse to authorize. | - |
|
|
127
|
+
|**404** | Resource not found. | - |
|
|
128
|
+
|**500** | Unknown server error. | - |
|
|
129
|
+
|
|
130
|
+
[[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)
|
|
131
|
+
|
|
132
|
+
# **getApplicationSet**
|
|
133
|
+
> ApplicationSet getApplicationSet()
|
|
134
|
+
|
|
135
|
+
Get an application by the given id.
|
|
136
|
+
|
|
137
|
+
### Example
|
|
138
|
+
|
|
139
|
+
```typescript
|
|
140
|
+
import {
|
|
141
|
+
ApplicationSetsApi,
|
|
142
|
+
Configuration
|
|
143
|
+
} from '@teemill/product-catalog';
|
|
144
|
+
|
|
145
|
+
const configuration = new Configuration();
|
|
146
|
+
const apiInstance = new ApplicationSetsApi(configuration);
|
|
147
|
+
|
|
148
|
+
let project: string; //What project it is (default to undefined)
|
|
149
|
+
let applicationSetId: string; //Application set\'s unique identifier (default to undefined)
|
|
150
|
+
|
|
151
|
+
const { status, data } = await apiInstance.getApplicationSet(
|
|
152
|
+
project,
|
|
153
|
+
applicationSetId
|
|
154
|
+
);
|
|
155
|
+
```
|
|
156
|
+
|
|
157
|
+
### Parameters
|
|
158
|
+
|
|
159
|
+
|Name | Type | Description | Notes|
|
|
160
|
+
|------------- | ------------- | ------------- | -------------|
|
|
161
|
+
| **project** | [**string**] | What project it is | defaults to undefined|
|
|
162
|
+
| **applicationSetId** | [**string**] | Application set\'s unique identifier | defaults to undefined|
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
### Return type
|
|
166
|
+
|
|
167
|
+
**ApplicationSet**
|
|
168
|
+
|
|
169
|
+
### Authorization
|
|
170
|
+
|
|
171
|
+
[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
|
|
172
|
+
|
|
173
|
+
### HTTP request headers
|
|
174
|
+
|
|
175
|
+
- **Content-Type**: Not defined
|
|
176
|
+
- **Accept**: application/json
|
|
177
|
+
|
|
178
|
+
|
|
179
|
+
### HTTP response details
|
|
180
|
+
| Status code | Description | Response headers |
|
|
181
|
+
|-------------|-------------|------------------|
|
|
182
|
+
|**200** | Successfully retrieved an application set. | - |
|
|
183
|
+
|**400** | Failed validation. | - |
|
|
184
|
+
|**401** | Not authorised to access this resource. | - |
|
|
185
|
+
|**403** | Refuse to authorize. | - |
|
|
186
|
+
|**404** | Resource not found. | - |
|
|
187
|
+
|**500** | Unknown server error. | - |
|
|
188
|
+
|
|
189
|
+
[[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)
|
|
190
|
+
|
|
191
|
+
# **listApplicationSets**
|
|
192
|
+
> ApplicationSetsResponse listApplicationSets()
|
|
193
|
+
|
|
194
|
+
Lists all application sets that belong to the given project.
|
|
195
|
+
|
|
196
|
+
### Example
|
|
197
|
+
|
|
198
|
+
```typescript
|
|
199
|
+
import {
|
|
200
|
+
ApplicationSetsApi,
|
|
201
|
+
Configuration
|
|
202
|
+
} from '@teemill/product-catalog';
|
|
203
|
+
|
|
204
|
+
const configuration = new Configuration();
|
|
205
|
+
const apiInstance = new ApplicationSetsApi(configuration);
|
|
206
|
+
|
|
207
|
+
let project: string; //What project it is (default to undefined)
|
|
208
|
+
let pageToken: number; //Page reference token (optional) (default to 1)
|
|
209
|
+
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')
|
|
210
|
+
let pageSize: number; //Max page size. This is the maximum page size that will be returned, but it might be smaller. (optional) (default to 10)
|
|
211
|
+
|
|
212
|
+
const { status, data } = await apiInstance.listApplicationSets(
|
|
213
|
+
project,
|
|
214
|
+
pageToken,
|
|
215
|
+
search,
|
|
216
|
+
pageSize
|
|
217
|
+
);
|
|
218
|
+
```
|
|
219
|
+
|
|
220
|
+
### Parameters
|
|
221
|
+
|
|
222
|
+
|Name | Type | Description | Notes|
|
|
223
|
+
|------------- | ------------- | ------------- | -------------|
|
|
224
|
+
| **project** | [**string**] | What project it is | defaults to undefined|
|
|
225
|
+
| **pageToken** | [**number**] | Page reference token | (optional) defaults to 1|
|
|
226
|
+
| **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) defaults to 'enabled:true'|
|
|
227
|
+
| **pageSize** | [**number**] | Max page size. This is the maximum page size that will be returned, but it might be smaller. | (optional) defaults to 10|
|
|
228
|
+
|
|
229
|
+
|
|
230
|
+
### Return type
|
|
231
|
+
|
|
232
|
+
**ApplicationSetsResponse**
|
|
233
|
+
|
|
234
|
+
### Authorization
|
|
235
|
+
|
|
236
|
+
[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
|
|
237
|
+
|
|
238
|
+
### HTTP request headers
|
|
239
|
+
|
|
240
|
+
- **Content-Type**: Not defined
|
|
241
|
+
- **Accept**: application/json
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
### HTTP response details
|
|
245
|
+
| Status code | Description | Response headers |
|
|
246
|
+
|-------------|-------------|------------------|
|
|
247
|
+
|**200** | Successfully retrieved all application sets. | - |
|
|
248
|
+
|**400** | Failed validation. | - |
|
|
249
|
+
|**401** | Not authorised to access this resource. | - |
|
|
250
|
+
|**403** | Refuse to authorize. | - |
|
|
251
|
+
|**500** | Unknown server error. | - |
|
|
252
|
+
|
|
253
|
+
[[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)
|
|
254
|
+
|
|
255
|
+
# **updateApplicationSet**
|
|
256
|
+
> ApplicationSet updateApplicationSet()
|
|
257
|
+
|
|
258
|
+
Updates an existing application set.
|
|
259
|
+
|
|
260
|
+
### Example
|
|
261
|
+
|
|
262
|
+
```typescript
|
|
263
|
+
import {
|
|
264
|
+
ApplicationSetsApi,
|
|
265
|
+
Configuration,
|
|
266
|
+
UpdateApplicationSetRequest
|
|
267
|
+
} from '@teemill/product-catalog';
|
|
268
|
+
|
|
269
|
+
const configuration = new Configuration();
|
|
270
|
+
const apiInstance = new ApplicationSetsApi(configuration);
|
|
271
|
+
|
|
272
|
+
let project: string; //What project it is (default to undefined)
|
|
273
|
+
let applicationSetId: string; //Application set\'s unique identifier (default to undefined)
|
|
274
|
+
let updateApplicationSetRequest: UpdateApplicationSetRequest; //Create a new application set. (optional)
|
|
275
|
+
|
|
276
|
+
const { status, data } = await apiInstance.updateApplicationSet(
|
|
277
|
+
project,
|
|
278
|
+
applicationSetId,
|
|
279
|
+
updateApplicationSetRequest
|
|
280
|
+
);
|
|
281
|
+
```
|
|
282
|
+
|
|
283
|
+
### Parameters
|
|
284
|
+
|
|
285
|
+
|Name | Type | Description | Notes|
|
|
286
|
+
|------------- | ------------- | ------------- | -------------|
|
|
287
|
+
| **updateApplicationSetRequest** | **UpdateApplicationSetRequest**| Create a new application set. | |
|
|
288
|
+
| **project** | [**string**] | What project it is | defaults to undefined|
|
|
289
|
+
| **applicationSetId** | [**string**] | Application set\'s unique identifier | defaults to undefined|
|
|
290
|
+
|
|
291
|
+
|
|
292
|
+
### Return type
|
|
293
|
+
|
|
294
|
+
**ApplicationSet**
|
|
295
|
+
|
|
296
|
+
### Authorization
|
|
297
|
+
|
|
298
|
+
[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
|
|
299
|
+
|
|
300
|
+
### HTTP request headers
|
|
301
|
+
|
|
302
|
+
- **Content-Type**: application/json
|
|
303
|
+
- **Accept**: application/json
|
|
304
|
+
|
|
305
|
+
|
|
306
|
+
### HTTP response details
|
|
307
|
+
| Status code | Description | Response headers |
|
|
308
|
+
|-------------|-------------|------------------|
|
|
309
|
+
|**201** | Successfully retrieved an application set. | - |
|
|
310
|
+
|**400** | Failed validation. | - |
|
|
311
|
+
|**401** | Not authorised to access this resource. | - |
|
|
312
|
+
|**403** | Refuse to authorize. | - |
|
|
313
|
+
|**404** | Resource not found. | - |
|
|
314
|
+
|**500** | Unknown server error. | - |
|
|
315
|
+
|
|
316
|
+
[[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)
|
|
317
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# ApplicationSetsResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**applicationSets** | [**Array<ApplicationSet>**](ApplicationSet.md) | | [optional] [default to undefined]
|
|
9
|
+
**nextPageToken** | **number** | The token referencing the next page number | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { ApplicationSetsResponse } from '@teemill/product-catalog';
|
|
15
|
+
|
|
16
|
+
const instance: ApplicationSetsResponse = {
|
|
17
|
+
applicationSets,
|
|
18
|
+
nextPageToken,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# Attribute
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**name** | **string** | Attribute name | [default to undefined]
|
|
9
|
+
**value** | **string** | Attribute value | [default to undefined]
|
|
10
|
+
**thumbnail** | [**AttributeThumbnail**](AttributeThumbnail.md) | | [optional] [default to undefined]
|
|
11
|
+
**tags** | **Array<string>** | Attribute tags | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { Attribute } from '@teemill/product-catalog';
|
|
17
|
+
|
|
18
|
+
const instance: Attribute = {
|
|
19
|
+
name,
|
|
20
|
+
value,
|
|
21
|
+
thumbnail,
|
|
22
|
+
tags,
|
|
23
|
+
};
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# AttributeThumbnail
|
|
2
|
+
|
|
3
|
+
Attribute thumbnail, intended for interfaces like storefront colour selector.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**type** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**value** | **string** | | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { AttributeThumbnail } from '@teemill/product-catalog';
|
|
16
|
+
|
|
17
|
+
const instance: AttributeThumbnail = {
|
|
18
|
+
type,
|
|
19
|
+
value,
|
|
20
|
+
};
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Attributes1Inner
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**name** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**value** | **string** | | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { Attributes1Inner } from '@teemill/product-catalog';
|
|
15
|
+
|
|
16
|
+
const instance: Attributes1Inner = {
|
|
17
|
+
name,
|
|
18
|
+
value,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# CreateApplication
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**technology** | **string** | Technology to use for the application. | [default to undefined]
|
|
9
|
+
**placement** | **string** | Placement of the application. Available placements depend on the chosen product and technology. | [default to undefined]
|
|
10
|
+
**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. Accepts PNG and JPEG files. | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { CreateApplication } from '@teemill/product-catalog';
|
|
16
|
+
|
|
17
|
+
const instance: CreateApplication = {
|
|
18
|
+
technology,
|
|
19
|
+
placement,
|
|
20
|
+
src,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# CreateApplicationSetRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**name** | **string** | Name of the application set | [default to undefined]
|
|
9
|
+
**description** | **string** | Description of the application set | [optional] [default to undefined]
|
|
10
|
+
**width** | **number** | The width, in pixels of the images in the set | [default to undefined]
|
|
11
|
+
**height** | **number** | The height, in pixels of the images in the set | [default to undefined]
|
|
12
|
+
**dpi** | **number** | The DPI used when printing the images in the set | [default to undefined]
|
|
13
|
+
**records** | [**Array<CreateApplicationSetRequestRecordsInner>**](CreateApplicationSetRequestRecordsInner.md) | List of application set records | [default to undefined]
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import { CreateApplicationSetRequest } from '@teemill/product-catalog';
|
|
19
|
+
|
|
20
|
+
const instance: CreateApplicationSetRequest = {
|
|
21
|
+
name,
|
|
22
|
+
description,
|
|
23
|
+
width,
|
|
24
|
+
height,
|
|
25
|
+
dpi,
|
|
26
|
+
records,
|
|
27
|
+
};
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# CreateApplicationSetRequestRecordsInner
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**attributes** | [**Array<CreateApplicationSetRequestRecordsInnerAttributesInner>**](CreateApplicationSetRequestRecordsInnerAttributesInner.md) | List of attributes this record applies to. Providing an empty array will apply the application set to all variants. | [optional] [default to undefined]
|
|
9
|
+
**applications** | [**Array<CreateApplication>**](CreateApplication.md) | List of applications for this record | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { CreateApplicationSetRequestRecordsInner } from '@teemill/product-catalog';
|
|
15
|
+
|
|
16
|
+
const instance: CreateApplicationSetRequestRecordsInner = {
|
|
17
|
+
attributes,
|
|
18
|
+
applications,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# CreateApplicationSetRequestRecordsInnerAttributesInner
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**name** | **string** | The name of the option type. e.g. Size, Colour | [default to undefined]
|
|
9
|
+
**value** | **string** | The value of the option this record applies to | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { CreateApplicationSetRequestRecordsInnerAttributesInner } from '@teemill/product-catalog';
|
|
15
|
+
|
|
16
|
+
const instance: CreateApplicationSetRequestRecordsInnerAttributesInner = {
|
|
17
|
+
name,
|
|
18
|
+
value,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
# CreateBundleProduct
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**title** | **string** | Product title | [optional] [default to undefined]
|
|
9
|
+
**description** | **string** | Product description | [optional] [default to undefined]
|
|
10
|
+
**enabled** | **boolean** | Whether the product is enabled upon creation. | [optional] [default to undefined]
|
|
11
|
+
**slug** | **string** | A custom URL slug for the product. This must be unique for each product on the project. | [optional] [default to undefined]
|
|
12
|
+
**seoMetadata** | [**UpdateProductsRequestProductsInnerSeoMetadata**](UpdateProductsRequestProductsInnerSeoMetadata.md) | | [optional] [default to undefined]
|
|
13
|
+
**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]
|
|
14
|
+
**targetSearchPhraseSynonyms** | **Array<string>** | Synonyms for the target search phrase. **Note:** This field requires the website integration | [optional] [default to undefined]
|
|
15
|
+
**tags** | **Array<string>** | Additional product tags used for searching and filtering. | [optional] [default to undefined]
|
|
16
|
+
**internalTags** | **Array<string>** | Internal tags used for internal searching and filtering. | [optional] [default to undefined]
|
|
17
|
+
**images** | [**Array<CreateProductImagesInner>**](CreateProductImagesInner.md) | Images to attach to the product. For example, photos of models using/wearing the product. | [optional] [default to undefined]
|
|
18
|
+
**videos** | [**Array<CreateProductVideosInner>**](CreateProductVideosInner.md) | Videos to attach to the product. | [optional] [default to undefined]
|
|
19
|
+
**additionalFiles** | [**Array<CreateProductAdditionalFilesInner>**](CreateProductAdditionalFilesInner.md) | Additional files to attach to the product. For example, original design files e.g. PSD, AI, etc. | [optional] [default to undefined]
|
|
20
|
+
**shopifyId** | **number** | For use with the Shopify integration. Use this to provide a Shopify product ID to link to an existing Shopify product rather than creating a new one. | [optional] [default to undefined]
|
|
21
|
+
**metafields** | [**Array<MetaField>**](MetaField.md) | Key/value pairs that can be used to store additional information about the product | [optional] [default to undefined]
|
|
22
|
+
**bundleItems** | **Array<string>** | A list of product uuids to include in this bundle | [default to undefined]
|
|
23
|
+
**retailPrice** | [**Price**](Price.md) | | [optional] [default to undefined]
|
|
24
|
+
**salePrice** | [**Price**](Price.md) | | [optional] [default to undefined]
|
|
25
|
+
**price** | [**Price**](Price.md) | | [optional] [readonly] [default to undefined]
|
|
26
|
+
|
|
27
|
+
## Example
|
|
28
|
+
|
|
29
|
+
```typescript
|
|
30
|
+
import { CreateBundleProduct } from '@teemill/product-catalog';
|
|
31
|
+
|
|
32
|
+
const instance: CreateBundleProduct = {
|
|
33
|
+
title,
|
|
34
|
+
description,
|
|
35
|
+
enabled,
|
|
36
|
+
slug,
|
|
37
|
+
seoMetadata,
|
|
38
|
+
targetSearchPhrase,
|
|
39
|
+
targetSearchPhraseSynonyms,
|
|
40
|
+
tags,
|
|
41
|
+
internalTags,
|
|
42
|
+
images,
|
|
43
|
+
videos,
|
|
44
|
+
additionalFiles,
|
|
45
|
+
shopifyId,
|
|
46
|
+
metafields,
|
|
47
|
+
bundleItems,
|
|
48
|
+
retailPrice,
|
|
49
|
+
salePrice,
|
|
50
|
+
price,
|
|
51
|
+
};
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
# CreateProduct
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**gfnProductRef** | **string** | Reference to the product in the GFN catalog that will be used as a base for this product. A list of available products for the given project can be obtained from the GFN Catalog API. | [default to undefined]
|
|
9
|
+
**title** | **string** | Product title | [optional] [default to undefined]
|
|
10
|
+
**description** | **string** | Product description | [optional] [default to undefined]
|
|
11
|
+
**enabled** | **boolean** | Whether the product is enabled upon creation. | [optional] [default to undefined]
|
|
12
|
+
**slug** | **string** | A custom URL slug for the product. This must be unique for each product on the project. | [optional] [default to undefined]
|
|
13
|
+
**seoMetadata** | [**UpdateProductsRequestProductsInnerSeoMetadata**](UpdateProductsRequestProductsInnerSeoMetadata.md) | | [optional] [default to undefined]
|
|
14
|
+
**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]
|
|
15
|
+
**targetSearchPhraseSynonyms** | **Array<string>** | Synonyms for the target search phrase. **Note:** This field requires the website integration | [optional] [default to undefined]
|
|
16
|
+
**tags** | **Array<string>** | Additional product tags used for searching and filtering. | [optional] [default to undefined]
|
|
17
|
+
**internalTags** | **Array<string>** | Internal tags used for internal searching and filtering. | [optional] [default to undefined]
|
|
18
|
+
**variants** | [**Array<CreateProductVariant>**](CreateProductVariant.md) | Variants | [default to undefined]
|
|
19
|
+
**images** | [**Array<CreateProductImagesInner>**](CreateProductImagesInner.md) | Images to attach to the product. For example, photos of models using/wearing the product. | [optional] [default to undefined]
|
|
20
|
+
**videos** | [**Array<CreateProductVideosInner>**](CreateProductVideosInner.md) | Videos to attach to the product. | [optional] [default to undefined]
|
|
21
|
+
**additionalFiles** | [**Array<CreateProductAdditionalFilesInner>**](CreateProductAdditionalFilesInner.md) | Additional files to attach to the product. For example, original design files e.g. PSD, AI, etc. | [optional] [default to undefined]
|
|
22
|
+
**applicationSets** | **Array<string>** | List of application set UUIDs to associate with this product | [optional] [default to undefined]
|
|
23
|
+
**includeInDataFeeds** | **boolean** | Whether the product should be included in data feeds that can be provided to Google, Meta etc for advertising. | [optional] [default to true]
|
|
24
|
+
**shopifyId** | **number** | For use with the Shopify integration. Use this to provide a Shopify product ID to link to an existing Shopify product rather than creating a new one. | [optional] [default to undefined]
|
|
25
|
+
**metafields** | [**Array<MetaField>**](MetaField.md) | Key/value pairs that can be used to store additional information about the product | [optional] [default to undefined]
|
|
26
|
+
**personalizationTemplate** | **string** | A JSON object that defines the personalization template for the product. | [optional] [default to undefined]
|
|
27
|
+
|
|
28
|
+
## Example
|
|
29
|
+
|
|
30
|
+
```typescript
|
|
31
|
+
import { CreateProduct } from '@teemill/product-catalog';
|
|
32
|
+
|
|
33
|
+
const instance: CreateProduct = {
|
|
34
|
+
gfnProductRef,
|
|
35
|
+
title,
|
|
36
|
+
description,
|
|
37
|
+
enabled,
|
|
38
|
+
slug,
|
|
39
|
+
seoMetadata,
|
|
40
|
+
targetSearchPhrase,
|
|
41
|
+
targetSearchPhraseSynonyms,
|
|
42
|
+
tags,
|
|
43
|
+
internalTags,
|
|
44
|
+
variants,
|
|
45
|
+
images,
|
|
46
|
+
videos,
|
|
47
|
+
additionalFiles,
|
|
48
|
+
applicationSets,
|
|
49
|
+
includeInDataFeeds,
|
|
50
|
+
shopifyId,
|
|
51
|
+
metafields,
|
|
52
|
+
personalizationTemplate,
|
|
53
|
+
};
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# CreateProductAdditionalFilesInner
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**src** | **string** | Publicly available file URL. | [optional] [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { CreateProductAdditionalFilesInner } from '@teemill/product-catalog';
|
|
14
|
+
|
|
15
|
+
const instance: CreateProductAdditionalFilesInner = {
|
|
16
|
+
src,
|
|
17
|
+
};
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# CreateProductImagesInner
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**src** | **string** | Publicly available file URL. | [optional] [default to undefined]
|
|
9
|
+
**type** | **string** | Image type. | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { CreateProductImagesInner } from '@teemill/product-catalog';
|
|
15
|
+
|
|
16
|
+
const instance: CreateProductImagesInner = {
|
|
17
|
+
src,
|
|
18
|
+
type,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|