yellowgrid-api-ts 3.2.178 → 3.2.180-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 +302 -294
- package/.openapi-generator/VERSION +1 -1
- package/README.md +17 -3
- package/api.ts +6266 -605
- package/base.ts +26 -2
- package/common.ts +39 -16
- package/config.json +3 -3
- package/configuration.ts +21 -27
- package/dist/api.d.ts +5341 -96
- package/dist/api.js +1322 -468
- package/dist/base.d.ts +25 -1
- package/dist/base.js +21 -2
- package/dist/common.d.ts +36 -5
- package/dist/common.js +39 -17
- package/dist/configuration.d.ts +18 -25
- package/dist/configuration.js +4 -4
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/dist/models/GroupEnum.d.ts +43 -0
- package/dist/models/GroupEnum.js +45 -0
- package/dist/models/HostingPriceListEnum.d.ts +5 -0
- package/dist/models/HostingPriceListEnum.js +5 -0
- package/docs/AbstractItemDiscountModel.md +21 -0
- package/docs/AbstractOrderRequestDTO.md +1 -1
- package/docs/AccountsApi.md +60 -1
- package/docs/AdminOrderRequestDTO.md +1 -1
- package/docs/BillingApi.md +1 -1
- package/docs/CRMApi.md +1 -1
- package/docs/Class3CXApi.md +51 -3
- package/docs/Class3CXInstallationWizardApi.md +1 -1
- package/docs/Class3CXInstallationsApi.md +1 -1
- package/docs/Class3CXIntegrationsApi.md +1 -1
- package/docs/Class3CXMultiTenantApi.md +1 -1
- package/docs/CrmActivityDTO.md +1 -1
- package/docs/CrmDateActivitiesDTO.md +1 -1
- package/docs/CustomerOrderRequestDTO.md +1 -1
- package/docs/DetailedOrderRequestDTO.md +1 -1
- package/docs/ExpiringKeyDTO.md +29 -0
- package/docs/GetCheckMacExists200Response.md +20 -0
- package/docs/MacAddressDTO.md +23 -0
- package/docs/MyPBXToolsApi.md +1 -1
- package/docs/NumberPortModel.md +51 -0
- package/docs/NumberPortingApi.md +1 -1
- package/docs/OAuth20Api.md +1 -1
- package/docs/OpayoRedirectDTO.md +29 -0
- package/docs/OrdersApi.md +5 -2
- package/docs/PartnerDTO.md +1 -1
- package/docs/PatchSetTcxWizardCnameRequest.md +20 -0
- package/docs/PatchUpdateAccountNameRequest.md +20 -0
- package/docs/PostAddAdminNoteRequest.md +20 -0
- package/docs/PostGetProductRequest.md +24 -0
- package/docs/PricingApi.md +1 -1
- package/docs/ProductDetailedSummaryDTO.md +41 -0
- package/docs/ProductSearchDTO.md +37 -0
- package/docs/ProductSummaryDTO.md +1 -3
- package/docs/ProductsApi.md +13 -7
- package/docs/ProspectDTO.md +2 -2
- package/docs/ProspectsApi.md +1 -1
- package/docs/ProvisioningApi.md +167 -1
- package/docs/RecordingsBackupInfoDTO.md +2 -2
- package/docs/SIPTrunksApi.md +1 -1
- package/docs/SMSApi.md +1 -1
- package/docs/ServicesApi.md +1 -1
- package/docs/ShipmentRequestDTO.md +2 -2
- package/docs/ShippingApi.md +1 -1
- package/docs/StockManagementApi.md +1 -1
- package/docs/SupplierItemModel.md +2 -0
- package/docs/SupplierItemsResultsDTO.md +21 -0
- package/docs/SupplierProductModel.md +25 -0
- package/docs/SupplierProductResultsModel.md +21 -0
- package/docs/SuppliersApi.md +68 -0
- package/docs/SystemApi.md +1 -1
- package/docs/TcxInstallationDetailsModel.md +45 -0
- package/docs/TcxInstallationModel.md +4 -0
- package/docs/TcxKeySummaryDTO.md +1 -1
- package/docs/TelephonySupportTicketModel.md +41 -0
- package/docs/TicketsApi.md +1 -1
- package/docs/WebhooksApi.md +1 -1
- package/getEnums.php +31 -31
- package/hs_err_pid16044.log +249 -0
- package/hs_err_pid44560.log +249 -0
- package/hs_err_pid53988.log +249 -0
- package/hs_err_pid58728.log +40 -0
- package/index.ts +1 -1
- package/models/GroupEnum.ts +44 -0
- package/models/HostingPriceListEnum.ts +5 -0
- package/openapitools.json +1 -1
- package/package.json +2 -2
|
@@ -10,11 +10,10 @@ Name | Type | Description | Notes
|
|
|
10
10
|
**title** | **string** | Title | [optional] [default to undefined]
|
|
11
11
|
**quantity** | **number** | Stock Quantity | [optional] [default to undefined]
|
|
12
12
|
**stockProduct** | **boolean** | Stock Product | [optional] [default to undefined]
|
|
13
|
-
**dueDate** | **string** | Due Date | [optional] [default to undefined]
|
|
14
13
|
**price** | **number** | Price | [optional] [default to undefined]
|
|
15
14
|
**cartonSize** | **number** | Carton Size | [optional] [default to undefined]
|
|
16
15
|
**rrp** | **number** | RRP Price | [optional] [default to undefined]
|
|
17
|
-
**licenceDetails** | [**TcxLicenceDetailsModel**](TcxLicenceDetailsModel.md) |
|
|
16
|
+
**licenceDetails** | [**TcxLicenceDetailsModel**](TcxLicenceDetailsModel.md) | | [optional] [default to undefined]
|
|
18
17
|
**hosting** | **boolean** | 3CX Hosting | [optional] [default to undefined]
|
|
19
18
|
|
|
20
19
|
## Example
|
|
@@ -27,7 +26,6 @@ const instance: ProductSummaryDTO = {
|
|
|
27
26
|
title,
|
|
28
27
|
quantity,
|
|
29
28
|
stockProduct,
|
|
30
|
-
dueDate,
|
|
31
29
|
price,
|
|
32
30
|
cartonSize,
|
|
33
31
|
rrp,
|
package/docs/ProductsApi.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# ProductsApi
|
|
2
2
|
|
|
3
|
-
All URIs are relative to *https://
|
|
3
|
+
All URIs are relative to *https://api.local.yellowgrid.co.uk*
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
@@ -422,7 +422,7 @@ No authorization required
|
|
|
422
422
|
[[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)
|
|
423
423
|
|
|
424
424
|
# **postGetProduct**
|
|
425
|
-
>
|
|
425
|
+
> ProductDetailedSummaryDTO postGetProduct(postGetProductForCustomerRequest)
|
|
426
426
|
|
|
427
427
|
Get Product
|
|
428
428
|
|
|
@@ -440,10 +440,12 @@ const apiInstance = new ProductsApi(configuration);
|
|
|
440
440
|
|
|
441
441
|
let sku: string; //Product SKU (default to undefined)
|
|
442
442
|
let postGetProductForCustomerRequest: PostGetProductForCustomerRequest; //Product search criteria
|
|
443
|
+
let orderId: number; //Order ID (optional) (default to undefined)
|
|
443
444
|
|
|
444
445
|
const { status, data } = await apiInstance.postGetProduct(
|
|
445
446
|
sku,
|
|
446
|
-
postGetProductForCustomerRequest
|
|
447
|
+
postGetProductForCustomerRequest,
|
|
448
|
+
orderId
|
|
447
449
|
);
|
|
448
450
|
```
|
|
449
451
|
|
|
@@ -453,11 +455,12 @@ const { status, data } = await apiInstance.postGetProduct(
|
|
|
453
455
|
|------------- | ------------- | ------------- | -------------|
|
|
454
456
|
| **postGetProductForCustomerRequest** | **PostGetProductForCustomerRequest**| Product search criteria | |
|
|
455
457
|
| **sku** | [**string**] | Product SKU | defaults to undefined|
|
|
458
|
+
| **orderId** | [**number**] | Order ID | (optional) defaults to undefined|
|
|
456
459
|
|
|
457
460
|
|
|
458
461
|
### Return type
|
|
459
462
|
|
|
460
|
-
**
|
|
463
|
+
**ProductDetailedSummaryDTO**
|
|
461
464
|
|
|
462
465
|
### Authorization
|
|
463
466
|
|
|
@@ -480,7 +483,7 @@ No authorization required
|
|
|
480
483
|
[[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)
|
|
481
484
|
|
|
482
485
|
# **postGetProductForCustomer**
|
|
483
|
-
>
|
|
486
|
+
> ProductDetailedSummaryDTO postGetProductForCustomer(postGetProductForCustomerRequest)
|
|
484
487
|
|
|
485
488
|
Get Product For Customer
|
|
486
489
|
|
|
@@ -499,11 +502,13 @@ const apiInstance = new ProductsApi(configuration);
|
|
|
499
502
|
let customerId: number; //Customer ID (default to undefined)
|
|
500
503
|
let sku: string; //Product SKU (default to undefined)
|
|
501
504
|
let postGetProductForCustomerRequest: PostGetProductForCustomerRequest; //Product search criteria
|
|
505
|
+
let orderId: number; //Order ID (optional) (default to undefined)
|
|
502
506
|
|
|
503
507
|
const { status, data } = await apiInstance.postGetProductForCustomer(
|
|
504
508
|
customerId,
|
|
505
509
|
sku,
|
|
506
|
-
postGetProductForCustomerRequest
|
|
510
|
+
postGetProductForCustomerRequest,
|
|
511
|
+
orderId
|
|
507
512
|
);
|
|
508
513
|
```
|
|
509
514
|
|
|
@@ -514,11 +519,12 @@ const { status, data } = await apiInstance.postGetProductForCustomer(
|
|
|
514
519
|
| **postGetProductForCustomerRequest** | **PostGetProductForCustomerRequest**| Product search criteria | |
|
|
515
520
|
| **customerId** | [**number**] | Customer ID | defaults to undefined|
|
|
516
521
|
| **sku** | [**string**] | Product SKU | defaults to undefined|
|
|
522
|
+
| **orderId** | [**number**] | Order ID | (optional) defaults to undefined|
|
|
517
523
|
|
|
518
524
|
|
|
519
525
|
### Return type
|
|
520
526
|
|
|
521
|
-
**
|
|
527
|
+
**ProductDetailedSummaryDTO**
|
|
522
528
|
|
|
523
529
|
### Authorization
|
|
524
530
|
|
package/docs/ProspectDTO.md
CHANGED
|
@@ -8,8 +8,8 @@ Name | Type | Description | Notes
|
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
9
|
**companyName** | **string** | Company Name | [optional] [default to undefined]
|
|
10
10
|
**telephone** | **string** | Telephone | [optional] [default to undefined]
|
|
11
|
-
**lastOrderDate** | **string** |
|
|
12
|
-
**callbackDate** | **string** |
|
|
11
|
+
**lastOrderDate** | **string** | Date Time | [optional] [default to undefined]
|
|
12
|
+
**callbackDate** | **string** | Date Time | [optional] [default to undefined]
|
|
13
13
|
**xeroId** | **string** | Xero ID | [optional] [default to undefined]
|
|
14
14
|
**removed** | **boolean** | Removed From Prospects | [optional] [default to undefined]
|
|
15
15
|
**status** | **string** | Status | [optional] [default to undefined]
|
package/docs/ProspectsApi.md
CHANGED
package/docs/ProvisioningApi.md
CHANGED
|
@@ -1,16 +1,19 @@
|
|
|
1
1
|
# ProvisioningApi
|
|
2
2
|
|
|
3
|
-
All URIs are relative to *https://
|
|
3
|
+
All URIs are relative to *https://api.local.yellowgrid.co.uk*
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
7
|
|[**deleteAddFanvilMac**](#deleteaddfanvilmac) | **DELETE** /provisioning/fanvil/groups/{id}/macs/{mac} | Remove MAC address from DB and FDPS group|
|
|
8
|
+
|[**deleteCheckMacExists**](#deletecheckmacexists) | **DELETE** /admin/provisioning/fanvil/macs/{mac} | |
|
|
8
9
|
|[**deleteDeleteFanvilGroup**](#deletedeletefanvilgroup) | **DELETE** /provisioning/fanvil/groups/{id} | Delete group from DB and FDPS|
|
|
10
|
+
|[**getCheckMacExists**](#getcheckmacexists) | **GET** /admin/provisioning/fanvil/macs/{mac} | |
|
|
9
11
|
|[**getGetFanvilEncryptionKey**](#getgetfanvilencryptionkey) | **GET** /provisioning/fanvil/groups/{id}/macs/{mac}/key | Get group Fanvil encryption key|
|
|
10
12
|
|[**getGetFanvilGroupMacs**](#getgetfanvilgroupmacs) | **GET** /provisioning/fanvil/groups/{id}/macs | Get MAC addresses on group at FDPS|
|
|
11
13
|
|[**getGetGroups**](#getgetgroups) | **GET** /provisioning/groups | Get all provisioning groups or filter by customer ID|
|
|
12
14
|
|[**postAddFanvilGroup**](#postaddfanvilgroup) | **POST** /provisioning/fanvil/groups | Add group to DB and FDPS|
|
|
13
15
|
|[**postAddFanvilMac**](#postaddfanvilmac) | **POST** /provisioning/fanvil/groups/{id}/macs/{mac} | Add MAC address to DB and FDPS group|
|
|
16
|
+
|[**postCreateMac**](#postcreatemac) | **POST** /admin/provisioning/fanvil/macs | |
|
|
14
17
|
|
|
15
18
|
# **deleteAddFanvilMac**
|
|
16
19
|
> deleteAddFanvilMac()
|
|
@@ -69,6 +72,60 @@ No authorization required
|
|
|
69
72
|
|
|
70
73
|
[[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
74
|
|
|
75
|
+
# **deleteCheckMacExists**
|
|
76
|
+
> deleteCheckMacExists()
|
|
77
|
+
|
|
78
|
+
Delete a MAC address in FDPS
|
|
79
|
+
|
|
80
|
+
### Example
|
|
81
|
+
|
|
82
|
+
```typescript
|
|
83
|
+
import {
|
|
84
|
+
ProvisioningApi,
|
|
85
|
+
Configuration
|
|
86
|
+
} from 'yellowgrid-api-ts';
|
|
87
|
+
|
|
88
|
+
const configuration = new Configuration();
|
|
89
|
+
const apiInstance = new ProvisioningApi(configuration);
|
|
90
|
+
|
|
91
|
+
let mac: string; //MAC Address (default to undefined)
|
|
92
|
+
|
|
93
|
+
const { status, data } = await apiInstance.deleteCheckMacExists(
|
|
94
|
+
mac
|
|
95
|
+
);
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
### Parameters
|
|
99
|
+
|
|
100
|
+
|Name | Type | Description | Notes|
|
|
101
|
+
|------------- | ------------- | ------------- | -------------|
|
|
102
|
+
| **mac** | [**string**] | MAC Address | defaults to undefined|
|
|
103
|
+
|
|
104
|
+
|
|
105
|
+
### Return type
|
|
106
|
+
|
|
107
|
+
void (empty response body)
|
|
108
|
+
|
|
109
|
+
### Authorization
|
|
110
|
+
|
|
111
|
+
No authorization required
|
|
112
|
+
|
|
113
|
+
### HTTP request headers
|
|
114
|
+
|
|
115
|
+
- **Content-Type**: Not defined
|
|
116
|
+
- **Accept**: Not defined
|
|
117
|
+
|
|
118
|
+
|
|
119
|
+
### HTTP response details
|
|
120
|
+
| Status code | Description | Response headers |
|
|
121
|
+
|-------------|-------------|------------------|
|
|
122
|
+
|**204** | No Response | - |
|
|
123
|
+
|**400** | Bad Request | - |
|
|
124
|
+
|**401** | Unauthorised | - |
|
|
125
|
+
|**403** | Access Denied | - |
|
|
126
|
+
|
|
127
|
+
[[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)
|
|
128
|
+
|
|
72
129
|
# **deleteDeleteFanvilGroup**
|
|
73
130
|
> deleteDeleteFanvilGroup()
|
|
74
131
|
|
|
@@ -123,6 +180,60 @@ No authorization required
|
|
|
123
180
|
|
|
124
181
|
[[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
182
|
|
|
183
|
+
# **getCheckMacExists**
|
|
184
|
+
> GetCheckMacExists200Response getCheckMacExists()
|
|
185
|
+
|
|
186
|
+
Check if a MAC address exists in FDPS
|
|
187
|
+
|
|
188
|
+
### Example
|
|
189
|
+
|
|
190
|
+
```typescript
|
|
191
|
+
import {
|
|
192
|
+
ProvisioningApi,
|
|
193
|
+
Configuration
|
|
194
|
+
} from 'yellowgrid-api-ts';
|
|
195
|
+
|
|
196
|
+
const configuration = new Configuration();
|
|
197
|
+
const apiInstance = new ProvisioningApi(configuration);
|
|
198
|
+
|
|
199
|
+
let mac: string; //MAC Address (default to undefined)
|
|
200
|
+
|
|
201
|
+
const { status, data } = await apiInstance.getCheckMacExists(
|
|
202
|
+
mac
|
|
203
|
+
);
|
|
204
|
+
```
|
|
205
|
+
|
|
206
|
+
### Parameters
|
|
207
|
+
|
|
208
|
+
|Name | Type | Description | Notes|
|
|
209
|
+
|------------- | ------------- | ------------- | -------------|
|
|
210
|
+
| **mac** | [**string**] | MAC Address | defaults to undefined|
|
|
211
|
+
|
|
212
|
+
|
|
213
|
+
### Return type
|
|
214
|
+
|
|
215
|
+
**GetCheckMacExists200Response**
|
|
216
|
+
|
|
217
|
+
### Authorization
|
|
218
|
+
|
|
219
|
+
No authorization required
|
|
220
|
+
|
|
221
|
+
### HTTP request headers
|
|
222
|
+
|
|
223
|
+
- **Content-Type**: Not defined
|
|
224
|
+
- **Accept**: application/json
|
|
225
|
+
|
|
226
|
+
|
|
227
|
+
### HTTP response details
|
|
228
|
+
| Status code | Description | Response headers |
|
|
229
|
+
|-------------|-------------|------------------|
|
|
230
|
+
|**200** | MAC Address Found | - |
|
|
231
|
+
|**400** | Bad Request | - |
|
|
232
|
+
|**401** | Unauthorised | - |
|
|
233
|
+
|**403** | Access Denied | - |
|
|
234
|
+
|
|
235
|
+
[[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)
|
|
236
|
+
|
|
126
237
|
# **getGetFanvilEncryptionKey**
|
|
127
238
|
> string getGetFanvilEncryptionKey()
|
|
128
239
|
|
|
@@ -400,3 +511,58 @@ No authorization required
|
|
|
400
511
|
|
|
401
512
|
[[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)
|
|
402
513
|
|
|
514
|
+
# **postCreateMac**
|
|
515
|
+
> MacAddressDTO postCreateMac()
|
|
516
|
+
|
|
517
|
+
Create a MAC address in FDPS
|
|
518
|
+
|
|
519
|
+
### Example
|
|
520
|
+
|
|
521
|
+
```typescript
|
|
522
|
+
import {
|
|
523
|
+
ProvisioningApi,
|
|
524
|
+
Configuration,
|
|
525
|
+
MacAddressDTO
|
|
526
|
+
} from 'yellowgrid-api-ts';
|
|
527
|
+
|
|
528
|
+
const configuration = new Configuration();
|
|
529
|
+
const apiInstance = new ProvisioningApi(configuration);
|
|
530
|
+
|
|
531
|
+
let macAddressDTO: MacAddressDTO; //Mac Address (optional)
|
|
532
|
+
|
|
533
|
+
const { status, data } = await apiInstance.postCreateMac(
|
|
534
|
+
macAddressDTO
|
|
535
|
+
);
|
|
536
|
+
```
|
|
537
|
+
|
|
538
|
+
### Parameters
|
|
539
|
+
|
|
540
|
+
|Name | Type | Description | Notes|
|
|
541
|
+
|------------- | ------------- | ------------- | -------------|
|
|
542
|
+
| **macAddressDTO** | **MacAddressDTO**| Mac Address | |
|
|
543
|
+
|
|
544
|
+
|
|
545
|
+
### Return type
|
|
546
|
+
|
|
547
|
+
**MacAddressDTO**
|
|
548
|
+
|
|
549
|
+
### Authorization
|
|
550
|
+
|
|
551
|
+
No authorization required
|
|
552
|
+
|
|
553
|
+
### HTTP request headers
|
|
554
|
+
|
|
555
|
+
- **Content-Type**: application/json
|
|
556
|
+
- **Accept**: application/json
|
|
557
|
+
|
|
558
|
+
|
|
559
|
+
### HTTP response details
|
|
560
|
+
| Status code | Description | Response headers |
|
|
561
|
+
|-------------|-------------|------------------|
|
|
562
|
+
|**201** | MAC Address Created | - |
|
|
563
|
+
|**400** | Bad Request | - |
|
|
564
|
+
|**401** | Unauthorised | - |
|
|
565
|
+
|**403** | Access Denied | - |
|
|
566
|
+
|
|
567
|
+
[[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)
|
|
568
|
+
|
|
@@ -6,8 +6,8 @@ Recordings Backup Info
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**backup** | [**RecordingBackupAzureModel**](RecordingBackupAzureModel.md) |
|
|
10
|
-
**storage** | [**TcxRemoteStorageModel**](TcxRemoteStorageModel.md) |
|
|
9
|
+
**backup** | [**RecordingBackupAzureModel**](RecordingBackupAzureModel.md) | | [optional] [default to undefined]
|
|
10
|
+
**storage** | [**TcxRemoteStorageModel**](TcxRemoteStorageModel.md) | | [optional] [default to undefined]
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|
package/docs/SIPTrunksApi.md
CHANGED
package/docs/SMSApi.md
CHANGED
package/docs/ServicesApi.md
CHANGED
|
@@ -7,10 +7,10 @@ Shipment Request
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
9
|
**courier** | **string** | Courier | [optional] [default to undefined]
|
|
10
|
-
**address** | [**AddressModel**](AddressModel.md) |
|
|
10
|
+
**address** | [**AddressModel**](AddressModel.md) | | [optional] [default to undefined]
|
|
11
11
|
**scannedLines** | **Array<string>** | Scanned Lines | [optional] [default to undefined]
|
|
12
12
|
**service** | **string** | Service | [optional] [default to undefined]
|
|
13
|
-
**shipDate** | **string** |
|
|
13
|
+
**shipDate** | **string** | Date Time | [optional] [default to undefined]
|
|
14
14
|
**items** | [**Array<ShipmentItemDTO>**](ShipmentItemDTO.md) | Items | [optional] [default to undefined]
|
|
15
15
|
|
|
16
16
|
## Example
|
package/docs/ShippingApi.md
CHANGED
|
@@ -14,6 +14,7 @@ Name | Type | Description | Notes
|
|
|
14
14
|
**itemPrice** | **number** | itemPrice | [optional] [default to undefined]
|
|
15
15
|
**itemType** | **number** | itemType | [optional] [default to undefined]
|
|
16
16
|
**supplierSku** | **string** | supplierSku | [optional] [default to undefined]
|
|
17
|
+
**supplier** | [**SupplierModel**](SupplierModel.md) | | [optional] [default to undefined]
|
|
17
18
|
|
|
18
19
|
## Example
|
|
19
20
|
|
|
@@ -29,6 +30,7 @@ const instance: SupplierItemModel = {
|
|
|
29
30
|
itemPrice,
|
|
30
31
|
itemType,
|
|
31
32
|
supplierSku,
|
|
33
|
+
supplier,
|
|
32
34
|
};
|
|
33
35
|
```
|
|
34
36
|
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# SupplierItemsResultsDTO
|
|
2
|
+
|
|
3
|
+
Supplier Item Results
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**results** | [**Array<SupplierItemModel>**](SupplierItemModel.md) | Results | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { SupplierItemsResultsDTO } from 'yellowgrid-api-ts';
|
|
15
|
+
|
|
16
|
+
const instance: SupplierItemsResultsDTO = {
|
|
17
|
+
results,
|
|
18
|
+
};
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
[[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,25 @@
|
|
|
1
|
+
# SupplierProductModel
|
|
2
|
+
|
|
3
|
+
Supplier Product
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**sku** | **string** | SKU | [optional] [default to undefined]
|
|
10
|
+
**description** | **string** | Description | [optional] [default to undefined]
|
|
11
|
+
**items** | [**Array<SupplierItemModel>**](SupplierItemModel.md) | Items | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { SupplierProductModel } from 'yellowgrid-api-ts';
|
|
17
|
+
|
|
18
|
+
const instance: SupplierProductModel = {
|
|
19
|
+
sku,
|
|
20
|
+
description,
|
|
21
|
+
items,
|
|
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,21 @@
|
|
|
1
|
+
# SupplierProductResultsModel
|
|
2
|
+
|
|
3
|
+
Supplier Product Results
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**results** | [**Array<SupplierProductModel>**](SupplierProductModel.md) | Results | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { SupplierProductResultsModel } from 'yellowgrid-api-ts';
|
|
15
|
+
|
|
16
|
+
const instance: SupplierProductResultsModel = {
|
|
17
|
+
results,
|
|
18
|
+
};
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
[[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,68 @@
|
|
|
1
|
+
# SuppliersApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.local.yellowgrid.co.uk*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**getGetSupplierItems**](#getgetsupplieritems) | **GET** /suppliers | Get Supplier Items|
|
|
8
|
+
|
|
9
|
+
# **getGetSupplierItems**
|
|
10
|
+
> SupplierProductResultsModel getGetSupplierItems()
|
|
11
|
+
|
|
12
|
+
Get Stock Orders
|
|
13
|
+
|
|
14
|
+
### Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import {
|
|
18
|
+
SuppliersApi,
|
|
19
|
+
Configuration
|
|
20
|
+
} from 'yellowgrid-api-ts';
|
|
21
|
+
|
|
22
|
+
const configuration = new Configuration();
|
|
23
|
+
const apiInstance = new SuppliersApi(configuration);
|
|
24
|
+
|
|
25
|
+
let pageSize: number; //Number Of Results (optional) (default to 20)
|
|
26
|
+
let page: number; //Page Number (optional) (default to 1)
|
|
27
|
+
let search: string; //Search (optional) (default to undefined)
|
|
28
|
+
|
|
29
|
+
const { status, data } = await apiInstance.getGetSupplierItems(
|
|
30
|
+
pageSize,
|
|
31
|
+
page,
|
|
32
|
+
search
|
|
33
|
+
);
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
### Parameters
|
|
37
|
+
|
|
38
|
+
|Name | Type | Description | Notes|
|
|
39
|
+
|------------- | ------------- | ------------- | -------------|
|
|
40
|
+
| **pageSize** | [**number**] | Number Of Results | (optional) defaults to 20|
|
|
41
|
+
| **page** | [**number**] | Page Number | (optional) defaults to 1|
|
|
42
|
+
| **search** | [**string**] | Search | (optional) defaults to undefined|
|
|
43
|
+
|
|
44
|
+
|
|
45
|
+
### Return type
|
|
46
|
+
|
|
47
|
+
**SupplierProductResultsModel**
|
|
48
|
+
|
|
49
|
+
### Authorization
|
|
50
|
+
|
|
51
|
+
No authorization required
|
|
52
|
+
|
|
53
|
+
### HTTP request headers
|
|
54
|
+
|
|
55
|
+
- **Content-Type**: Not defined
|
|
56
|
+
- **Accept**: application/json
|
|
57
|
+
|
|
58
|
+
|
|
59
|
+
### HTTP response details
|
|
60
|
+
| Status code | Description | Response headers |
|
|
61
|
+
|-------------|-------------|------------------|
|
|
62
|
+
|**200** | Supplier Items | - |
|
|
63
|
+
|**400** | Bad Request | - |
|
|
64
|
+
|**401** | Unauthorised | - |
|
|
65
|
+
|**403** | Access Denied | - |
|
|
66
|
+
|
|
67
|
+
[[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)
|
|
68
|
+
|
package/docs/SystemApi.md
CHANGED
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
# TcxInstallationDetailsModel
|
|
2
|
+
|
|
3
|
+
3CX Installation Details
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**ipAddress** | **string** | PBX IP Address | [optional] [default to undefined]
|
|
10
|
+
**instanceId** | **string** | Instance ID | [optional] [default to undefined]
|
|
11
|
+
**project** | **string** | Project ID | [optional] [default to undefined]
|
|
12
|
+
**privateKey** | [**GenericFileModel**](GenericFileModel.md) | | [optional] [default to undefined]
|
|
13
|
+
**rootPassword** | **string** | Root Password | [optional] [default to undefined]
|
|
14
|
+
**ownerExtension** | [**TcxUsersEntity**](TcxUsersEntity.md) | | [optional] [default to undefined]
|
|
15
|
+
**adminEmail** | **string** | Admin Email | [optional] [default to undefined]
|
|
16
|
+
**url** | **string** | Console URL | [optional] [default to undefined]
|
|
17
|
+
**adminUsername** | **string** | Admin Username | [optional] [default to undefined]
|
|
18
|
+
**adminPassword** | **string** | Admin Password | [optional] [default to undefined]
|
|
19
|
+
**ftpHost** | **string** | Config Backup FTP Host | [optional] [default to undefined]
|
|
20
|
+
**ftpUsername** | **string** | Config Backup FTP Username | [optional] [default to undefined]
|
|
21
|
+
**ftpPassword** | **string** | Config Backup FTP Password | [optional] [default to undefined]
|
|
22
|
+
|
|
23
|
+
## Example
|
|
24
|
+
|
|
25
|
+
```typescript
|
|
26
|
+
import { TcxInstallationDetailsModel } from 'yellowgrid-api-ts';
|
|
27
|
+
|
|
28
|
+
const instance: TcxInstallationDetailsModel = {
|
|
29
|
+
ipAddress,
|
|
30
|
+
instanceId,
|
|
31
|
+
project,
|
|
32
|
+
privateKey,
|
|
33
|
+
rootPassword,
|
|
34
|
+
ownerExtension,
|
|
35
|
+
adminEmail,
|
|
36
|
+
url,
|
|
37
|
+
adminUsername,
|
|
38
|
+
adminPassword,
|
|
39
|
+
ftpHost,
|
|
40
|
+
ftpUsername,
|
|
41
|
+
ftpPassword,
|
|
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)
|
|
@@ -35,6 +35,8 @@ Name | Type | Description | Notes
|
|
|
35
35
|
**disk** | **number** | Recordings Disk Size | [optional] [default to undefined]
|
|
36
36
|
**flavour** | **string** | Instance Spec | [optional] [default to undefined]
|
|
37
37
|
**autoFailover** | **boolean** | Auto Failover | [optional] [default to undefined]
|
|
38
|
+
**extensions** | **number** | Extensions in Use | [optional] [default to undefined]
|
|
39
|
+
**maxExtensions** | **number** | Max Allowed Extensions | [optional] [default to undefined]
|
|
38
40
|
|
|
39
41
|
## Example
|
|
40
42
|
|
|
@@ -71,6 +73,8 @@ const instance: TcxInstallationModel = {
|
|
|
71
73
|
disk,
|
|
72
74
|
flavour,
|
|
73
75
|
autoFailover,
|
|
76
|
+
extensions,
|
|
77
|
+
maxExtensions,
|
|
74
78
|
};
|
|
75
79
|
```
|
|
76
80
|
|
package/docs/TcxKeySummaryDTO.md
CHANGED
|
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
|
|
|
10
10
|
**endUser** | **string** | End User | [optional] [default to undefined]
|
|
11
11
|
**sc** | **number** | Simultaneous Calls | [optional] [default to undefined]
|
|
12
12
|
**edition** | **string** | Edition | [optional] [default to undefined]
|
|
13
|
-
**expiry** | **string** |
|
|
13
|
+
**expiry** | **string** | Date Time | [optional] [default to undefined]
|
|
14
14
|
|
|
15
15
|
## Example
|
|
16
16
|
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
# TelephonySupportTicketModel
|
|
2
|
+
|
|
3
|
+
Telephony Support Ticket
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**id** | **number** | Ticket ID | [optional] [default to undefined]
|
|
10
|
+
**status** | **string** | Ticket status | [optional] [default to undefined]
|
|
11
|
+
**statusId** | **number** | Ticket status ID | [optional] [default to undefined]
|
|
12
|
+
**subject** | **string** | Ticket subject | [optional] [default to undefined]
|
|
13
|
+
**supportEmail** | **string** | Support email address | [optional] [default to undefined]
|
|
14
|
+
**toEmails** | **Array<string>** | Recipient emails | [optional] [default to undefined]
|
|
15
|
+
**description** | **string** | Ticket description (HTML) | [optional] [default to undefined]
|
|
16
|
+
**descriptionText** | **string** | Ticket description (plain text) | [optional] [default to undefined]
|
|
17
|
+
**createdAt** | **string** | Creation timestamp | [optional] [default to undefined]
|
|
18
|
+
**attachments** | [**Array<AttachmentModel>**](AttachmentModel.md) | Attachments | [optional] [default to undefined]
|
|
19
|
+
**conversations** | [**Array<ConversationModel>**](ConversationModel.md) | Conversations | [optional] [default to undefined]
|
|
20
|
+
|
|
21
|
+
## Example
|
|
22
|
+
|
|
23
|
+
```typescript
|
|
24
|
+
import { TelephonySupportTicketModel } from 'yellowgrid-api-ts';
|
|
25
|
+
|
|
26
|
+
const instance: TelephonySupportTicketModel = {
|
|
27
|
+
id,
|
|
28
|
+
status,
|
|
29
|
+
statusId,
|
|
30
|
+
subject,
|
|
31
|
+
supportEmail,
|
|
32
|
+
toEmails,
|
|
33
|
+
description,
|
|
34
|
+
descriptionText,
|
|
35
|
+
createdAt,
|
|
36
|
+
attachments,
|
|
37
|
+
conversations,
|
|
38
|
+
};
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|