yellowgrid-api-ts 3.2.93-dev.0 → 3.2.93
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 +264 -260
- package/.openapi-generator/VERSION +1 -1
- package/README.md +16 -2
- package/api.ts +1291 -4881
- package/base.ts +2 -26
- package/common.ts +16 -39
- package/config.json +3 -3
- package/configuration.ts +25 -19
- package/dist/api.d.ts +519 -4410
- package/dist/api.js +1254 -541
- package/dist/base.d.ts +1 -25
- package/dist/base.js +2 -21
- package/dist/common.d.ts +5 -36
- package/dist/common.js +17 -39
- package/dist/configuration.d.ts +25 -18
- package/dist/configuration.js +2 -2
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/dist/models/PortStatusEnum.d.ts +5 -0
- package/dist/models/PortStatusEnum.js +5 -0
- package/docs/AccountsApi.md +1 -1
- package/docs/AdminNumberPortDTO.md +4 -0
- package/docs/CRMApi.md +1 -1
- package/docs/Class3CXApi.md +1 -1
- package/docs/Class3CXInstallationWizardApi.md +1 -1
- package/docs/Class3CXInstallationsApi.md +289 -5
- package/docs/Class3CXIntegrationsApi.md +1 -1
- package/docs/Class3CXMultiTenantApi.md +1 -1
- package/docs/InstallationDetailsDTO.md +39 -0
- package/docs/MyPBXToolsApi.md +1 -1
- package/docs/NumberPortingApi.md +61 -6
- package/docs/OAuth20Api.md +1 -1
- package/docs/OrderDetailsDTO.md +2 -0
- package/docs/OrdersApi.md +242 -2
- package/docs/PostAddAdminNoteRequest.md +20 -0
- package/docs/PricingApi.md +1 -1
- package/docs/ProductSummaryDTO.md +2 -0
- package/docs/ProductsApi.md +59 -1
- package/docs/ProvisioningApi.md +1 -1
- package/docs/RemoteStorageDTO.md +27 -0
- package/docs/SIPTrunksApi.md +1 -1
- package/docs/SMSApi.md +1 -1
- package/docs/ServicesApi.md +1 -1
- package/docs/ShippingApi.md +1 -1
- package/docs/StockManagementApi.md +1 -1
- package/docs/SystemApi.md +1 -1
- package/docs/TcxSbcDTO.md +4 -0
- package/docs/TcxSbcResponseDTO.md +23 -0
- package/docs/TicketsApi.md +1 -1
- package/docs/WebhooksApi.md +1 -1
- package/getEnums.php +31 -31
- package/index.ts +1 -1
- package/models/PortStatusEnum.ts +5 -0
- package/openapitools.json +1 -1
- package/package.json +2 -2
- package/docs/NumberPortModel.md +0 -51
- package/docs/TcxInstallationDetailsModel.md +0 -45
- package/docs/TelephonySupportTicketModel.md +0 -41
- package/hs_err_pid16044.log +0 -249
- package/hs_err_pid44560.log +0 -249
- package/hs_err_pid53988.log +0 -249
- package/hs_err_pid58728.log +0 -40
package/docs/OrdersApi.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# OrdersApi
|
|
2
2
|
|
|
3
|
-
All URIs are relative to *https://
|
|
3
|
+
All URIs are relative to *https://bitbucket.org*
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
@@ -9,11 +9,13 @@ All URIs are relative to *https://api.local.yellowgrid.co.uk*
|
|
|
9
9
|
|[**deleteUpdateShipment**](#deleteupdateshipment) | **DELETE** /admin/orders/{id}/batches/{batch_id}/shipments/{shipment_id} | Delete Shipment (Admin)|
|
|
10
10
|
|[**getGetAdminEditableOrder**](#getgetadmineditableorder) | **GET** /admin/orders/{id}/views/editable | Get Editable Order (Admin)|
|
|
11
11
|
|[**getGetAdminOrderDetails**](#getgetadminorderdetails) | **GET** /admin/orders/{id}/details | Get Order Details (Admin)|
|
|
12
|
+
|[**getGetCommercialInvoice**](#getgetcommercialinvoice) | **GET** /admin/orders/{id}/batches/{batch_id}/shipments/{shipment_id}/pdf | Get Commercial Invoice PDF|
|
|
12
13
|
|[**getGetEditableOrder**](#getgeteditableorder) | **GET** /orders/{id}/views/editable | Get Editable Order (Beta)|
|
|
13
14
|
|[**getGetItemSerialInfo**](#getgetitemserialinfo) | **GET** /admin/orders/{id}/items/{item_id}/info | Get Item Serial Info (Admin)|
|
|
14
15
|
|[**getGetOrderPdf**](#getgetorderpdf) | **GET** /orders/{id}/pdf | Download Order PDF|
|
|
15
16
|
|[**getGetOrderSummary**](#getgetordersummary) | **GET** /admin/orders/{id}/summary | Get Order Summary (Admin)|
|
|
16
17
|
|[**getGetOrders**](#getgetorders) | **GET** /orders | Get Orders (Beta)|
|
|
18
|
+
|[**patchCompleteOrder**](#patchcompleteorder) | **PATCH** /admin/orders/{id}/complete | Mark Order As Complete (Admin)|
|
|
17
19
|
|[**postAddOrderNote**](#postaddordernote) | **POST** /admin/orders/{id}/notes | Add Order Note|
|
|
18
20
|
|[**postCreateAdminOrder**](#postcreateadminorder) | **POST** /admin/orders | Create An Order (Admin)|
|
|
19
21
|
|[**postCreateConsignment**](#postcreateconsignment) | **POST** /admin/orders/{id}/shipments/{shipment_id}/consignment | Create Shipping Consignment|
|
|
@@ -21,12 +23,14 @@ All URIs are relative to *https://api.local.yellowgrid.co.uk*
|
|
|
21
23
|
|[**postGetOrders**](#postgetorders) | **POST** /orders | Create An Order (Beta)|
|
|
22
24
|
|[**postIssueCredit**](#postissuecredit) | **POST** /admin/orders/{id}/credit | Issue Credit (Admin)|
|
|
23
25
|
|[**postPrintShippingLabel**](#postprintshippinglabel) | **POST** /admin/orders/{id}/shipments/{shipment_id}/label/print | Print Shipment Label|
|
|
26
|
+
|[**postProcessTcxLicences**](#postprocesstcxlicences) | **POST** /admin/orders/{id}/batches/{batch_id}/licences/process | Process 3CX Licences (Admin)|
|
|
24
27
|
|[**postSendOrderEmail**](#postsendorderemail) | **POST** /admin/orders/{id}/email/send | Send Order Email|
|
|
25
28
|
|[**postSendShipmentEmail**](#postsendshipmentemail) | **POST** /admin/orders/{id}/batches/{batch_id}/shipments/{shipment_id}/send/email | Send Shipment Email (Admin)|
|
|
26
29
|
|[**postSendSupplierEmail**](#postsendsupplieremail) | **POST** /admin/orders/{id}/batches/{batch_id}/email/send | Send Supplier Email|
|
|
27
30
|
|[**postSplitOrder**](#postsplitorder) | **POST** /admin/orders/{id}/split | Split Order|
|
|
28
31
|
|[**putAllocateItems**](#putallocateitems) | **PUT** /admin/orders/{id}/items/allocate | Allocate Items To Supplier|
|
|
29
32
|
|[**putUpdateAdminOrder**](#putupdateadminorder) | **PUT** /admin/orders/{id} | Update An Order (Admin)|
|
|
33
|
+
|[**putUpdateBatchItem**](#putupdatebatchitem) | **PUT** /admin/orders/{id}/batches/{batch_id}/items/{item_id} | Update Batch Item (Admin)|
|
|
30
34
|
|[**putUpdateOrder**](#putupdateorder) | **PUT** /orders/{id} | Update An Order (Beta)|
|
|
31
35
|
|[**putUpdatePaymentStatus**](#putupdatepaymentstatus) | **PUT** /admin/orders/{id}/paid | Change Payment Status (Admin)|
|
|
32
36
|
|[**putUpdateShipment**](#putupdateshipment) | **PUT** /admin/orders/{id}/batches/{batch_id}/shipments/{shipment_id} | Update Shipment (Admin)|
|
|
@@ -310,6 +314,66 @@ No authorization required
|
|
|
310
314
|
|
|
311
315
|
[[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)
|
|
312
316
|
|
|
317
|
+
# **getGetCommercialInvoice**
|
|
318
|
+
> File getGetCommercialInvoice()
|
|
319
|
+
|
|
320
|
+
Get Commercial Invoice PDF
|
|
321
|
+
|
|
322
|
+
### Example
|
|
323
|
+
|
|
324
|
+
```typescript
|
|
325
|
+
import {
|
|
326
|
+
OrdersApi,
|
|
327
|
+
Configuration
|
|
328
|
+
} from 'yellowgrid-api-ts';
|
|
329
|
+
|
|
330
|
+
const configuration = new Configuration();
|
|
331
|
+
const apiInstance = new OrdersApi(configuration);
|
|
332
|
+
|
|
333
|
+
let id: number; //Order ID (default to undefined)
|
|
334
|
+
let batchId: number; //Batch ID (default to undefined)
|
|
335
|
+
let shipmentId: number; //Shipment ID (default to undefined)
|
|
336
|
+
|
|
337
|
+
const { status, data } = await apiInstance.getGetCommercialInvoice(
|
|
338
|
+
id,
|
|
339
|
+
batchId,
|
|
340
|
+
shipmentId
|
|
341
|
+
);
|
|
342
|
+
```
|
|
343
|
+
|
|
344
|
+
### Parameters
|
|
345
|
+
|
|
346
|
+
|Name | Type | Description | Notes|
|
|
347
|
+
|------------- | ------------- | ------------- | -------------|
|
|
348
|
+
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
349
|
+
| **batchId** | [**number**] | Batch ID | defaults to undefined|
|
|
350
|
+
| **shipmentId** | [**number**] | Shipment ID | defaults to undefined|
|
|
351
|
+
|
|
352
|
+
|
|
353
|
+
### Return type
|
|
354
|
+
|
|
355
|
+
**File**
|
|
356
|
+
|
|
357
|
+
### Authorization
|
|
358
|
+
|
|
359
|
+
No authorization required
|
|
360
|
+
|
|
361
|
+
### HTTP request headers
|
|
362
|
+
|
|
363
|
+
- **Content-Type**: Not defined
|
|
364
|
+
- **Accept**: application/pdf
|
|
365
|
+
|
|
366
|
+
|
|
367
|
+
### HTTP response details
|
|
368
|
+
| Status code | Description | Response headers |
|
|
369
|
+
|-------------|-------------|------------------|
|
|
370
|
+
|**200** | Order PDF | - |
|
|
371
|
+
|**400** | Bad Request | - |
|
|
372
|
+
|**401** | Unauthorised | - |
|
|
373
|
+
|**403** | Access Denied | - |
|
|
374
|
+
|
|
375
|
+
[[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)
|
|
376
|
+
|
|
313
377
|
# **getGetEditableOrder**
|
|
314
378
|
> DetailedOrderRequestDTO getGetEditableOrder()
|
|
315
379
|
|
|
@@ -601,6 +665,60 @@ No authorization required
|
|
|
601
665
|
|
|
602
666
|
[[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)
|
|
603
667
|
|
|
668
|
+
# **patchCompleteOrder**
|
|
669
|
+
> OrderDetailsDTO patchCompleteOrder()
|
|
670
|
+
|
|
671
|
+
Mark Order As Complete (Admin)
|
|
672
|
+
|
|
673
|
+
### Example
|
|
674
|
+
|
|
675
|
+
```typescript
|
|
676
|
+
import {
|
|
677
|
+
OrdersApi,
|
|
678
|
+
Configuration
|
|
679
|
+
} from 'yellowgrid-api-ts';
|
|
680
|
+
|
|
681
|
+
const configuration = new Configuration();
|
|
682
|
+
const apiInstance = new OrdersApi(configuration);
|
|
683
|
+
|
|
684
|
+
let id: number; //Order ID (default to undefined)
|
|
685
|
+
|
|
686
|
+
const { status, data } = await apiInstance.patchCompleteOrder(
|
|
687
|
+
id
|
|
688
|
+
);
|
|
689
|
+
```
|
|
690
|
+
|
|
691
|
+
### Parameters
|
|
692
|
+
|
|
693
|
+
|Name | Type | Description | Notes|
|
|
694
|
+
|------------- | ------------- | ------------- | -------------|
|
|
695
|
+
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
696
|
+
|
|
697
|
+
|
|
698
|
+
### Return type
|
|
699
|
+
|
|
700
|
+
**OrderDetailsDTO**
|
|
701
|
+
|
|
702
|
+
### Authorization
|
|
703
|
+
|
|
704
|
+
No authorization required
|
|
705
|
+
|
|
706
|
+
### HTTP request headers
|
|
707
|
+
|
|
708
|
+
- **Content-Type**: Not defined
|
|
709
|
+
- **Accept**: application/json
|
|
710
|
+
|
|
711
|
+
|
|
712
|
+
### HTTP response details
|
|
713
|
+
| Status code | Description | Response headers |
|
|
714
|
+
|-------------|-------------|------------------|
|
|
715
|
+
|**200** | Order Details | - |
|
|
716
|
+
|**400** | Bad Request | - |
|
|
717
|
+
|**401** | Unauthorised | - |
|
|
718
|
+
|**403** | Access Denied | - |
|
|
719
|
+
|
|
720
|
+
[[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)
|
|
721
|
+
|
|
604
722
|
# **postAddOrderNote**
|
|
605
723
|
> AuditLogEntity postAddOrderNote()
|
|
606
724
|
|
|
@@ -1002,13 +1120,71 @@ No authorization required
|
|
|
1002
1120
|
### HTTP request headers
|
|
1003
1121
|
|
|
1004
1122
|
- **Content-Type**: Not defined
|
|
1005
|
-
- **Accept**: text/html
|
|
1123
|
+
- **Accept**: text/html
|
|
1006
1124
|
|
|
1007
1125
|
|
|
1008
1126
|
### HTTP response details
|
|
1009
1127
|
| Status code | Description | Response headers |
|
|
1010
1128
|
|-------------|-------------|------------------|
|
|
1011
1129
|
|**200** | Shipping Label | - |
|
|
1130
|
+
|**204** | No Response | - |
|
|
1131
|
+
|**400** | Bad Request | - |
|
|
1132
|
+
|**401** | Unauthorised | - |
|
|
1133
|
+
|**403** | Access Denied | - |
|
|
1134
|
+
|
|
1135
|
+
[[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)
|
|
1136
|
+
|
|
1137
|
+
# **postProcessTcxLicences**
|
|
1138
|
+
> OrderDetailsDTO postProcessTcxLicences()
|
|
1139
|
+
|
|
1140
|
+
Process 3CX Licences (Admin)
|
|
1141
|
+
|
|
1142
|
+
### Example
|
|
1143
|
+
|
|
1144
|
+
```typescript
|
|
1145
|
+
import {
|
|
1146
|
+
OrdersApi,
|
|
1147
|
+
Configuration
|
|
1148
|
+
} from 'yellowgrid-api-ts';
|
|
1149
|
+
|
|
1150
|
+
const configuration = new Configuration();
|
|
1151
|
+
const apiInstance = new OrdersApi(configuration);
|
|
1152
|
+
|
|
1153
|
+
let id: number; //Order ID (default to undefined)
|
|
1154
|
+
let batchId: number; //Batch ID (default to undefined)
|
|
1155
|
+
|
|
1156
|
+
const { status, data } = await apiInstance.postProcessTcxLicences(
|
|
1157
|
+
id,
|
|
1158
|
+
batchId
|
|
1159
|
+
);
|
|
1160
|
+
```
|
|
1161
|
+
|
|
1162
|
+
### Parameters
|
|
1163
|
+
|
|
1164
|
+
|Name | Type | Description | Notes|
|
|
1165
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1166
|
+
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
1167
|
+
| **batchId** | [**number**] | Batch ID | defaults to undefined|
|
|
1168
|
+
|
|
1169
|
+
|
|
1170
|
+
### Return type
|
|
1171
|
+
|
|
1172
|
+
**OrderDetailsDTO**
|
|
1173
|
+
|
|
1174
|
+
### Authorization
|
|
1175
|
+
|
|
1176
|
+
No authorization required
|
|
1177
|
+
|
|
1178
|
+
### HTTP request headers
|
|
1179
|
+
|
|
1180
|
+
- **Content-Type**: Not defined
|
|
1181
|
+
- **Accept**: application/json
|
|
1182
|
+
|
|
1183
|
+
|
|
1184
|
+
### HTTP response details
|
|
1185
|
+
| Status code | Description | Response headers |
|
|
1186
|
+
|-------------|-------------|------------------|
|
|
1187
|
+
|**200** | Order Details | - |
|
|
1012
1188
|
|**400** | Bad Request | - |
|
|
1013
1189
|
|**401** | Unauthorised | - |
|
|
1014
1190
|
|**403** | Access Denied | - |
|
|
@@ -1372,6 +1548,70 @@ No authorization required
|
|
|
1372
1548
|
|
|
1373
1549
|
[[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)
|
|
1374
1550
|
|
|
1551
|
+
# **putUpdateBatchItem**
|
|
1552
|
+
> OrderedItemModel putUpdateBatchItem()
|
|
1553
|
+
|
|
1554
|
+
Update Batch Item (Admin)
|
|
1555
|
+
|
|
1556
|
+
### Example
|
|
1557
|
+
|
|
1558
|
+
```typescript
|
|
1559
|
+
import {
|
|
1560
|
+
OrdersApi,
|
|
1561
|
+
Configuration,
|
|
1562
|
+
OrderedItemModel
|
|
1563
|
+
} from 'yellowgrid-api-ts';
|
|
1564
|
+
|
|
1565
|
+
const configuration = new Configuration();
|
|
1566
|
+
const apiInstance = new OrdersApi(configuration);
|
|
1567
|
+
|
|
1568
|
+
let id: number; //Order ID (default to undefined)
|
|
1569
|
+
let batchId: number; //Batch ID (default to undefined)
|
|
1570
|
+
let itemId: number; //Ordered Item ID (default to undefined)
|
|
1571
|
+
let orderedItemModel: OrderedItemModel; //Batch Item (optional)
|
|
1572
|
+
|
|
1573
|
+
const { status, data } = await apiInstance.putUpdateBatchItem(
|
|
1574
|
+
id,
|
|
1575
|
+
batchId,
|
|
1576
|
+
itemId,
|
|
1577
|
+
orderedItemModel
|
|
1578
|
+
);
|
|
1579
|
+
```
|
|
1580
|
+
|
|
1581
|
+
### Parameters
|
|
1582
|
+
|
|
1583
|
+
|Name | Type | Description | Notes|
|
|
1584
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1585
|
+
| **orderedItemModel** | **OrderedItemModel**| Batch Item | |
|
|
1586
|
+
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
1587
|
+
| **batchId** | [**number**] | Batch ID | defaults to undefined|
|
|
1588
|
+
| **itemId** | [**number**] | Ordered Item ID | defaults to undefined|
|
|
1589
|
+
|
|
1590
|
+
|
|
1591
|
+
### Return type
|
|
1592
|
+
|
|
1593
|
+
**OrderedItemModel**
|
|
1594
|
+
|
|
1595
|
+
### Authorization
|
|
1596
|
+
|
|
1597
|
+
No authorization required
|
|
1598
|
+
|
|
1599
|
+
### HTTP request headers
|
|
1600
|
+
|
|
1601
|
+
- **Content-Type**: application/json
|
|
1602
|
+
- **Accept**: application/json
|
|
1603
|
+
|
|
1604
|
+
|
|
1605
|
+
### HTTP response details
|
|
1606
|
+
| Status code | Description | Response headers |
|
|
1607
|
+
|-------------|-------------|------------------|
|
|
1608
|
+
|**200** | Ordered Item | - |
|
|
1609
|
+
|**400** | Bad Request | - |
|
|
1610
|
+
|**401** | Unauthorised | - |
|
|
1611
|
+
|**403** | Access Denied | - |
|
|
1612
|
+
|
|
1613
|
+
[[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)
|
|
1614
|
+
|
|
1375
1615
|
# **putUpdateOrder**
|
|
1376
1616
|
> Array<OrderSummaryDTO> putUpdateOrder()
|
|
1377
1617
|
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# PostAddAdminNoteRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**note** | **string** | Note | [optional] [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { PostAddAdminNoteRequest } from 'yellowgrid-api-ts';
|
|
14
|
+
|
|
15
|
+
const instance: PostAddAdminNoteRequest = {
|
|
16
|
+
note,
|
|
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/docs/PricingApi.md
CHANGED
|
@@ -10,6 +10,7 @@ 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** | Date Time | [optional] [default to undefined]
|
|
13
14
|
**price** | **number** | Price | [optional] [default to undefined]
|
|
14
15
|
**cartonSize** | **number** | Carton Size | [optional] [default to undefined]
|
|
15
16
|
**rrp** | **number** | RRP Price | [optional] [default to undefined]
|
|
@@ -26,6 +27,7 @@ const instance: ProductSummaryDTO = {
|
|
|
26
27
|
title,
|
|
27
28
|
quantity,
|
|
28
29
|
stockProduct,
|
|
30
|
+
dueDate,
|
|
29
31
|
price,
|
|
30
32
|
cartonSize,
|
|
31
33
|
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://bitbucket.org*
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
@@ -11,6 +11,7 @@ All URIs are relative to *https://api.local.yellowgrid.co.uk*
|
|
|
11
11
|
|[**getGetStockList**](#getgetstocklist) | **GET** /products/stock | Get Current Stock & Pricing|
|
|
12
12
|
|[**getGetTcxTemplates**](#getgettcxtemplates) | **GET** /products/attributes/tcx/templates | Get 3CX Templates|
|
|
13
13
|
|[**getSearchProducts**](#getsearchproducts) | **GET** /products/search | Search Products|
|
|
14
|
+
|[**patchAddQuantityToStock**](#patchaddquantitytostock) | **PATCH** /products/{sku}/stock/add | Add Item Quantity To Stock|
|
|
14
15
|
|[**postGetProduct**](#postgetproduct) | **POST** /products/{sku} | Get Product|
|
|
15
16
|
|[**postGetProductForCustomer**](#postgetproductforcustomer) | **POST** /admin/products/{sku} | Get Product For Customer|
|
|
16
17
|
|
|
@@ -363,6 +364,63 @@ No authorization required
|
|
|
363
364
|
|
|
364
365
|
[[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)
|
|
365
366
|
|
|
367
|
+
# **patchAddQuantityToStock**
|
|
368
|
+
> patchAddQuantityToStock()
|
|
369
|
+
|
|
370
|
+
Add Item Quantity To Stock
|
|
371
|
+
|
|
372
|
+
### Example
|
|
373
|
+
|
|
374
|
+
```typescript
|
|
375
|
+
import {
|
|
376
|
+
ProductsApi,
|
|
377
|
+
Configuration
|
|
378
|
+
} from 'yellowgrid-api-ts';
|
|
379
|
+
|
|
380
|
+
const configuration = new Configuration();
|
|
381
|
+
const apiInstance = new ProductsApi(configuration);
|
|
382
|
+
|
|
383
|
+
let sku: string; //Product SKU (default to undefined)
|
|
384
|
+
let quantity: number; //Quantity (default to undefined)
|
|
385
|
+
|
|
386
|
+
const { status, data } = await apiInstance.patchAddQuantityToStock(
|
|
387
|
+
sku,
|
|
388
|
+
quantity
|
|
389
|
+
);
|
|
390
|
+
```
|
|
391
|
+
|
|
392
|
+
### Parameters
|
|
393
|
+
|
|
394
|
+
|Name | Type | Description | Notes|
|
|
395
|
+
|------------- | ------------- | ------------- | -------------|
|
|
396
|
+
| **sku** | [**string**] | Product SKU | defaults to undefined|
|
|
397
|
+
| **quantity** | [**number**] | Quantity | defaults to undefined|
|
|
398
|
+
|
|
399
|
+
|
|
400
|
+
### Return type
|
|
401
|
+
|
|
402
|
+
void (empty response body)
|
|
403
|
+
|
|
404
|
+
### Authorization
|
|
405
|
+
|
|
406
|
+
No authorization required
|
|
407
|
+
|
|
408
|
+
### HTTP request headers
|
|
409
|
+
|
|
410
|
+
- **Content-Type**: Not defined
|
|
411
|
+
- **Accept**: Not defined
|
|
412
|
+
|
|
413
|
+
|
|
414
|
+
### HTTP response details
|
|
415
|
+
| Status code | Description | Response headers |
|
|
416
|
+
|-------------|-------------|------------------|
|
|
417
|
+
|**200** | No Response | - |
|
|
418
|
+
|**400** | Bad Request | - |
|
|
419
|
+
|**401** | Unauthorised | - |
|
|
420
|
+
|**403** | Access Denied | - |
|
|
421
|
+
|
|
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
|
+
|
|
366
424
|
# **postGetProduct**
|
|
367
425
|
> ProductSummaryDTO postGetProduct(postGetProductRequest)
|
|
368
426
|
|
package/docs/ProvisioningApi.md
CHANGED
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# RemoteStorageDTO
|
|
2
|
+
|
|
3
|
+
Remote Storage
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**id** | **string** | AWS ID | [optional] [default to undefined]
|
|
10
|
+
**secret** | **string** | AWS Secret | [optional] [default to undefined]
|
|
11
|
+
**name** | **string** | AWS Bucket Name | [optional] [default to undefined]
|
|
12
|
+
**region** | **string** | AWS Region | [optional] [default to undefined]
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { RemoteStorageDTO } from 'yellowgrid-api-ts';
|
|
18
|
+
|
|
19
|
+
const instance: RemoteStorageDTO = {
|
|
20
|
+
id,
|
|
21
|
+
secret,
|
|
22
|
+
name,
|
|
23
|
+
region,
|
|
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/SIPTrunksApi.md
CHANGED
package/docs/SMSApi.md
CHANGED
package/docs/ServicesApi.md
CHANGED
package/docs/ShippingApi.md
CHANGED
package/docs/SystemApi.md
CHANGED
package/docs/TcxSbcDTO.md
CHANGED
|
@@ -6,12 +6,14 @@ SBC Data
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**id** | **number** | ID | [optional] [default to undefined]
|
|
9
10
|
**ipAddress** | **string** | LAN IP Address | [optional] [default to undefined]
|
|
10
11
|
**defaultGateway** | **string** | LAN Default Gateway | [optional] [default to undefined]
|
|
11
12
|
**netmask** | **string** | LAN Subnet Mask | [optional] [default to undefined]
|
|
12
13
|
**dns** | **string** | DNS | [optional] [default to undefined]
|
|
13
14
|
**tcxUrl** | **string** | 3CX URL | [optional] [default to undefined]
|
|
14
15
|
**tcxKey** | **string** | 3CX SBC Key | [optional] [default to undefined]
|
|
16
|
+
**configured** | **boolean** | 3CX SBC Configured | [optional] [default to undefined]
|
|
15
17
|
|
|
16
18
|
## Example
|
|
17
19
|
|
|
@@ -19,12 +21,14 @@ Name | Type | Description | Notes
|
|
|
19
21
|
import { TcxSbcDTO } from 'yellowgrid-api-ts';
|
|
20
22
|
|
|
21
23
|
const instance: TcxSbcDTO = {
|
|
24
|
+
id,
|
|
22
25
|
ipAddress,
|
|
23
26
|
defaultGateway,
|
|
24
27
|
netmask,
|
|
25
28
|
dns,
|
|
26
29
|
tcxUrl,
|
|
27
30
|
tcxKey,
|
|
31
|
+
configured,
|
|
28
32
|
};
|
|
29
33
|
```
|
|
30
34
|
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# TcxSbcResponseDTO
|
|
2
|
+
|
|
3
|
+
3CX SBC Response
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**status** | **string** | Status | [optional] [default to undefined]
|
|
10
|
+
**message** | **string** | Message | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { TcxSbcResponseDTO } from 'yellowgrid-api-ts';
|
|
16
|
+
|
|
17
|
+
const instance: TcxSbcResponseDTO = {
|
|
18
|
+
status,
|
|
19
|
+
message,
|
|
20
|
+
};
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
[[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/TicketsApi.md
CHANGED
package/docs/WebhooksApi.md
CHANGED
package/getEnums.php
CHANGED
|
@@ -1,31 +1,31 @@
|
|
|
1
|
-
<?php
|
|
2
|
-
|
|
3
|
-
use App\Contracts\Enums\PublicEnumInterface;
|
|
4
|
-
|
|
5
|
-
require_once __DIR__."/../../../../vendor/autoload.php";
|
|
6
|
-
|
|
7
|
-
$dir = __DIR__."/models";
|
|
8
|
-
if (!is_dir($dir)) {
|
|
9
|
-
mkdir($dir);
|
|
10
|
-
}
|
|
11
|
-
foreach (\App\Enums\Router\PublicEnumEnum::cases() as $publicEnum) {
|
|
12
|
-
$ref = new ReflectionEnum($publicEnum->value);
|
|
13
|
-
$cases = [];
|
|
14
|
-
foreach ($ref->getCases() as $c) {
|
|
15
|
-
/** @var BackedEnum $enum */
|
|
16
|
-
$enum = $c->getEnum()->getName();
|
|
17
|
-
$value = $c->getBackingValue();
|
|
18
|
-
/** @var PublicEnumInterface $case */
|
|
19
|
-
$case = $enum::from($value);
|
|
20
|
-
$cases[$c->getName()] = [
|
|
21
|
-
"name" => $case->name,
|
|
22
|
-
"value" => $case->value,
|
|
23
|
-
"publicValue" => $case->getPublicValue()
|
|
24
|
-
];
|
|
25
|
-
}
|
|
26
|
-
$enumName = $ref->getShortName();
|
|
27
|
-
$enumString = json_encode($cases, JSON_PRETTY_PRINT);
|
|
28
|
-
$content = "export const $enumName = $enumString as const;".
|
|
29
|
-
"\n\n export type $enumName = typeof $enumName;";
|
|
30
|
-
file_put_contents("$dir/$enumName.ts", $content);
|
|
31
|
-
}
|
|
1
|
+
<?php
|
|
2
|
+
|
|
3
|
+
use App\Contracts\Enums\PublicEnumInterface;
|
|
4
|
+
|
|
5
|
+
require_once __DIR__."/../../../../vendor/autoload.php";
|
|
6
|
+
|
|
7
|
+
$dir = __DIR__."/models";
|
|
8
|
+
if (!is_dir($dir)) {
|
|
9
|
+
mkdir($dir);
|
|
10
|
+
}
|
|
11
|
+
foreach (\App\Enums\Router\PublicEnumEnum::cases() as $publicEnum) {
|
|
12
|
+
$ref = new ReflectionEnum($publicEnum->value);
|
|
13
|
+
$cases = [];
|
|
14
|
+
foreach ($ref->getCases() as $c) {
|
|
15
|
+
/** @var BackedEnum $enum */
|
|
16
|
+
$enum = $c->getEnum()->getName();
|
|
17
|
+
$value = $c->getBackingValue();
|
|
18
|
+
/** @var PublicEnumInterface $case */
|
|
19
|
+
$case = $enum::from($value);
|
|
20
|
+
$cases[$c->getName()] = [
|
|
21
|
+
"name" => $case->name,
|
|
22
|
+
"value" => $case->value,
|
|
23
|
+
"publicValue" => $case->getPublicValue()
|
|
24
|
+
];
|
|
25
|
+
}
|
|
26
|
+
$enumName = $ref->getShortName();
|
|
27
|
+
$enumString = json_encode($cases, JSON_PRETTY_PRINT);
|
|
28
|
+
$content = "export const $enumName = $enumString as const;".
|
|
29
|
+
"\n\n export type $enumName = typeof $enumName;";
|
|
30
|
+
file_put_contents("$dir/$enumName.ts", $content);
|
|
31
|
+
}
|
package/index.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* Yellowgrid
|
|
5
|
-
* Welcome to the Yellowgrid API documentation.
|
|
5
|
+
* Welcome to the Yellowgrid API documentation. This API provides secure and comprehensive access to the Yellowgrid platform, enabling developers and integrators to manage accounts, contacts, SIP trunks, SMS messaging, 3CX integrations, and provisioning services. ## Key Features: - **Accounts**: View and manage account details, contacts, client credentials, and verification. - **Provisioning**: Automate setup and configuration of devices and groups. - **SIP Trunks**: Manage trunk creation, changes, DDIs, diverts, and configuration. - **Messaging**: Send SMS messages securely via the messaging gateway. - **3CX Integrations**: Automate licence handling, installation, and multi-tenant setup. ## Authentication: The API supports OAuth 2.0 for authentication and authorization. Ensure you use a valid bearer token for all authenticated endpoints. ## Base URL: `https://bitbucket.org` For questions or technical support, please contact support@yellowgrid.co.uk.
|
|
6
6
|
*
|
|
7
7
|
* The version of the OpenAPI document: 0
|
|
8
8
|
*
|