yellowgrid-api-ts 3.2.246-dev.0 → 3.2.248-dev.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 +5 -0
- package/README.md +13 -0
- package/api.ts +899 -8
- package/dist/api.d.ts +562 -8
- package/dist/api.js +716 -4
- package/docs/BrandedVideoSummaryDTO.md +45 -0
- package/docs/BrandedVideosApi.md +424 -0
- package/docs/BrandedVideosSummariesModel.md +27 -0
- package/docs/OAuth20Api.md +3 -3
- package/docs/PromoCodesEntity.md +5 -5
- package/docs/PromoModel.md +5 -5
- package/docs/PromoSummaryDTO.md +2 -0
- package/docs/ThumbnailDTO.md +25 -0
- package/docs/VideoRequestEntity.md +51 -0
- package/package.json +1 -1
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
# BrandedVideoSummaryDTO
|
|
2
|
+
|
|
3
|
+
Branded Video Summary
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**id** | **number** | ID | [optional] [default to undefined]
|
|
10
|
+
**company** | **string** | Company | [optional] [default to undefined]
|
|
11
|
+
**type** | **string** | Type | [optional] [default to undefined]
|
|
12
|
+
**video** | **string** | Video | [optional] [default to undefined]
|
|
13
|
+
**email** | **string** | Email | [optional] [default to undefined]
|
|
14
|
+
**website** | **string** | Website | [optional] [default to undefined]
|
|
15
|
+
**telephone** | **string** | Telephone | [optional] [default to undefined]
|
|
16
|
+
**invoiceNumber** | **string** | Invoice Number | [optional] [default to undefined]
|
|
17
|
+
**requestDate** | **string** | Date Time | [optional] [default to undefined]
|
|
18
|
+
**dueDate** | **string** | Date Time | [optional] [default to undefined]
|
|
19
|
+
**oneDriveId** | **string** | OneDrive ID | [optional] [default to undefined]
|
|
20
|
+
**status** | **string** | Status | [optional] [default to undefined]
|
|
21
|
+
**notes** | **string** | Notes | [optional] [default to undefined]
|
|
22
|
+
|
|
23
|
+
## Example
|
|
24
|
+
|
|
25
|
+
```typescript
|
|
26
|
+
import { BrandedVideoSummaryDTO } from 'yellowgrid-api-ts';
|
|
27
|
+
|
|
28
|
+
const instance: BrandedVideoSummaryDTO = {
|
|
29
|
+
id,
|
|
30
|
+
company,
|
|
31
|
+
type,
|
|
32
|
+
video,
|
|
33
|
+
email,
|
|
34
|
+
website,
|
|
35
|
+
telephone,
|
|
36
|
+
invoiceNumber,
|
|
37
|
+
requestDate,
|
|
38
|
+
dueDate,
|
|
39
|
+
oneDriveId,
|
|
40
|
+
status,
|
|
41
|
+
notes,
|
|
42
|
+
};
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
[[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,424 @@
|
|
|
1
|
+
# BrandedVideosApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.local.yellowgrid.co.uk*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**deleteDeleteVideoRequest**](#deletedeletevideorequest) | **DELETE** /marketing/videos/{id} | |
|
|
8
|
+
|[**getDownloadLogo**](#getdownloadlogo) | **GET** /marketing/videos/logo | |
|
|
9
|
+
|[**getGetBrandedVideos**](#getgetbrandedvideos) | **GET** /marketing/videos | |
|
|
10
|
+
|[**getGetThumbnails**](#getgetthumbnails) | **GET** /marketing/videos/thumbnails | |
|
|
11
|
+
|[**postDownloadLogo**](#postdownloadlogo) | **POST** /marketing/videos/logo | |
|
|
12
|
+
|[**postSendBrandedVideoEmail**](#postsendbrandedvideoemail) | **POST** /marketing/videos/{id}/send | |
|
|
13
|
+
|[**postUploadVideo**](#postuploadvideo) | **POST** /marketing/videos/{id}/upload | |
|
|
14
|
+
|
|
15
|
+
# **deleteDeleteVideoRequest**
|
|
16
|
+
> deleteDeleteVideoRequest()
|
|
17
|
+
|
|
18
|
+
Send Branded Video Email
|
|
19
|
+
|
|
20
|
+
### Example
|
|
21
|
+
|
|
22
|
+
```typescript
|
|
23
|
+
import {
|
|
24
|
+
BrandedVideosApi,
|
|
25
|
+
Configuration
|
|
26
|
+
} from 'yellowgrid-api-ts';
|
|
27
|
+
|
|
28
|
+
const configuration = new Configuration();
|
|
29
|
+
const apiInstance = new BrandedVideosApi(configuration);
|
|
30
|
+
|
|
31
|
+
let id: number; //Video ID (default to undefined)
|
|
32
|
+
let customerId: number; //Customer ID (optional) (default to undefined)
|
|
33
|
+
|
|
34
|
+
const { status, data } = await apiInstance.deleteDeleteVideoRequest(
|
|
35
|
+
id,
|
|
36
|
+
customerId
|
|
37
|
+
);
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
### Parameters
|
|
41
|
+
|
|
42
|
+
|Name | Type | Description | Notes|
|
|
43
|
+
|------------- | ------------- | ------------- | -------------|
|
|
44
|
+
| **id** | [**number**] | Video ID | defaults to undefined|
|
|
45
|
+
| **customerId** | [**number**] | Customer ID | (optional) defaults to undefined|
|
|
46
|
+
|
|
47
|
+
|
|
48
|
+
### Return type
|
|
49
|
+
|
|
50
|
+
void (empty response body)
|
|
51
|
+
|
|
52
|
+
### Authorization
|
|
53
|
+
|
|
54
|
+
No authorization required
|
|
55
|
+
|
|
56
|
+
### HTTP request headers
|
|
57
|
+
|
|
58
|
+
- **Content-Type**: Not defined
|
|
59
|
+
- **Accept**: Not defined
|
|
60
|
+
|
|
61
|
+
|
|
62
|
+
### HTTP response details
|
|
63
|
+
| Status code | Description | Response headers |
|
|
64
|
+
|-------------|-------------|------------------|
|
|
65
|
+
|**200** | No Response | - |
|
|
66
|
+
|**400** | Bad Request | - |
|
|
67
|
+
|**401** | Unauthorised | - |
|
|
68
|
+
|**403** | Access Denied | - |
|
|
69
|
+
|
|
70
|
+
[[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)
|
|
71
|
+
|
|
72
|
+
# **getDownloadLogo**
|
|
73
|
+
> string getDownloadLogo()
|
|
74
|
+
|
|
75
|
+
Get Customer Logo
|
|
76
|
+
|
|
77
|
+
### Example
|
|
78
|
+
|
|
79
|
+
```typescript
|
|
80
|
+
import {
|
|
81
|
+
BrandedVideosApi,
|
|
82
|
+
Configuration
|
|
83
|
+
} from 'yellowgrid-api-ts';
|
|
84
|
+
|
|
85
|
+
const configuration = new Configuration();
|
|
86
|
+
const apiInstance = new BrandedVideosApi(configuration);
|
|
87
|
+
|
|
88
|
+
let customerId: number; //Customer ID (optional) (default to undefined)
|
|
89
|
+
|
|
90
|
+
const { status, data } = await apiInstance.getDownloadLogo(
|
|
91
|
+
customerId
|
|
92
|
+
);
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
### Parameters
|
|
96
|
+
|
|
97
|
+
|Name | Type | Description | Notes|
|
|
98
|
+
|------------- | ------------- | ------------- | -------------|
|
|
99
|
+
| **customerId** | [**number**] | Customer ID | (optional) defaults to undefined|
|
|
100
|
+
|
|
101
|
+
|
|
102
|
+
### Return type
|
|
103
|
+
|
|
104
|
+
**string**
|
|
105
|
+
|
|
106
|
+
### Authorization
|
|
107
|
+
|
|
108
|
+
No authorization required
|
|
109
|
+
|
|
110
|
+
### HTTP request headers
|
|
111
|
+
|
|
112
|
+
- **Content-Type**: Not defined
|
|
113
|
+
- **Accept**: application/json
|
|
114
|
+
|
|
115
|
+
|
|
116
|
+
### HTTP response details
|
|
117
|
+
| Status code | Description | Response headers |
|
|
118
|
+
|-------------|-------------|------------------|
|
|
119
|
+
|**200** | Logo URL | - |
|
|
120
|
+
|**400** | Bad Request | - |
|
|
121
|
+
|**401** | Unauthorised | - |
|
|
122
|
+
|**403** | Access Denied | - |
|
|
123
|
+
|
|
124
|
+
[[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)
|
|
125
|
+
|
|
126
|
+
# **getGetBrandedVideos**
|
|
127
|
+
> BrandedVideosSummariesModel getGetBrandedVideos()
|
|
128
|
+
|
|
129
|
+
Get Branded Videos
|
|
130
|
+
|
|
131
|
+
### Example
|
|
132
|
+
|
|
133
|
+
```typescript
|
|
134
|
+
import {
|
|
135
|
+
BrandedVideosApi,
|
|
136
|
+
Configuration
|
|
137
|
+
} from 'yellowgrid-api-ts';
|
|
138
|
+
|
|
139
|
+
const configuration = new Configuration();
|
|
140
|
+
const apiInstance = new BrandedVideosApi(configuration);
|
|
141
|
+
|
|
142
|
+
let pageSize: number; //Number Of Results (optional) (default to 20)
|
|
143
|
+
let page: number; //Page Number (optional) (default to 1)
|
|
144
|
+
let search: string; //Search (optional) (default to undefined)
|
|
145
|
+
let type: 'paid' | 'reward' | 'sample'; //Type (optional) (default to undefined)
|
|
146
|
+
let outstanding: boolean; //Outstanding (optional) (default to undefined)
|
|
147
|
+
let overdue: boolean; //Overdue (optional) (default to undefined)
|
|
148
|
+
let customerId: number; //Customer ID (optional) (default to undefined)
|
|
149
|
+
|
|
150
|
+
const { status, data } = await apiInstance.getGetBrandedVideos(
|
|
151
|
+
pageSize,
|
|
152
|
+
page,
|
|
153
|
+
search,
|
|
154
|
+
type,
|
|
155
|
+
outstanding,
|
|
156
|
+
overdue,
|
|
157
|
+
customerId
|
|
158
|
+
);
|
|
159
|
+
```
|
|
160
|
+
|
|
161
|
+
### Parameters
|
|
162
|
+
|
|
163
|
+
|Name | Type | Description | Notes|
|
|
164
|
+
|------------- | ------------- | ------------- | -------------|
|
|
165
|
+
| **pageSize** | [**number**] | Number Of Results | (optional) defaults to 20|
|
|
166
|
+
| **page** | [**number**] | Page Number | (optional) defaults to 1|
|
|
167
|
+
| **search** | [**string**] | Search | (optional) defaults to undefined|
|
|
168
|
+
| **type** | [**'paid' | 'reward' | 'sample'**]**Array<'paid' | 'reward' | 'sample'>** | Type | (optional) defaults to undefined|
|
|
169
|
+
| **outstanding** | [**boolean**] | Outstanding | (optional) defaults to undefined|
|
|
170
|
+
| **overdue** | [**boolean**] | Overdue | (optional) defaults to undefined|
|
|
171
|
+
| **customerId** | [**number**] | Customer ID | (optional) defaults to undefined|
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
### Return type
|
|
175
|
+
|
|
176
|
+
**BrandedVideosSummariesModel**
|
|
177
|
+
|
|
178
|
+
### Authorization
|
|
179
|
+
|
|
180
|
+
No authorization required
|
|
181
|
+
|
|
182
|
+
### HTTP request headers
|
|
183
|
+
|
|
184
|
+
- **Content-Type**: Not defined
|
|
185
|
+
- **Accept**: application/json
|
|
186
|
+
|
|
187
|
+
|
|
188
|
+
### HTTP response details
|
|
189
|
+
| Status code | Description | Response headers |
|
|
190
|
+
|-------------|-------------|------------------|
|
|
191
|
+
|**200** | Branded Video Summaries | - |
|
|
192
|
+
|**400** | Bad Request | - |
|
|
193
|
+
|**401** | Unauthorised | - |
|
|
194
|
+
|**403** | Access Denied | - |
|
|
195
|
+
|
|
196
|
+
[[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)
|
|
197
|
+
|
|
198
|
+
# **getGetThumbnails**
|
|
199
|
+
> Array<ThumbnailDTO> getGetThumbnails()
|
|
200
|
+
|
|
201
|
+
Get Thumbnails
|
|
202
|
+
|
|
203
|
+
### Example
|
|
204
|
+
|
|
205
|
+
```typescript
|
|
206
|
+
import {
|
|
207
|
+
BrandedVideosApi,
|
|
208
|
+
Configuration
|
|
209
|
+
} from 'yellowgrid-api-ts';
|
|
210
|
+
|
|
211
|
+
const configuration = new Configuration();
|
|
212
|
+
const apiInstance = new BrandedVideosApi(configuration);
|
|
213
|
+
|
|
214
|
+
const { status, data } = await apiInstance.getGetThumbnails();
|
|
215
|
+
```
|
|
216
|
+
|
|
217
|
+
### Parameters
|
|
218
|
+
This endpoint does not have any parameters.
|
|
219
|
+
|
|
220
|
+
|
|
221
|
+
### Return type
|
|
222
|
+
|
|
223
|
+
**Array<ThumbnailDTO>**
|
|
224
|
+
|
|
225
|
+
### Authorization
|
|
226
|
+
|
|
227
|
+
No authorization required
|
|
228
|
+
|
|
229
|
+
### HTTP request headers
|
|
230
|
+
|
|
231
|
+
- **Content-Type**: Not defined
|
|
232
|
+
- **Accept**: application/json
|
|
233
|
+
|
|
234
|
+
|
|
235
|
+
### HTTP response details
|
|
236
|
+
| Status code | Description | Response headers |
|
|
237
|
+
|-------------|-------------|------------------|
|
|
238
|
+
|**200** | Thumbnails | - |
|
|
239
|
+
|**400** | Bad Request | - |
|
|
240
|
+
|**401** | Unauthorised | - |
|
|
241
|
+
|**403** | Access Denied | - |
|
|
242
|
+
|
|
243
|
+
[[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)
|
|
244
|
+
|
|
245
|
+
# **postDownloadLogo**
|
|
246
|
+
> postDownloadLogo()
|
|
247
|
+
|
|
248
|
+
Upload logo
|
|
249
|
+
|
|
250
|
+
### Example
|
|
251
|
+
|
|
252
|
+
```typescript
|
|
253
|
+
import {
|
|
254
|
+
BrandedVideosApi,
|
|
255
|
+
Configuration
|
|
256
|
+
} from 'yellowgrid-api-ts';
|
|
257
|
+
|
|
258
|
+
const configuration = new Configuration();
|
|
259
|
+
const apiInstance = new BrandedVideosApi(configuration);
|
|
260
|
+
|
|
261
|
+
let logo: File; //Logo (default to undefined)
|
|
262
|
+
let customerId: number; //Customer ID (optional) (default to undefined)
|
|
263
|
+
|
|
264
|
+
const { status, data } = await apiInstance.postDownloadLogo(
|
|
265
|
+
logo,
|
|
266
|
+
customerId
|
|
267
|
+
);
|
|
268
|
+
```
|
|
269
|
+
|
|
270
|
+
### Parameters
|
|
271
|
+
|
|
272
|
+
|Name | Type | Description | Notes|
|
|
273
|
+
|------------- | ------------- | ------------- | -------------|
|
|
274
|
+
| **logo** | [**File**] | Logo | defaults to undefined|
|
|
275
|
+
| **customerId** | [**number**] | Customer ID | (optional) defaults to undefined|
|
|
276
|
+
|
|
277
|
+
|
|
278
|
+
### Return type
|
|
279
|
+
|
|
280
|
+
void (empty response body)
|
|
281
|
+
|
|
282
|
+
### Authorization
|
|
283
|
+
|
|
284
|
+
No authorization required
|
|
285
|
+
|
|
286
|
+
### HTTP request headers
|
|
287
|
+
|
|
288
|
+
- **Content-Type**: multipart/form-data
|
|
289
|
+
- **Accept**: Not defined
|
|
290
|
+
|
|
291
|
+
|
|
292
|
+
### HTTP response details
|
|
293
|
+
| Status code | Description | Response headers |
|
|
294
|
+
|-------------|-------------|------------------|
|
|
295
|
+
|**200** | No Response | - |
|
|
296
|
+
|**400** | Bad Request | - |
|
|
297
|
+
|**401** | Unauthorised | - |
|
|
298
|
+
|**403** | Access Denied | - |
|
|
299
|
+
|
|
300
|
+
[[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)
|
|
301
|
+
|
|
302
|
+
# **postSendBrandedVideoEmail**
|
|
303
|
+
> postSendBrandedVideoEmail()
|
|
304
|
+
|
|
305
|
+
Send Branded Video Email
|
|
306
|
+
|
|
307
|
+
### Example
|
|
308
|
+
|
|
309
|
+
```typescript
|
|
310
|
+
import {
|
|
311
|
+
BrandedVideosApi,
|
|
312
|
+
Configuration
|
|
313
|
+
} from 'yellowgrid-api-ts';
|
|
314
|
+
|
|
315
|
+
const configuration = new Configuration();
|
|
316
|
+
const apiInstance = new BrandedVideosApi(configuration);
|
|
317
|
+
|
|
318
|
+
let email: string; //Email (default to undefined)
|
|
319
|
+
let id: number; //Video ID (default to undefined)
|
|
320
|
+
let customerId: number; //Customer ID (optional) (default to undefined)
|
|
321
|
+
|
|
322
|
+
const { status, data } = await apiInstance.postSendBrandedVideoEmail(
|
|
323
|
+
email,
|
|
324
|
+
id,
|
|
325
|
+
customerId
|
|
326
|
+
);
|
|
327
|
+
```
|
|
328
|
+
|
|
329
|
+
### Parameters
|
|
330
|
+
|
|
331
|
+
|Name | Type | Description | Notes|
|
|
332
|
+
|------------- | ------------- | ------------- | -------------|
|
|
333
|
+
| **email** | [**string**] | Email | defaults to undefined|
|
|
334
|
+
| **id** | [**number**] | Video ID | defaults to undefined|
|
|
335
|
+
| **customerId** | [**number**] | Customer ID | (optional) defaults to undefined|
|
|
336
|
+
|
|
337
|
+
|
|
338
|
+
### Return type
|
|
339
|
+
|
|
340
|
+
void (empty response body)
|
|
341
|
+
|
|
342
|
+
### Authorization
|
|
343
|
+
|
|
344
|
+
No authorization required
|
|
345
|
+
|
|
346
|
+
### HTTP request headers
|
|
347
|
+
|
|
348
|
+
- **Content-Type**: Not defined
|
|
349
|
+
- **Accept**: Not defined
|
|
350
|
+
|
|
351
|
+
|
|
352
|
+
### HTTP response details
|
|
353
|
+
| Status code | Description | Response headers |
|
|
354
|
+
|-------------|-------------|------------------|
|
|
355
|
+
|**200** | No Response | - |
|
|
356
|
+
|**400** | Bad Request | - |
|
|
357
|
+
|**401** | Unauthorised | - |
|
|
358
|
+
|**403** | Access Denied | - |
|
|
359
|
+
|
|
360
|
+
[[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)
|
|
361
|
+
|
|
362
|
+
# **postUploadVideo**
|
|
363
|
+
> BrandedVideoSummaryDTO postUploadVideo()
|
|
364
|
+
|
|
365
|
+
Upload Video
|
|
366
|
+
|
|
367
|
+
### Example
|
|
368
|
+
|
|
369
|
+
```typescript
|
|
370
|
+
import {
|
|
371
|
+
BrandedVideosApi,
|
|
372
|
+
Configuration
|
|
373
|
+
} from 'yellowgrid-api-ts';
|
|
374
|
+
|
|
375
|
+
const configuration = new Configuration();
|
|
376
|
+
const apiInstance = new BrandedVideosApi(configuration);
|
|
377
|
+
|
|
378
|
+
let thumbnailId: string; //Thumbnail ID (default to undefined)
|
|
379
|
+
let id: number; //Video ID (default to undefined)
|
|
380
|
+
let video: File; //Video (default to undefined)
|
|
381
|
+
let customerId: number; //Customer ID (optional) (default to undefined)
|
|
382
|
+
|
|
383
|
+
const { status, data } = await apiInstance.postUploadVideo(
|
|
384
|
+
thumbnailId,
|
|
385
|
+
id,
|
|
386
|
+
video,
|
|
387
|
+
customerId
|
|
388
|
+
);
|
|
389
|
+
```
|
|
390
|
+
|
|
391
|
+
### Parameters
|
|
392
|
+
|
|
393
|
+
|Name | Type | Description | Notes|
|
|
394
|
+
|------------- | ------------- | ------------- | -------------|
|
|
395
|
+
| **thumbnailId** | [**string**] | Thumbnail ID | defaults to undefined|
|
|
396
|
+
| **id** | [**number**] | Video ID | defaults to undefined|
|
|
397
|
+
| **video** | [**File**] | Video | defaults to undefined|
|
|
398
|
+
| **customerId** | [**number**] | Customer ID | (optional) defaults to undefined|
|
|
399
|
+
|
|
400
|
+
|
|
401
|
+
### Return type
|
|
402
|
+
|
|
403
|
+
**BrandedVideoSummaryDTO**
|
|
404
|
+
|
|
405
|
+
### Authorization
|
|
406
|
+
|
|
407
|
+
No authorization required
|
|
408
|
+
|
|
409
|
+
### HTTP request headers
|
|
410
|
+
|
|
411
|
+
- **Content-Type**: multipart/form-data
|
|
412
|
+
- **Accept**: application/json
|
|
413
|
+
|
|
414
|
+
|
|
415
|
+
### HTTP response details
|
|
416
|
+
| Status code | Description | Response headers |
|
|
417
|
+
|-------------|-------------|------------------|
|
|
418
|
+
|**200** | Branded Video Summary | - |
|
|
419
|
+
|**400** | Bad Request | - |
|
|
420
|
+
|**401** | Unauthorised | - |
|
|
421
|
+
|**403** | Access Denied | - |
|
|
422
|
+
|
|
423
|
+
[[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)
|
|
424
|
+
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# BrandedVideosSummariesModel
|
|
2
|
+
|
|
3
|
+
Promotions
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**results** | [**Array<BrandedVideoSummaryDTO>**](BrandedVideoSummaryDTO.md) | Results | [optional] [default to undefined]
|
|
10
|
+
**page** | **number** | Page | [optional] [default to undefined]
|
|
11
|
+
**perPage** | **number** | Per Page | [optional] [default to undefined]
|
|
12
|
+
**totalResults** | **number** | Total Results | [optional] [default to undefined]
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { BrandedVideosSummariesModel } from 'yellowgrid-api-ts';
|
|
18
|
+
|
|
19
|
+
const instance: BrandedVideosSummariesModel = {
|
|
20
|
+
results,
|
|
21
|
+
page,
|
|
22
|
+
perPage,
|
|
23
|
+
totalResults,
|
|
24
|
+
};
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
[[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/docs/OAuth20Api.md
CHANGED
|
@@ -158,7 +158,7 @@ const { status, data } = await apiInstance.postAccessToken(
|
|
|
158
158
|
| **clientId** | [**string**] | OAuth 2.0 Client ID | (optional) defaults to undefined|
|
|
159
159
|
| **clientSecret** | [**string**] | OAuth 2.0 Client Secret | (optional) defaults to undefined|
|
|
160
160
|
| **grantType** | [**string**]**Array<'client_credentials' | 'code' | 'refresh_token' | 'authorization_code' | 'ms_auth' | 'token_exchange' | 'password'>** | OAuth 2.0 Grant Type | (optional) defaults to undefined|
|
|
161
|
-
| **scope** | [**string**]**Array<'*' | 'fdps' | 'scope' | 'portal' | 'tcx_wizard' | 'accounts.read' | 'accounts.write' | 'number_porting.read' | 'number_porting.write' | 'pricing.read' | 'orders.read' | 'orders.write' | 'products.read' | 'provisioning.read' | 'provisioning.write' | 'sms.read' | 'sms.write' | 'trunks.read' | 'trunks.write' | 'tcx_integrations.read' | 'tcx_integrations.write' | 'tcx_licence_details.read' | 'tcx_installations.read' | 'tcx_installations.write' | 'tcx_mt.read' | 'tcx_mt.write' | 'tickets.read' | 'tickets.write'>** | OAuth 2.0 Scope | (optional) defaults to undefined|
|
|
161
|
+
| **scope** | [**string**]**Array<'*' | 'fdps' | 'scope' | 'portal' | 'tcx_wizard' | 'accounts.read' | 'accounts.write' | 'branded_videosread' | 'branded_videoswrite' | 'number_porting.read' | 'number_porting.write' | 'pricing.read' | 'orders.read' | 'orders.write' | 'products.read' | 'provisioning.read' | 'provisioning.write' | 'sms.read' | 'sms.write' | 'trunks.read' | 'trunks.write' | 'tcx_integrations.read' | 'tcx_integrations.write' | 'tcx_licence_details.read' | 'tcx_installations.read' | 'tcx_installations.write' | 'tcx_mt.read' | 'tcx_mt.write' | 'tickets.read' | 'tickets.write'>** | OAuth 2.0 Scope | (optional) defaults to undefined|
|
|
162
162
|
| **redirectUri** | [**string**] | OAuth 2.0 Redirect URI | (optional) defaults to undefined|
|
|
163
163
|
| **code** | [**string**] | OAuth 2.0 Auth Code | (optional) defaults to undefined|
|
|
164
164
|
| **refreshToken** | [**string**] | OAuth 2.0 Refresh Token | (optional) defaults to undefined|
|
|
@@ -211,7 +211,7 @@ const apiInstance = new OAuth20Api(configuration);
|
|
|
211
211
|
|
|
212
212
|
let clientId: string; //OAuth 2.0 Client ID (default to undefined)
|
|
213
213
|
let responseType: string; //OAuth 2.0 Response Type (default to 'code')
|
|
214
|
-
let scope: '*' | 'fdps' | 'scope' | 'portal' | 'tcx_wizard' | 'accounts.read' | 'accounts.write' | 'number_porting.read' | 'number_porting.write' | 'pricing.read' | 'orders.read' | 'orders.write' | 'products.read' | 'provisioning.read' | 'provisioning.write' | 'sms.read' | 'sms.write' | 'trunks.read' | 'trunks.write' | 'tcx_integrations.read' | 'tcx_integrations.write' | 'tcx_licence_details.read' | 'tcx_installations.read' | 'tcx_installations.write' | 'tcx_mt.read' | 'tcx_mt.write' | 'tickets.read' | 'tickets.write'; //OAuth 2.0 Scope (default to undefined)
|
|
214
|
+
let scope: '*' | 'fdps' | 'scope' | 'portal' | 'tcx_wizard' | 'accounts.read' | 'accounts.write' | 'branded_videosread' | 'branded_videoswrite' | 'number_porting.read' | 'number_porting.write' | 'pricing.read' | 'orders.read' | 'orders.write' | 'products.read' | 'provisioning.read' | 'provisioning.write' | 'sms.read' | 'sms.write' | 'trunks.read' | 'trunks.write' | 'tcx_integrations.read' | 'tcx_integrations.write' | 'tcx_licence_details.read' | 'tcx_installations.read' | 'tcx_installations.write' | 'tcx_mt.read' | 'tcx_mt.write' | 'tickets.read' | 'tickets.write'; //OAuth 2.0 Scope (default to undefined)
|
|
215
215
|
let redirectUri: string; //OAuth 2.0 Redirect URI (optional) (default to undefined)
|
|
216
216
|
let state: string; //OAuth 2.0 State (optional) (default to undefined)
|
|
217
217
|
let codeChallenge: string; //OAuth 2.0 Code Challenge (optional) (default to undefined)
|
|
@@ -234,7 +234,7 @@ const { status, data } = await apiInstance.postAuthorise(
|
|
|
234
234
|
|------------- | ------------- | ------------- | -------------|
|
|
235
235
|
| **clientId** | [**string**] | OAuth 2.0 Client ID | defaults to undefined|
|
|
236
236
|
| **responseType** | [**string**] | OAuth 2.0 Response Type | defaults to 'code'|
|
|
237
|
-
| **scope** | [**'*' | 'fdps' | 'scope' | 'portal' | 'tcx_wizard' | 'accounts.read' | 'accounts.write' | 'number_porting.read' | 'number_porting.write' | 'pricing.read' | 'orders.read' | 'orders.write' | 'products.read' | 'provisioning.read' | 'provisioning.write' | 'sms.read' | 'sms.write' | 'trunks.read' | 'trunks.write' | 'tcx_integrations.read' | 'tcx_integrations.write' | 'tcx_licence_details.read' | 'tcx_installations.read' | 'tcx_installations.write' | 'tcx_mt.read' | 'tcx_mt.write' | 'tickets.read' | 'tickets.write'**]**Array<'*' | 'fdps' | 'scope' | 'portal' | 'tcx_wizard' | 'accounts.read' | 'accounts.write' | 'number_porting.read' | 'number_porting.write' | 'pricing.read' | 'orders.read' | 'orders.write' | 'products.read' | 'provisioning.read' | 'provisioning.write' | 'sms.read' | 'sms.write' | 'trunks.read' | 'trunks.write' | 'tcx_integrations.read' | 'tcx_integrations.write' | 'tcx_licence_details.read' | 'tcx_installations.read' | 'tcx_installations.write' | 'tcx_mt.read' | 'tcx_mt.write' | 'tickets.read' | 'tickets.write'>** | OAuth 2.0 Scope | defaults to undefined|
|
|
237
|
+
| **scope** | [**'*' | 'fdps' | 'scope' | 'portal' | 'tcx_wizard' | 'accounts.read' | 'accounts.write' | 'branded_videosread' | 'branded_videoswrite' | 'number_porting.read' | 'number_porting.write' | 'pricing.read' | 'orders.read' | 'orders.write' | 'products.read' | 'provisioning.read' | 'provisioning.write' | 'sms.read' | 'sms.write' | 'trunks.read' | 'trunks.write' | 'tcx_integrations.read' | 'tcx_integrations.write' | 'tcx_licence_details.read' | 'tcx_installations.read' | 'tcx_installations.write' | 'tcx_mt.read' | 'tcx_mt.write' | 'tickets.read' | 'tickets.write'**]**Array<'*' | 'fdps' | 'scope' | 'portal' | 'tcx_wizard' | 'accounts.read' | 'accounts.write' | 'branded_videosread' | 'branded_videoswrite' | 'number_porting.read' | 'number_porting.write' | 'pricing.read' | 'orders.read' | 'orders.write' | 'products.read' | 'provisioning.read' | 'provisioning.write' | 'sms.read' | 'sms.write' | 'trunks.read' | 'trunks.write' | 'tcx_integrations.read' | 'tcx_integrations.write' | 'tcx_licence_details.read' | 'tcx_installations.read' | 'tcx_installations.write' | 'tcx_mt.read' | 'tcx_mt.write' | 'tickets.read' | 'tickets.write'>** | OAuth 2.0 Scope | defaults to undefined|
|
|
238
238
|
| **redirectUri** | [**string**] | OAuth 2.0 Redirect URI | (optional) defaults to undefined|
|
|
239
239
|
| **state** | [**string**] | OAuth 2.0 State | (optional) defaults to undefined|
|
|
240
240
|
| **codeChallenge** | [**string**] | OAuth 2.0 Code Challenge | (optional) defaults to undefined|
|
package/docs/PromoCodesEntity.md
CHANGED
|
@@ -9,11 +9,11 @@ Name | Type | Description | Notes
|
|
|
9
9
|
**id** | **number** | id | [optional] [default to undefined]
|
|
10
10
|
**code** | **string** | code | [optional] [default to undefined]
|
|
11
11
|
**description** | **string** | description | [optional] [default to undefined]
|
|
12
|
-
**
|
|
13
|
-
**
|
|
12
|
+
**startDate** | **string** | Date Time | [optional] [default to undefined]
|
|
13
|
+
**endDate** | **string** | Date Time | [optional] [default to undefined]
|
|
14
14
|
**customerLimit** | **number** | customerLimit | [optional] [default to undefined]
|
|
15
15
|
**globalLimit** | **number** | globalLimit | [optional] [default to undefined]
|
|
16
|
-
**orderRestrictions** | **string
|
|
16
|
+
**orderRestrictions** | **Array<string>** | orderRestrictions | [optional] [default to undefined]
|
|
17
17
|
**includeDistribution** | **boolean** | includeDistribution | [optional] [default to undefined]
|
|
18
18
|
**distributionOnly** | **boolean** | distributionOnly | [optional] [default to undefined]
|
|
19
19
|
**nfr** | **boolean** | nfr | [optional] [default to undefined]
|
|
@@ -28,8 +28,8 @@ const instance: PromoCodesEntity = {
|
|
|
28
28
|
id,
|
|
29
29
|
code,
|
|
30
30
|
description,
|
|
31
|
-
|
|
32
|
-
|
|
31
|
+
startDate,
|
|
32
|
+
endDate,
|
|
33
33
|
customerLimit,
|
|
34
34
|
globalLimit,
|
|
35
35
|
orderRestrictions,
|
package/docs/PromoModel.md
CHANGED
|
@@ -9,11 +9,11 @@ Name | Type | Description | Notes
|
|
|
9
9
|
**id** | **number** | id | [optional] [default to undefined]
|
|
10
10
|
**code** | **string** | code | [optional] [default to undefined]
|
|
11
11
|
**description** | **string** | description | [optional] [default to undefined]
|
|
12
|
-
**
|
|
13
|
-
**
|
|
12
|
+
**startDate** | **string** | Date Time | [optional] [default to undefined]
|
|
13
|
+
**endDate** | **string** | Date Time | [optional] [default to undefined]
|
|
14
14
|
**customerLimit** | **number** | customerLimit | [optional] [default to undefined]
|
|
15
15
|
**globalLimit** | **number** | globalLimit | [optional] [default to undefined]
|
|
16
|
-
**orderRestrictions** | **string
|
|
16
|
+
**orderRestrictions** | **Array<string>** | orderRestrictions | [optional] [default to undefined]
|
|
17
17
|
**includeDistribution** | **boolean** | includeDistribution | [optional] [default to undefined]
|
|
18
18
|
**distributionOnly** | **boolean** | distributionOnly | [optional] [default to undefined]
|
|
19
19
|
**nfr** | **boolean** | nfr | [optional] [default to undefined]
|
|
@@ -29,8 +29,8 @@ const instance: PromoModel = {
|
|
|
29
29
|
id,
|
|
30
30
|
code,
|
|
31
31
|
description,
|
|
32
|
-
|
|
33
|
-
|
|
32
|
+
startDate,
|
|
33
|
+
endDate,
|
|
34
34
|
customerLimit,
|
|
35
35
|
globalLimit,
|
|
36
36
|
orderRestrictions,
|
package/docs/PromoSummaryDTO.md
CHANGED
|
@@ -6,6 +6,7 @@ Promo Summary
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**id** | **number** | ID | [optional] [default to undefined]
|
|
9
10
|
**description** | **string** | Description | [optional] [default to undefined]
|
|
10
11
|
**code** | **string** | Promo Code | [optional] [default to undefined]
|
|
11
12
|
**startDate** | **string** | Date Time | [optional] [default to undefined]
|
|
@@ -18,6 +19,7 @@ Name | Type | Description | Notes
|
|
|
18
19
|
import { PromoSummaryDTO } from 'yellowgrid-api-ts';
|
|
19
20
|
|
|
20
21
|
const instance: PromoSummaryDTO = {
|
|
22
|
+
id,
|
|
21
23
|
description,
|
|
22
24
|
code,
|
|
23
25
|
startDate,
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# ThumbnailDTO
|
|
2
|
+
|
|
3
|
+
Thumbnail
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**id** | **string** | ID | [optional] [default to undefined]
|
|
10
|
+
**name** | **string** | Name | [optional] [default to undefined]
|
|
11
|
+
**url** | **string** | URL | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { ThumbnailDTO } from 'yellowgrid-api-ts';
|
|
17
|
+
|
|
18
|
+
const instance: ThumbnailDTO = {
|
|
19
|
+
id,
|
|
20
|
+
name,
|
|
21
|
+
url,
|
|
22
|
+
};
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
[[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,51 @@
|
|
|
1
|
+
# VideoRequestEntity
|
|
2
|
+
|
|
3
|
+
VideoRequestsEntity
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**id** | **number** | id | [optional] [default to undefined]
|
|
10
|
+
**userId** | **number** | userId | [optional] [default to undefined]
|
|
11
|
+
**type** | **string** | type | [optional] [default to undefined]
|
|
12
|
+
**status** | **string** | status | [optional] [default to undefined]
|
|
13
|
+
**video** | **string** | video | [optional] [default to undefined]
|
|
14
|
+
**company** | **string** | company | [optional] [default to undefined]
|
|
15
|
+
**email** | **string** | email | [optional] [default to undefined]
|
|
16
|
+
**website** | **string** | website | [optional] [default to undefined]
|
|
17
|
+
**telephone** | **string** | telephone | [optional] [default to undefined]
|
|
18
|
+
**notes** | **string** | notes | [optional] [default to undefined]
|
|
19
|
+
**requestDate** | **string** | requestDate | [optional] [default to undefined]
|
|
20
|
+
**dueDate** | **string** | dueDate | [optional] [default to undefined]
|
|
21
|
+
**invId** | **string** | invId | [optional] [default to undefined]
|
|
22
|
+
**invNo** | **string** | invNo | [optional] [default to undefined]
|
|
23
|
+
**onedriveId** | **string** | onedriveId | [optional] [default to undefined]
|
|
24
|
+
**thumbnailId** | **string** | thumbnailId | [optional] [default to undefined]
|
|
25
|
+
|
|
26
|
+
## Example
|
|
27
|
+
|
|
28
|
+
```typescript
|
|
29
|
+
import { VideoRequestEntity } from 'yellowgrid-api-ts';
|
|
30
|
+
|
|
31
|
+
const instance: VideoRequestEntity = {
|
|
32
|
+
id,
|
|
33
|
+
userId,
|
|
34
|
+
type,
|
|
35
|
+
status,
|
|
36
|
+
video,
|
|
37
|
+
company,
|
|
38
|
+
email,
|
|
39
|
+
website,
|
|
40
|
+
telephone,
|
|
41
|
+
notes,
|
|
42
|
+
requestDate,
|
|
43
|
+
dueDate,
|
|
44
|
+
invId,
|
|
45
|
+
invNo,
|
|
46
|
+
onedriveId,
|
|
47
|
+
thumbnailId,
|
|
48
|
+
};
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|