@connectedxm/admin-sdk 7.2.9 → 7.3.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.
Files changed (13) hide show
  1. package/.openapi-generator/FILES +4 -2
  2. package/README.md +6 -3
  3. package/api.ts +145 -48
  4. package/dist/api.d.ts +92 -40
  5. package/dist/api.js +126 -52
  6. package/dist/esm/api.d.ts +92 -40
  7. package/dist/esm/api.js +103 -29
  8. package/docs/{CreateImage200Response.md → GetImage200Response.md} +3 -3
  9. package/docs/ImageDirectUpload.md +22 -0
  10. package/docs/{ImageCreateInputs.md → ImageDirectUploadInputs.md} +6 -8
  11. package/docs/RequestImageDirectUpload200Response.md +24 -0
  12. package/docs/StorageImagesApi.md +70 -18
  13. package/package.json +1 -1
package/docs/StorageImagesApi.md CHANGED
@@ -4,36 +4,36 @@ All URIs are relative to *https://admin-api.connected.dev*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
7
- |[**createImage**](#createimage) | **POST** /images | Create Image|
7
+ |[**confirmImageUpload**](#confirmimageupload) | **POST** /images/{imageId}/confirm | Confirm Image Upload|
8
8
  |[**deleteImage**](#deleteimage) | **DELETE** /images/{imageId} | Delete Image|
9
9
  |[**deleteManyImages**](#deletemanyimages) | **POST** /images/delete | Delete Many Images|
10
10
  |[**getImage**](#getimage) | **GET** /images/{imageId} | Get Image|
11
11
  |[**getImageUsage**](#getimageusage) | **GET** /images/{imageId}/usage | Get Image Usage|
12
12
  |[**getImages**](#getimages) | **GET** /images | Get Images|
13
+ |[**requestImageDirectUpload**](#requestimagedirectupload) | **POST** /images/direct-upload | Request Image Direct Upload|
13
14
  |[**switchImage**](#switchimage) | **PUT** /images/{imageId}/switch | Switch Image|
14
15
  |[**updateImage**](#updateimage) | **PUT** /images/{imageId} | Update Image|
15
16
 
16
- # **createImage**
17
- > CreateImage200Response createImage(imageCreateInputs)
17
+ # **confirmImageUpload**
18
+ > GetImage200Response confirmImageUpload()
18
19
 
19
- Create Image endpoint
20
+ Confirm Image Upload endpoint
20
21
 
21
22
  ### Example
22
23
 
23
24
  ```typescript
24
25
  import {
25
26
  StorageImagesApi,
26
- Configuration,
27
- ImageCreateInputs
27
+ Configuration
28
28
  } from '@connectedxm/admin-sdk';
29
29
 
30
30
  const configuration = new Configuration();
31
31
  const apiInstance = new StorageImagesApi(configuration);
32
32
 
33
- let imageCreateInputs: ImageCreateInputs; //
33
+ let imageId: string; //The image identifier (default to undefined)
34
34
 
35
- const { status, data } = await apiInstance.createImage(
36
- imageCreateInputs
35
+ const { status, data } = await apiInstance.confirmImageUpload(
36
+ imageId
37
37
  );
38
38
  ```
39
39
 
@@ -41,12 +41,12 @@ const { status, data } = await apiInstance.createImage(
41
41
 
42
42
  |Name | Type | Description | Notes|
43
43
  |------------- | ------------- | ------------- | -------------|
44
- | **imageCreateInputs** | **ImageCreateInputs**| | |
44
+ | **imageId** | [**string**] | The image identifier | defaults to undefined|
45
45
 
46
46
 
47
47
  ### Return type
48
48
 
49
- **CreateImage200Response**
49
+ **GetImage200Response**
50
50
 
51
51
  ### Authorization
52
52
 
@@ -54,7 +54,7 @@ const { status, data } = await apiInstance.createImage(
54
54
 
55
55
  ### HTTP request headers
56
56
 
57
- - **Content-Type**: application/json
57
+ - **Content-Type**: Not defined
58
58
  - **Accept**: application/json
59
59
 
60
60
 
@@ -169,7 +169,7 @@ const { status, data } = await apiInstance.deleteManyImages(
169
169
  [[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)
170
170
 
171
171
  # **getImage**
172
- > CreateImage200Response getImage()
172
+ > GetImage200Response getImage()
173
173
 
174
174
  Get Image endpoint
175
175
 
@@ -200,7 +200,7 @@ const { status, data } = await apiInstance.getImage(
200
200
 
201
201
  ### Return type
202
202
 
203
- **CreateImage200Response**
203
+ **GetImage200Response**
204
204
 
205
205
  ### Authorization
206
206
 
@@ -326,6 +326,58 @@ const { status, data } = await apiInstance.getImages(
326
326
  - **Accept**: application/json
327
327
 
328
328
 
329
+ ### HTTP response details
330
+ | Status code | Description | Response headers |
331
+ |-------------|-------------|------------------|
332
+ |**200** | Successful response | - |
333
+
334
+ [[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)
335
+
336
+ # **requestImageDirectUpload**
337
+ > RequestImageDirectUpload200Response requestImageDirectUpload(imageDirectUploadInputs)
338
+
339
+ Request Image Direct Upload endpoint
340
+
341
+ ### Example
342
+
343
+ ```typescript
344
+ import {
345
+ StorageImagesApi,
346
+ Configuration,
347
+ ImageDirectUploadInputs
348
+ } from '@connectedxm/admin-sdk';
349
+
350
+ const configuration = new Configuration();
351
+ const apiInstance = new StorageImagesApi(configuration);
352
+
353
+ let imageDirectUploadInputs: ImageDirectUploadInputs; //
354
+
355
+ const { status, data } = await apiInstance.requestImageDirectUpload(
356
+ imageDirectUploadInputs
357
+ );
358
+ ```
359
+
360
+ ### Parameters
361
+
362
+ |Name | Type | Description | Notes|
363
+ |------------- | ------------- | ------------- | -------------|
364
+ | **imageDirectUploadInputs** | **ImageDirectUploadInputs**| | |
365
+
366
+
367
+ ### Return type
368
+
369
+ **RequestImageDirectUpload200Response**
370
+
371
+ ### Authorization
372
+
373
+ [ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
374
+
375
+ ### HTTP request headers
376
+
377
+ - **Content-Type**: application/json
378
+ - **Accept**: application/json
379
+
380
+
329
381
  ### HTTP response details
330
382
  | Status code | Description | Response headers |
331
383
  |-------------|-------------|------------------|
@@ -334,7 +386,7 @@ const { status, data } = await apiInstance.getImages(
334
386
  [[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)
335
387
 
336
388
  # **switchImage**
337
- > CreateImage200Response switchImage()
389
+ > GetImage200Response switchImage()
338
390
 
339
391
  Switch Image endpoint
340
392
 
@@ -368,7 +420,7 @@ const { status, data } = await apiInstance.switchImage(
368
420
 
369
421
  ### Return type
370
422
 
371
- **CreateImage200Response**
423
+ **GetImage200Response**
372
424
 
373
425
  ### Authorization
374
426
 
@@ -388,7 +440,7 @@ const { status, data } = await apiInstance.switchImage(
388
440
  [[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)
389
441
 
390
442
  # **updateImage**
391
- > CreateImage200Response updateImage(imageUpdateInputs)
443
+ > GetImage200Response updateImage(imageUpdateInputs)
392
444
 
393
445
  Update Image endpoint
394
446
 
@@ -423,7 +475,7 @@ const { status, data } = await apiInstance.updateImage(
423
475
 
424
476
  ### Return type
425
477
 
426
- **CreateImage200Response**
478
+ **GetImage200Response**
427
479
 
428
480
  ### Authorization
429
481
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@connectedxm/admin-sdk",
3
- "version": "7.2.9",
3
+ "version": "7.3.0",
4
4
  "description": "OpenAPI client for @connectedxm/admin-sdk",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {