@teemill/website 0.28.0 → 0.30.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 +4 -2
- package/api.ts +190 -55
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +83 -1
- package/dist/api.js +156 -3
- 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 +83 -1
- package/dist/esm/api.js +150 -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/CollectionsApi.md +13 -450
- package/docs/MenuItem.md +2 -0
- package/docs/SubmenuInner.md +2 -0
- package/docs/SubmenuItem.md +2 -0
- package/docs/UpdateMenuRequestItem.md +2 -0
- package/docs/UpdateMenuRequestItemSubmenuInner.md +2 -0
- package/docs/UpdateMenuRequestSubmenuItem.md +2 -0
- package/docs/UpdateProductCollectionsRequest.md +20 -0
- package/index.ts +1 -1
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
package/dist/index.js
CHANGED
package/docs/CollectionsApi.md
CHANGED
|
@@ -4,19 +4,11 @@ All URIs are relative to *https://api.localhost:8080*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**
|
|
8
|
-
|[**deleteCollection**](#deletecollection) | **DELETE** /v1/website/collections/{collectionId} | Delete website collection|
|
|
9
|
-
|[**exportCollections**](#exportcollections) | **GET** /v1/website/collections/export | Export collections|
|
|
10
|
-
|[**getCollection**](#getcollection) | **GET** /v1/website/collections/{collectionId} | Get website collection|
|
|
11
|
-
|[**listCollections**](#listcollections) | **GET** /v1/website/collections | List website collections|
|
|
12
|
-
|[**seoOptimiseCollections**](#seooptimisecollections) | **POST** /v1/website/collections/ai-seo-optimise | AI SEO optimise collections|
|
|
13
|
-
|[**updateCollection**](#updatecollection) | **PATCH** /v1/website/collections/{collectionId} | Update website collection|
|
|
14
|
-
|[**updateCollections**](#updatecollections) | **PATCH** /v1/website/collections | Update website collections|
|
|
7
|
+
|[**updateProductCollections**](#updateproductcollections) | **PATCH** /v1/website/products/{productId}/collections | Update product collections|
|
|
15
8
|
|
|
16
|
-
# **
|
|
17
|
-
>
|
|
9
|
+
# **updateProductCollections**
|
|
10
|
+
> updateProductCollections()
|
|
18
11
|
|
|
19
|
-
Create a new website collection.
|
|
20
12
|
|
|
21
13
|
### Example
|
|
22
14
|
|
|
@@ -24,24 +16,20 @@ Create a new website collection.
|
|
|
24
16
|
import {
|
|
25
17
|
CollectionsApi,
|
|
26
18
|
Configuration,
|
|
27
|
-
|
|
19
|
+
UpdateProductCollectionsRequest
|
|
28
20
|
} from '@teemill/website';
|
|
29
21
|
|
|
30
22
|
const configuration = new Configuration();
|
|
31
23
|
const apiInstance = new CollectionsApi(configuration);
|
|
32
24
|
|
|
33
25
|
let project: string; //What project it is (default to undefined)
|
|
34
|
-
let
|
|
35
|
-
let
|
|
36
|
-
let search: string; //Search term to filter results (optional) (default to undefined)
|
|
37
|
-
let createCollectionRequest: CreateCollectionRequest; //Create a new collection (optional)
|
|
26
|
+
let productId: string; //Product\'s unique identifier (default to undefined)
|
|
27
|
+
let updateProductCollectionsRequest: UpdateProductCollectionsRequest; // (optional)
|
|
38
28
|
|
|
39
|
-
const { status, data } = await apiInstance.
|
|
29
|
+
const { status, data } = await apiInstance.updateProductCollections(
|
|
40
30
|
project,
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
search,
|
|
44
|
-
createCollectionRequest
|
|
31
|
+
productId,
|
|
32
|
+
updateProductCollectionsRequest
|
|
45
33
|
);
|
|
46
34
|
```
|
|
47
35
|
|
|
@@ -49,68 +37,9 @@ const { status, data } = await apiInstance.createCollection(
|
|
|
49
37
|
|
|
50
38
|
|Name | Type | Description | Notes|
|
|
51
39
|
|------------- | ------------- | ------------- | -------------|
|
|
52
|
-
| **
|
|
40
|
+
| **updateProductCollectionsRequest** | **UpdateProductCollectionsRequest**| | |
|
|
53
41
|
| **project** | [**string**] | What project it is | defaults to undefined|
|
|
54
|
-
| **
|
|
55
|
-
| **pageSize** | [**number**] | Max page size. This is the maximum page size that will be returned, but it might be smaller. | (optional) defaults to 100|
|
|
56
|
-
| **search** | [**string**] | Search term to filter results | (optional) defaults to undefined|
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
### Return type
|
|
60
|
-
|
|
61
|
-
**Collection**
|
|
62
|
-
|
|
63
|
-
### Authorization
|
|
64
|
-
|
|
65
|
-
[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
|
|
66
|
-
|
|
67
|
-
### HTTP request headers
|
|
68
|
-
|
|
69
|
-
- **Content-Type**: application/json
|
|
70
|
-
- **Accept**: application/json
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
### HTTP response details
|
|
74
|
-
| Status code | Description | Response headers |
|
|
75
|
-
|-------------|-------------|------------------|
|
|
76
|
-
|**201** | Successfully retrieved a website collection. | - |
|
|
77
|
-
|**400** | Failed validation | - |
|
|
78
|
-
|**401** | Not authorised to access this resource | - |
|
|
79
|
-
|**403** | Refuse to authorize | - |
|
|
80
|
-
|**500** | Unknown server error | - |
|
|
81
|
-
|
|
82
|
-
[[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)
|
|
83
|
-
|
|
84
|
-
# **deleteCollection**
|
|
85
|
-
> deleteCollection()
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
### Example
|
|
89
|
-
|
|
90
|
-
```typescript
|
|
91
|
-
import {
|
|
92
|
-
CollectionsApi,
|
|
93
|
-
Configuration
|
|
94
|
-
} from '@teemill/website';
|
|
95
|
-
|
|
96
|
-
const configuration = new Configuration();
|
|
97
|
-
const apiInstance = new CollectionsApi(configuration);
|
|
98
|
-
|
|
99
|
-
let project: string; //What project it is (default to undefined)
|
|
100
|
-
let collectionId: string; //Collection\'s unique identifier (default to undefined)
|
|
101
|
-
|
|
102
|
-
const { status, data } = await apiInstance.deleteCollection(
|
|
103
|
-
project,
|
|
104
|
-
collectionId
|
|
105
|
-
);
|
|
106
|
-
```
|
|
107
|
-
|
|
108
|
-
### Parameters
|
|
109
|
-
|
|
110
|
-
|Name | Type | Description | Notes|
|
|
111
|
-
|------------- | ------------- | ------------- | -------------|
|
|
112
|
-
| **project** | [**string**] | What project it is | defaults to undefined|
|
|
113
|
-
| **collectionId** | [**string**] | Collection\'s unique identifier | defaults to undefined|
|
|
42
|
+
| **productId** | [**string**] | Product\'s unique identifier | defaults to undefined|
|
|
114
43
|
|
|
115
44
|
|
|
116
45
|
### Return type
|
|
@@ -121,371 +50,6 @@ void (empty response body)
|
|
|
121
50
|
|
|
122
51
|
[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
|
|
123
52
|
|
|
124
|
-
### HTTP request headers
|
|
125
|
-
|
|
126
|
-
- **Content-Type**: Not defined
|
|
127
|
-
- **Accept**: application/json
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
### HTTP response details
|
|
131
|
-
| Status code | Description | Response headers |
|
|
132
|
-
|-------------|-------------|------------------|
|
|
133
|
-
|**204** | Collection deleted | - |
|
|
134
|
-
|**401** | Not authorised to access this resource | - |
|
|
135
|
-
|**403** | Refuse to authorize | - |
|
|
136
|
-
|**404** | Resource not found | - |
|
|
137
|
-
|**500** | Unknown server error | - |
|
|
138
|
-
|
|
139
|
-
[[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)
|
|
140
|
-
|
|
141
|
-
# **exportCollections**
|
|
142
|
-
> File exportCollections()
|
|
143
|
-
|
|
144
|
-
Export collections as a CSV file.
|
|
145
|
-
|
|
146
|
-
### Example
|
|
147
|
-
|
|
148
|
-
```typescript
|
|
149
|
-
import {
|
|
150
|
-
CollectionsApi,
|
|
151
|
-
Configuration
|
|
152
|
-
} from '@teemill/website';
|
|
153
|
-
|
|
154
|
-
const configuration = new Configuration();
|
|
155
|
-
const apiInstance = new CollectionsApi(configuration);
|
|
156
|
-
|
|
157
|
-
let project: string; //What project it is (default to undefined)
|
|
158
|
-
|
|
159
|
-
const { status, data } = await apiInstance.exportCollections(
|
|
160
|
-
project
|
|
161
|
-
);
|
|
162
|
-
```
|
|
163
|
-
|
|
164
|
-
### Parameters
|
|
165
|
-
|
|
166
|
-
|Name | Type | Description | Notes|
|
|
167
|
-
|------------- | ------------- | ------------- | -------------|
|
|
168
|
-
| **project** | [**string**] | What project it is | defaults to undefined|
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
### Return type
|
|
172
|
-
|
|
173
|
-
**File**
|
|
174
|
-
|
|
175
|
-
### Authorization
|
|
176
|
-
|
|
177
|
-
[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
|
|
178
|
-
|
|
179
|
-
### HTTP request headers
|
|
180
|
-
|
|
181
|
-
- **Content-Type**: Not defined
|
|
182
|
-
- **Accept**: text/csv; charset=utf-8, application/json
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
### HTTP response details
|
|
186
|
-
| Status code | Description | Response headers |
|
|
187
|
-
|-------------|-------------|------------------|
|
|
188
|
-
|**200** | Returns the CSV export | - |
|
|
189
|
-
|**202** | Export started. When complete, the export will be available for download from a notification within PodOS Dashboard. | - |
|
|
190
|
-
|**400** | Failed validation | - |
|
|
191
|
-
|**401** | Not authorised to access this resource | - |
|
|
192
|
-
|**403** | Refuse to authorize | - |
|
|
193
|
-
|**500** | Unknown server error | - |
|
|
194
|
-
|
|
195
|
-
[[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)
|
|
196
|
-
|
|
197
|
-
# **getCollection**
|
|
198
|
-
> Collection getCollection()
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
### Example
|
|
202
|
-
|
|
203
|
-
```typescript
|
|
204
|
-
import {
|
|
205
|
-
CollectionsApi,
|
|
206
|
-
Configuration
|
|
207
|
-
} from '@teemill/website';
|
|
208
|
-
|
|
209
|
-
const configuration = new Configuration();
|
|
210
|
-
const apiInstance = new CollectionsApi(configuration);
|
|
211
|
-
|
|
212
|
-
let project: string; //What project it is (default to undefined)
|
|
213
|
-
let collectionId: string; //Collection\'s unique identifier (default to undefined)
|
|
214
|
-
|
|
215
|
-
const { status, data } = await apiInstance.getCollection(
|
|
216
|
-
project,
|
|
217
|
-
collectionId
|
|
218
|
-
);
|
|
219
|
-
```
|
|
220
|
-
|
|
221
|
-
### Parameters
|
|
222
|
-
|
|
223
|
-
|Name | Type | Description | Notes|
|
|
224
|
-
|------------- | ------------- | ------------- | -------------|
|
|
225
|
-
| **project** | [**string**] | What project it is | defaults to undefined|
|
|
226
|
-
| **collectionId** | [**string**] | Collection\'s unique identifier | defaults to undefined|
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
### Return type
|
|
230
|
-
|
|
231
|
-
**Collection**
|
|
232
|
-
|
|
233
|
-
### Authorization
|
|
234
|
-
|
|
235
|
-
[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
|
|
236
|
-
|
|
237
|
-
### HTTP request headers
|
|
238
|
-
|
|
239
|
-
- **Content-Type**: Not defined
|
|
240
|
-
- **Accept**: application/json
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
### HTTP response details
|
|
244
|
-
| Status code | Description | Response headers |
|
|
245
|
-
|-------------|-------------|------------------|
|
|
246
|
-
|**200** | Successfully retrieved a website collection. | - |
|
|
247
|
-
|**401** | Not authorised to access this resource | - |
|
|
248
|
-
|**403** | Refuse to authorize | - |
|
|
249
|
-
|**404** | Resource not found | - |
|
|
250
|
-
|**500** | Unknown server error | - |
|
|
251
|
-
|
|
252
|
-
[[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)
|
|
253
|
-
|
|
254
|
-
# **listCollections**
|
|
255
|
-
> CollectionsResponse listCollections()
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
### Example
|
|
259
|
-
|
|
260
|
-
```typescript
|
|
261
|
-
import {
|
|
262
|
-
CollectionsApi,
|
|
263
|
-
Configuration
|
|
264
|
-
} from '@teemill/website';
|
|
265
|
-
|
|
266
|
-
const configuration = new Configuration();
|
|
267
|
-
const apiInstance = new CollectionsApi(configuration);
|
|
268
|
-
|
|
269
|
-
let project: string; //What project it is (default to undefined)
|
|
270
|
-
let pageToken: number; //Page reference token (optional) (default to 1)
|
|
271
|
-
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)
|
|
272
|
-
let search: string; //Search term to filter results (optional) (default to undefined)
|
|
273
|
-
|
|
274
|
-
const { status, data } = await apiInstance.listCollections(
|
|
275
|
-
project,
|
|
276
|
-
pageToken,
|
|
277
|
-
pageSize,
|
|
278
|
-
search
|
|
279
|
-
);
|
|
280
|
-
```
|
|
281
|
-
|
|
282
|
-
### Parameters
|
|
283
|
-
|
|
284
|
-
|Name | Type | Description | Notes|
|
|
285
|
-
|------------- | ------------- | ------------- | -------------|
|
|
286
|
-
| **project** | [**string**] | What project it is | defaults to undefined|
|
|
287
|
-
| **pageToken** | [**number**] | Page reference token | (optional) defaults to 1|
|
|
288
|
-
| **pageSize** | [**number**] | Max page size. This is the maximum page size that will be returned, but it might be smaller. | (optional) defaults to 100|
|
|
289
|
-
| **search** | [**string**] | Search term to filter results | (optional) defaults to undefined|
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
### Return type
|
|
293
|
-
|
|
294
|
-
**CollectionsResponse**
|
|
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**: Not defined
|
|
303
|
-
- **Accept**: application/json
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
### HTTP response details
|
|
307
|
-
| Status code | Description | Response headers |
|
|
308
|
-
|-------------|-------------|------------------|
|
|
309
|
-
|**200** | Successfully retrieved all website collections. | - |
|
|
310
|
-
|**401** | Not authorised to access this resource | - |
|
|
311
|
-
|**403** | Refuse to authorize | - |
|
|
312
|
-
|**500** | Unknown server error | - |
|
|
313
|
-
|
|
314
|
-
[[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)
|
|
315
|
-
|
|
316
|
-
# **seoOptimiseCollections**
|
|
317
|
-
> SeoOptimisePages202Response seoOptimiseCollections()
|
|
318
|
-
|
|
319
|
-
AI SEO optimises collections by a set of given IDs.
|
|
320
|
-
|
|
321
|
-
### Example
|
|
322
|
-
|
|
323
|
-
```typescript
|
|
324
|
-
import {
|
|
325
|
-
CollectionsApi,
|
|
326
|
-
Configuration,
|
|
327
|
-
SeoOptimiseCollectionsRequest
|
|
328
|
-
} from '@teemill/website';
|
|
329
|
-
|
|
330
|
-
const configuration = new Configuration();
|
|
331
|
-
const apiInstance = new CollectionsApi(configuration);
|
|
332
|
-
|
|
333
|
-
let project: string; //What project it is (default to undefined)
|
|
334
|
-
let seoOptimiseCollectionsRequest: SeoOptimiseCollectionsRequest; //A set of collection IDs to AI SEO optimise. (optional)
|
|
335
|
-
|
|
336
|
-
const { status, data } = await apiInstance.seoOptimiseCollections(
|
|
337
|
-
project,
|
|
338
|
-
seoOptimiseCollectionsRequest
|
|
339
|
-
);
|
|
340
|
-
```
|
|
341
|
-
|
|
342
|
-
### Parameters
|
|
343
|
-
|
|
344
|
-
|Name | Type | Description | Notes|
|
|
345
|
-
|------------- | ------------- | ------------- | -------------|
|
|
346
|
-
| **seoOptimiseCollectionsRequest** | **SeoOptimiseCollectionsRequest**| A set of collection IDs to AI SEO optimise. | |
|
|
347
|
-
| **project** | [**string**] | What project it is | defaults to undefined|
|
|
348
|
-
|
|
349
|
-
|
|
350
|
-
### Return type
|
|
351
|
-
|
|
352
|
-
**SeoOptimisePages202Response**
|
|
353
|
-
|
|
354
|
-
### Authorization
|
|
355
|
-
|
|
356
|
-
[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
|
|
357
|
-
|
|
358
|
-
### HTTP request headers
|
|
359
|
-
|
|
360
|
-
- **Content-Type**: application/json
|
|
361
|
-
- **Accept**: application/json
|
|
362
|
-
|
|
363
|
-
|
|
364
|
-
### HTTP response details
|
|
365
|
-
| Status code | Description | Response headers |
|
|
366
|
-
|-------------|-------------|------------------|
|
|
367
|
-
|**202** | Collections queued for optimisation. | - |
|
|
368
|
-
|**400** | Failed validation | - |
|
|
369
|
-
|**401** | Not authorised to access this resource | - |
|
|
370
|
-
|**403** | Refuse to authorize | - |
|
|
371
|
-
|**404** | Resource not found | - |
|
|
372
|
-
|**500** | Unknown server error | - |
|
|
373
|
-
|
|
374
|
-
[[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)
|
|
375
|
-
|
|
376
|
-
# **updateCollection**
|
|
377
|
-
> Collection updateCollection()
|
|
378
|
-
|
|
379
|
-
|
|
380
|
-
### Example
|
|
381
|
-
|
|
382
|
-
```typescript
|
|
383
|
-
import {
|
|
384
|
-
CollectionsApi,
|
|
385
|
-
Configuration,
|
|
386
|
-
UpdateCollectionRequest
|
|
387
|
-
} from '@teemill/website';
|
|
388
|
-
|
|
389
|
-
const configuration = new Configuration();
|
|
390
|
-
const apiInstance = new CollectionsApi(configuration);
|
|
391
|
-
|
|
392
|
-
let project: string; //What project it is (default to undefined)
|
|
393
|
-
let collectionId: string; //Collection\'s unique identifier (default to undefined)
|
|
394
|
-
let updateCollectionRequest: UpdateCollectionRequest; // (optional)
|
|
395
|
-
|
|
396
|
-
const { status, data } = await apiInstance.updateCollection(
|
|
397
|
-
project,
|
|
398
|
-
collectionId,
|
|
399
|
-
updateCollectionRequest
|
|
400
|
-
);
|
|
401
|
-
```
|
|
402
|
-
|
|
403
|
-
### Parameters
|
|
404
|
-
|
|
405
|
-
|Name | Type | Description | Notes|
|
|
406
|
-
|------------- | ------------- | ------------- | -------------|
|
|
407
|
-
| **updateCollectionRequest** | **UpdateCollectionRequest**| | |
|
|
408
|
-
| **project** | [**string**] | What project it is | defaults to undefined|
|
|
409
|
-
| **collectionId** | [**string**] | Collection\'s unique identifier | defaults to undefined|
|
|
410
|
-
|
|
411
|
-
|
|
412
|
-
### Return type
|
|
413
|
-
|
|
414
|
-
**Collection**
|
|
415
|
-
|
|
416
|
-
### Authorization
|
|
417
|
-
|
|
418
|
-
[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
|
|
419
|
-
|
|
420
|
-
### HTTP request headers
|
|
421
|
-
|
|
422
|
-
- **Content-Type**: application/json
|
|
423
|
-
- **Accept**: application/json
|
|
424
|
-
|
|
425
|
-
|
|
426
|
-
### HTTP response details
|
|
427
|
-
| Status code | Description | Response headers |
|
|
428
|
-
|-------------|-------------|------------------|
|
|
429
|
-
|**200** | Successfully retrieved a website collection. | - |
|
|
430
|
-
|**400** | Failed validation | - |
|
|
431
|
-
|**401** | Not authorised to access this resource | - |
|
|
432
|
-
|**403** | Refuse to authorize | - |
|
|
433
|
-
|**404** | Resource not found | - |
|
|
434
|
-
|**500** | Unknown server error | - |
|
|
435
|
-
|
|
436
|
-
[[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)
|
|
437
|
-
|
|
438
|
-
# **updateCollections**
|
|
439
|
-
> CollectionsResponse updateCollections()
|
|
440
|
-
|
|
441
|
-
Update a website collection.
|
|
442
|
-
|
|
443
|
-
### Example
|
|
444
|
-
|
|
445
|
-
```typescript
|
|
446
|
-
import {
|
|
447
|
-
CollectionsApi,
|
|
448
|
-
Configuration,
|
|
449
|
-
UpdateCollectionsRequest
|
|
450
|
-
} from '@teemill/website';
|
|
451
|
-
|
|
452
|
-
const configuration = new Configuration();
|
|
453
|
-
const apiInstance = new CollectionsApi(configuration);
|
|
454
|
-
|
|
455
|
-
let project: string; //What project it is (default to undefined)
|
|
456
|
-
let pageToken: number; //Page reference token (optional) (default to 1)
|
|
457
|
-
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)
|
|
458
|
-
let search: string; //Search term to filter results (optional) (default to undefined)
|
|
459
|
-
let updateCollectionsRequest: UpdateCollectionsRequest; //Update collections in bulk. (optional)
|
|
460
|
-
|
|
461
|
-
const { status, data } = await apiInstance.updateCollections(
|
|
462
|
-
project,
|
|
463
|
-
pageToken,
|
|
464
|
-
pageSize,
|
|
465
|
-
search,
|
|
466
|
-
updateCollectionsRequest
|
|
467
|
-
);
|
|
468
|
-
```
|
|
469
|
-
|
|
470
|
-
### Parameters
|
|
471
|
-
|
|
472
|
-
|Name | Type | Description | Notes|
|
|
473
|
-
|------------- | ------------- | ------------- | -------------|
|
|
474
|
-
| **updateCollectionsRequest** | **UpdateCollectionsRequest**| Update collections in bulk. | |
|
|
475
|
-
| **project** | [**string**] | What project it is | defaults to undefined|
|
|
476
|
-
| **pageToken** | [**number**] | Page reference token | (optional) defaults to 1|
|
|
477
|
-
| **pageSize** | [**number**] | Max page size. This is the maximum page size that will be returned, but it might be smaller. | (optional) defaults to 100|
|
|
478
|
-
| **search** | [**string**] | Search term to filter results | (optional) defaults to undefined|
|
|
479
|
-
|
|
480
|
-
|
|
481
|
-
### Return type
|
|
482
|
-
|
|
483
|
-
**CollectionsResponse**
|
|
484
|
-
|
|
485
|
-
### Authorization
|
|
486
|
-
|
|
487
|
-
[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
|
|
488
|
-
|
|
489
53
|
### HTTP request headers
|
|
490
54
|
|
|
491
55
|
- **Content-Type**: application/json
|
|
@@ -495,11 +59,10 @@ const { status, data } = await apiInstance.updateCollections(
|
|
|
495
59
|
### HTTP response details
|
|
496
60
|
| Status code | Description | Response headers |
|
|
497
61
|
|-------------|-------------|------------------|
|
|
498
|
-
|**
|
|
499
|
-
|**400** | Failed validation | - |
|
|
62
|
+
|**204** | Collections successfully attached to product | - |
|
|
500
63
|
|**401** | Not authorised to access this resource | - |
|
|
501
64
|
|**403** | Refuse to authorize | - |
|
|
502
|
-
|**
|
|
65
|
+
|**422** | Failed validation | - |
|
|
503
66
|
|**500** | Unknown server error | - |
|
|
504
67
|
|
|
505
68
|
[[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/MenuItem.md
CHANGED
|
@@ -10,6 +10,7 @@ Name | Type | Description | Notes
|
|
|
10
10
|
**link** | **string** | | [default to undefined]
|
|
11
11
|
**color** | **string** | | [default to undefined]
|
|
12
12
|
**backgroundColor** | **string** | | [default to undefined]
|
|
13
|
+
**published** | **boolean** | | [default to undefined]
|
|
13
14
|
**order** | **number** | | [default to undefined]
|
|
14
15
|
**submenu** | [**Array<SubmenuInner>**](SubmenuInner.md) | | [default to undefined]
|
|
15
16
|
|
|
@@ -24,6 +25,7 @@ const instance: MenuItem = {
|
|
|
24
25
|
link,
|
|
25
26
|
color,
|
|
26
27
|
backgroundColor,
|
|
28
|
+
published,
|
|
27
29
|
order,
|
|
28
30
|
submenu,
|
|
29
31
|
};
|
package/docs/SubmenuInner.md
CHANGED
|
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**id** | **string** | | [default to undefined]
|
|
9
9
|
**title** | **string** | | [default to undefined]
|
|
10
10
|
**link** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**published** | **boolean** | | [default to undefined]
|
|
11
12
|
**image** | [**SubmenuInnerImage**](SubmenuInnerImage.md) | | [default to undefined]
|
|
12
13
|
**order** | **number** | | [default to undefined]
|
|
13
14
|
**items** | [**Array<SubmenuItem>**](SubmenuItem.md) | | [default to undefined]
|
|
@@ -22,6 +23,7 @@ const instance: SubmenuInner = {
|
|
|
22
23
|
id,
|
|
23
24
|
title,
|
|
24
25
|
link,
|
|
26
|
+
published,
|
|
25
27
|
image,
|
|
26
28
|
order,
|
|
27
29
|
items,
|
package/docs/SubmenuItem.md
CHANGED
|
@@ -10,6 +10,7 @@ Name | Type | Description | Notes
|
|
|
10
10
|
**link** | **string** | | [default to undefined]
|
|
11
11
|
**color** | **string** | | [default to undefined]
|
|
12
12
|
**backgroundColor** | **string** | | [default to undefined]
|
|
13
|
+
**published** | **boolean** | | [default to undefined]
|
|
13
14
|
**order** | **number** | | [default to undefined]
|
|
14
15
|
|
|
15
16
|
## Example
|
|
@@ -23,6 +24,7 @@ const instance: SubmenuItem = {
|
|
|
23
24
|
link,
|
|
24
25
|
color,
|
|
25
26
|
backgroundColor,
|
|
27
|
+
published,
|
|
26
28
|
order,
|
|
27
29
|
};
|
|
28
30
|
```
|
|
@@ -10,6 +10,7 @@ Name | Type | Description | Notes
|
|
|
10
10
|
**link** | **string** | | [default to undefined]
|
|
11
11
|
**color** | **string** | | [optional] [default to undefined]
|
|
12
12
|
**backgroundColor** | **string** | | [optional] [default to undefined]
|
|
13
|
+
**published** | **boolean** | | [optional] [default to undefined]
|
|
13
14
|
**order** | **number** | | [default to undefined]
|
|
14
15
|
**submenu** | [**Array<UpdateMenuRequestItemSubmenuInner>**](UpdateMenuRequestItemSubmenuInner.md) | | [default to undefined]
|
|
15
16
|
|
|
@@ -24,6 +25,7 @@ const instance: UpdateMenuRequestItem = {
|
|
|
24
25
|
link,
|
|
25
26
|
color,
|
|
26
27
|
backgroundColor,
|
|
28
|
+
published,
|
|
27
29
|
order,
|
|
28
30
|
submenu,
|
|
29
31
|
};
|
|
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**id** | **string** | | [default to undefined]
|
|
9
9
|
**title** | **string** | | [default to undefined]
|
|
10
10
|
**link** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**published** | **boolean** | | [optional] [default to undefined]
|
|
11
12
|
**image** | [**UpdateMenuRequestItemSubmenuInnerImage**](UpdateMenuRequestItemSubmenuInnerImage.md) | | [optional] [default to undefined]
|
|
12
13
|
**order** | **number** | | [default to undefined]
|
|
13
14
|
**items** | [**Array<UpdateMenuRequestSubmenuItem>**](UpdateMenuRequestSubmenuItem.md) | | [default to undefined]
|
|
@@ -22,6 +23,7 @@ const instance: UpdateMenuRequestItemSubmenuInner = {
|
|
|
22
23
|
id,
|
|
23
24
|
title,
|
|
24
25
|
link,
|
|
26
|
+
published,
|
|
25
27
|
image,
|
|
26
28
|
order,
|
|
27
29
|
items,
|
|
@@ -10,6 +10,7 @@ Name | Type | Description | Notes
|
|
|
10
10
|
**link** | **string** | | [default to undefined]
|
|
11
11
|
**color** | **string** | | [optional] [default to undefined]
|
|
12
12
|
**backgroundColor** | **string** | | [optional] [default to undefined]
|
|
13
|
+
**published** | **boolean** | | [optional] [default to undefined]
|
|
13
14
|
**order** | **number** | | [default to undefined]
|
|
14
15
|
|
|
15
16
|
## Example
|
|
@@ -23,6 +24,7 @@ const instance: UpdateMenuRequestSubmenuItem = {
|
|
|
23
24
|
link,
|
|
24
25
|
color,
|
|
25
26
|
backgroundColor,
|
|
27
|
+
published,
|
|
26
28
|
order,
|
|
27
29
|
};
|
|
28
30
|
```
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# UpdateProductCollectionsRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**collections** | **Array<string>** | An EXCLUSIVE list of collection IDs to attach to a product. If the product is in a collection not listed in this array, it will be removed from that collection. | [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { UpdateProductCollectionsRequest } from '@teemill/website';
|
|
14
|
+
|
|
15
|
+
const instance: UpdateProductCollectionsRequest = {
|
|
16
|
+
collections,
|
|
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)
|
package/index.ts
CHANGED