@connectedxm/admin-sdk 7.0.1 → 7.0.2
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 +1 -0
- package/AdminApi.ts +3 -0
- package/README.md +3 -0
- package/api.ts +417 -0
- package/dist/AdminApi.d.ts +2 -1
- package/dist/AdminApi.js +1 -0
- package/dist/api.d.ts +215 -0
- package/dist/api.js +303 -1
- package/dist/esm/AdminApi.d.ts +2 -1
- package/dist/esm/AdminApi.js +2 -1
- package/dist/esm/api.d.ts +215 -0
- package/dist/esm/api.js +298 -0
- package/docs/ThreadsStorageApi.md +199 -0
- package/package.json +1 -1
|
@@ -0,0 +1,199 @@
|
|
|
1
|
+
# ThreadsStorageApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://admin-api.connected.dev*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**getThreadStorageFiles**](#getthreadstoragefiles) | **GET** /threads/{threadId}/storage/files | Get Thread Storage Files|
|
|
8
|
+
|[**getThreadStorageImages**](#getthreadstorageimages) | **GET** /threads/{threadId}/storage/images | Get Thread Storage Images|
|
|
9
|
+
|[**getThreadStorageVideos**](#getthreadstoragevideos) | **GET** /threads/{threadId}/storage/videos | Get Thread Storage Videos|
|
|
10
|
+
|
|
11
|
+
# **getThreadStorageFiles**
|
|
12
|
+
> GetFiles200Response getThreadStorageFiles()
|
|
13
|
+
|
|
14
|
+
Get Thread Storage Files endpoint
|
|
15
|
+
|
|
16
|
+
### Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import {
|
|
20
|
+
ThreadsStorageApi,
|
|
21
|
+
Configuration
|
|
22
|
+
} from '@connectedxm/admin-sdk';
|
|
23
|
+
|
|
24
|
+
const configuration = new Configuration();
|
|
25
|
+
const apiInstance = new ThreadsStorageApi(configuration);
|
|
26
|
+
|
|
27
|
+
let threadId: string; //The thread identifier (default to undefined)
|
|
28
|
+
let page: number; //Page number (optional) (default to 1)
|
|
29
|
+
let pageSize: number; //Number of items per page (optional) (default to 25)
|
|
30
|
+
let orderBy: string; //Field to order by (optional) (default to undefined)
|
|
31
|
+
let search: string; //Search query (optional) (default to undefined)
|
|
32
|
+
|
|
33
|
+
const { status, data } = await apiInstance.getThreadStorageFiles(
|
|
34
|
+
threadId,
|
|
35
|
+
page,
|
|
36
|
+
pageSize,
|
|
37
|
+
orderBy,
|
|
38
|
+
search
|
|
39
|
+
);
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
### Parameters
|
|
43
|
+
|
|
44
|
+
|Name | Type | Description | Notes|
|
|
45
|
+
|------------- | ------------- | ------------- | -------------|
|
|
46
|
+
| **threadId** | [**string**] | The thread identifier | defaults to undefined|
|
|
47
|
+
| **page** | [**number**] | Page number | (optional) defaults to 1|
|
|
48
|
+
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
|
|
49
|
+
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
|
|
50
|
+
| **search** | [**string**] | Search query | (optional) defaults to undefined|
|
|
51
|
+
|
|
52
|
+
|
|
53
|
+
### Return type
|
|
54
|
+
|
|
55
|
+
**GetFiles200Response**
|
|
56
|
+
|
|
57
|
+
### Authorization
|
|
58
|
+
|
|
59
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
60
|
+
|
|
61
|
+
### HTTP request headers
|
|
62
|
+
|
|
63
|
+
- **Content-Type**: Not defined
|
|
64
|
+
- **Accept**: application/json
|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
### HTTP response details
|
|
68
|
+
| Status code | Description | Response headers |
|
|
69
|
+
|-------------|-------------|------------------|
|
|
70
|
+
|**200** | Successful response | - |
|
|
71
|
+
|
|
72
|
+
[[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)
|
|
73
|
+
|
|
74
|
+
# **getThreadStorageImages**
|
|
75
|
+
> GetEventPageImages200Response getThreadStorageImages()
|
|
76
|
+
|
|
77
|
+
Get Thread Storage Images endpoint
|
|
78
|
+
|
|
79
|
+
### Example
|
|
80
|
+
|
|
81
|
+
```typescript
|
|
82
|
+
import {
|
|
83
|
+
ThreadsStorageApi,
|
|
84
|
+
Configuration
|
|
85
|
+
} from '@connectedxm/admin-sdk';
|
|
86
|
+
|
|
87
|
+
const configuration = new Configuration();
|
|
88
|
+
const apiInstance = new ThreadsStorageApi(configuration);
|
|
89
|
+
|
|
90
|
+
let threadId: string; //The thread identifier (default to undefined)
|
|
91
|
+
let page: number; //Page number (optional) (default to 1)
|
|
92
|
+
let pageSize: number; //Number of items per page (optional) (default to 25)
|
|
93
|
+
let orderBy: string; //Field to order by (optional) (default to undefined)
|
|
94
|
+
let search: string; //Search query (optional) (default to undefined)
|
|
95
|
+
|
|
96
|
+
const { status, data } = await apiInstance.getThreadStorageImages(
|
|
97
|
+
threadId,
|
|
98
|
+
page,
|
|
99
|
+
pageSize,
|
|
100
|
+
orderBy,
|
|
101
|
+
search
|
|
102
|
+
);
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
### Parameters
|
|
106
|
+
|
|
107
|
+
|Name | Type | Description | Notes|
|
|
108
|
+
|------------- | ------------- | ------------- | -------------|
|
|
109
|
+
| **threadId** | [**string**] | The thread identifier | defaults to undefined|
|
|
110
|
+
| **page** | [**number**] | Page number | (optional) defaults to 1|
|
|
111
|
+
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
|
|
112
|
+
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
|
|
113
|
+
| **search** | [**string**] | Search query | (optional) defaults to undefined|
|
|
114
|
+
|
|
115
|
+
|
|
116
|
+
### Return type
|
|
117
|
+
|
|
118
|
+
**GetEventPageImages200Response**
|
|
119
|
+
|
|
120
|
+
### Authorization
|
|
121
|
+
|
|
122
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
123
|
+
|
|
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
|
+
|**200** | Successful response | - |
|
|
134
|
+
|
|
135
|
+
[[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)
|
|
136
|
+
|
|
137
|
+
# **getThreadStorageVideos**
|
|
138
|
+
> GetStreamVideos200Response getThreadStorageVideos()
|
|
139
|
+
|
|
140
|
+
Get Thread Storage Videos endpoint
|
|
141
|
+
|
|
142
|
+
### Example
|
|
143
|
+
|
|
144
|
+
```typescript
|
|
145
|
+
import {
|
|
146
|
+
ThreadsStorageApi,
|
|
147
|
+
Configuration
|
|
148
|
+
} from '@connectedxm/admin-sdk';
|
|
149
|
+
|
|
150
|
+
const configuration = new Configuration();
|
|
151
|
+
const apiInstance = new ThreadsStorageApi(configuration);
|
|
152
|
+
|
|
153
|
+
let threadId: string; //The thread identifier (default to undefined)
|
|
154
|
+
let page: number; //Page number (optional) (default to 1)
|
|
155
|
+
let pageSize: number; //Number of items per page (optional) (default to 25)
|
|
156
|
+
let orderBy: string; //Field to order by (optional) (default to undefined)
|
|
157
|
+
let search: string; //Search query (optional) (default to undefined)
|
|
158
|
+
|
|
159
|
+
const { status, data } = await apiInstance.getThreadStorageVideos(
|
|
160
|
+
threadId,
|
|
161
|
+
page,
|
|
162
|
+
pageSize,
|
|
163
|
+
orderBy,
|
|
164
|
+
search
|
|
165
|
+
);
|
|
166
|
+
```
|
|
167
|
+
|
|
168
|
+
### Parameters
|
|
169
|
+
|
|
170
|
+
|Name | Type | Description | Notes|
|
|
171
|
+
|------------- | ------------- | ------------- | -------------|
|
|
172
|
+
| **threadId** | [**string**] | The thread identifier | defaults to undefined|
|
|
173
|
+
| **page** | [**number**] | Page number | (optional) defaults to 1|
|
|
174
|
+
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
|
|
175
|
+
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
|
|
176
|
+
| **search** | [**string**] | Search query | (optional) defaults to undefined|
|
|
177
|
+
|
|
178
|
+
|
|
179
|
+
### Return type
|
|
180
|
+
|
|
181
|
+
**GetStreamVideos200Response**
|
|
182
|
+
|
|
183
|
+
### Authorization
|
|
184
|
+
|
|
185
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
186
|
+
|
|
187
|
+
### HTTP request headers
|
|
188
|
+
|
|
189
|
+
- **Content-Type**: Not defined
|
|
190
|
+
- **Accept**: application/json
|
|
191
|
+
|
|
192
|
+
|
|
193
|
+
### HTTP response details
|
|
194
|
+
| Status code | Description | Response headers |
|
|
195
|
+
|-------------|-------------|------------------|
|
|
196
|
+
|**200** | Successful response | - |
|
|
197
|
+
|
|
198
|
+
[[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)
|
|
199
|
+
|