yellowgrid-api-ts 3.2.82-dev.0 → 3.2.83
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 +262 -257
- package/.openapi-generator/VERSION +1 -1
- package/README.md +17 -2
- package/api.ts +1183 -4781
- 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 +503 -4333
- package/dist/api.js +1136 -577
- 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 +1 -1
- package/docs/Class3CXIntegrationsApi.md +1 -1
- package/docs/Class3CXMultiTenantApi.md +1 -1
- package/docs/CreditNoteItemModel.md +29 -0
- package/docs/CreditNoteModel.md +2 -0
- package/docs/MyPBXToolsApi.md +1 -1
- package/docs/NumberPortingApi.md +61 -6
- package/docs/OAuth20Api.md +4 -4
- package/docs/OrderDetailsDTO.md +2 -0
- package/docs/OrdersApi.md +408 -55
- package/docs/PostAddAdminNoteRequest.md +20 -0
- package/docs/PricingApi.md +1 -1
- package/docs/ProductsApi.md +59 -1
- package/docs/ProvisioningApi.md +1 -1
- package/docs/SIPTrunksApi.md +1 -1
- package/docs/SMSApi.md +57 -1
- package/docs/ServicesApi.md +1 -1
- package/docs/ShippingApi.md +1 -1
- package/docs/ShippingRequestDTO.md +4 -0
- package/docs/SmsAccountDTO.md +31 -0
- package/docs/SmsAccountRequestDTO.md +29 -0
- package/docs/StockManagementApi.md +1 -1
- package/docs/SystemApi.md +1 -1
- package/docs/TcxSbcDTO.md +2 -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/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,24 +9,30 @@ All URIs are relative to *https://api.yellowgrid.local*
|
|
|
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)|
|
|
14
|
+
|[**getGetItemSerialInfo**](#getgetitemserialinfo) | **GET** /admin/orders/{id}/items/{item_id}/info | Get Item Serial Info (Admin)|
|
|
13
15
|
|[**getGetOrderPdf**](#getgetorderpdf) | **GET** /orders/{id}/pdf | Download Order PDF|
|
|
16
|
+
|[**getGetOrderSummary**](#getgetordersummary) | **GET** /admin/orders/{id}/summary | Get Order Summary (Admin)|
|
|
14
17
|
|[**getGetOrders**](#getgetorders) | **GET** /orders | Get Orders (Beta)|
|
|
18
|
+
|[**patchCompleteOrder**](#patchcompleteorder) | **PATCH** /admin/orders/{id}/complete | Mark Order As Complete (Admin)|
|
|
15
19
|
|[**postAddOrderNote**](#postaddordernote) | **POST** /admin/orders/{id}/notes | Add Order Note|
|
|
16
20
|
|[**postCreateAdminOrder**](#postcreateadminorder) | **POST** /admin/orders | Create An Order (Admin)|
|
|
17
21
|
|[**postCreateConsignment**](#postcreateconsignment) | **POST** /admin/orders/{id}/shipments/{shipment_id}/consignment | Create Shipping Consignment|
|
|
18
22
|
|[**postCreateShipment**](#postcreateshipment) | **POST** /admin/orders/{id}/batches/{batch_id}/shipments | Create Shipment (Admin)|
|
|
19
|
-
|[**postGetItemSerialInfo**](#postgetitemserialinfo) | **POST** /admin/orders/{id}/items/{item_id}/info | Get Item Serial Info (Admin)|
|
|
20
23
|
|[**postGetOrders**](#postgetorders) | **POST** /orders | Create An Order (Beta)|
|
|
21
24
|
|[**postIssueCredit**](#postissuecredit) | **POST** /admin/orders/{id}/credit | Issue Credit (Admin)|
|
|
22
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)|
|
|
23
27
|
|[**postSendOrderEmail**](#postsendorderemail) | **POST** /admin/orders/{id}/email/send | Send Order Email|
|
|
24
28
|
|[**postSendShipmentEmail**](#postsendshipmentemail) | **POST** /admin/orders/{id}/batches/{batch_id}/shipments/{shipment_id}/send/email | Send Shipment Email (Admin)|
|
|
25
29
|
|[**postSendSupplierEmail**](#postsendsupplieremail) | **POST** /admin/orders/{id}/batches/{batch_id}/email/send | Send Supplier Email|
|
|
26
30
|
|[**postSplitOrder**](#postsplitorder) | **POST** /admin/orders/{id}/split | Split Order|
|
|
27
31
|
|[**putAllocateItems**](#putallocateitems) | **PUT** /admin/orders/{id}/items/allocate | Allocate Items To Supplier|
|
|
28
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)|
|
|
29
34
|
|[**putUpdateOrder**](#putupdateorder) | **PUT** /orders/{id} | Update An Order (Beta)|
|
|
35
|
+
|[**putUpdatePaymentStatus**](#putupdatepaymentstatus) | **PUT** /admin/orders/{id}/paid | Change Payment Status (Admin)|
|
|
30
36
|
|[**putUpdateShipment**](#putupdateshipment) | **PUT** /admin/orders/{id}/batches/{batch_id}/shipments/{shipment_id} | Update Shipment (Admin)|
|
|
31
37
|
|
|
32
38
|
# **deleteDeleteBatch**
|
|
@@ -308,6 +314,66 @@ No authorization required
|
|
|
308
314
|
|
|
309
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)
|
|
310
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
|
+
|
|
311
377
|
# **getGetEditableOrder**
|
|
312
378
|
> DetailedOrderRequestDTO getGetEditableOrder()
|
|
313
379
|
|
|
@@ -362,6 +428,63 @@ No authorization required
|
|
|
362
428
|
|
|
363
429
|
[[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)
|
|
364
430
|
|
|
431
|
+
# **getGetItemSerialInfo**
|
|
432
|
+
> ProductSerialInfoModel getGetItemSerialInfo()
|
|
433
|
+
|
|
434
|
+
Get Item Serial Info (Admin)
|
|
435
|
+
|
|
436
|
+
### Example
|
|
437
|
+
|
|
438
|
+
```typescript
|
|
439
|
+
import {
|
|
440
|
+
OrdersApi,
|
|
441
|
+
Configuration
|
|
442
|
+
} from 'yellowgrid-api-ts';
|
|
443
|
+
|
|
444
|
+
const configuration = new Configuration();
|
|
445
|
+
const apiInstance = new OrdersApi(configuration);
|
|
446
|
+
|
|
447
|
+
let id: number; //Order ID (default to undefined)
|
|
448
|
+
let itemId: number; //Shipment Item ID (default to undefined)
|
|
449
|
+
|
|
450
|
+
const { status, data } = await apiInstance.getGetItemSerialInfo(
|
|
451
|
+
id,
|
|
452
|
+
itemId
|
|
453
|
+
);
|
|
454
|
+
```
|
|
455
|
+
|
|
456
|
+
### Parameters
|
|
457
|
+
|
|
458
|
+
|Name | Type | Description | Notes|
|
|
459
|
+
|------------- | ------------- | ------------- | -------------|
|
|
460
|
+
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
461
|
+
| **itemId** | [**number**] | Shipment Item ID | defaults to undefined|
|
|
462
|
+
|
|
463
|
+
|
|
464
|
+
### Return type
|
|
465
|
+
|
|
466
|
+
**ProductSerialInfoModel**
|
|
467
|
+
|
|
468
|
+
### Authorization
|
|
469
|
+
|
|
470
|
+
No authorization required
|
|
471
|
+
|
|
472
|
+
### HTTP request headers
|
|
473
|
+
|
|
474
|
+
- **Content-Type**: Not defined
|
|
475
|
+
- **Accept**: application/json
|
|
476
|
+
|
|
477
|
+
|
|
478
|
+
### HTTP response details
|
|
479
|
+
| Status code | Description | Response headers |
|
|
480
|
+
|-------------|-------------|------------------|
|
|
481
|
+
|**200** | Serial Info | - |
|
|
482
|
+
|**400** | Bad Request | - |
|
|
483
|
+
|**401** | Unauthorised | - |
|
|
484
|
+
|**403** | Access Denied | - |
|
|
485
|
+
|
|
486
|
+
[[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)
|
|
487
|
+
|
|
365
488
|
# **getGetOrderPdf**
|
|
366
489
|
> File getGetOrderPdf()
|
|
367
490
|
|
|
@@ -416,6 +539,60 @@ No authorization required
|
|
|
416
539
|
|
|
417
540
|
[[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)
|
|
418
541
|
|
|
542
|
+
# **getGetOrderSummary**
|
|
543
|
+
> OrderSummaryDTO getGetOrderSummary()
|
|
544
|
+
|
|
545
|
+
Get Order Summary (Admin)
|
|
546
|
+
|
|
547
|
+
### Example
|
|
548
|
+
|
|
549
|
+
```typescript
|
|
550
|
+
import {
|
|
551
|
+
OrdersApi,
|
|
552
|
+
Configuration
|
|
553
|
+
} from 'yellowgrid-api-ts';
|
|
554
|
+
|
|
555
|
+
const configuration = new Configuration();
|
|
556
|
+
const apiInstance = new OrdersApi(configuration);
|
|
557
|
+
|
|
558
|
+
let id: number; //Order ID (default to undefined)
|
|
559
|
+
|
|
560
|
+
const { status, data } = await apiInstance.getGetOrderSummary(
|
|
561
|
+
id
|
|
562
|
+
);
|
|
563
|
+
```
|
|
564
|
+
|
|
565
|
+
### Parameters
|
|
566
|
+
|
|
567
|
+
|Name | Type | Description | Notes|
|
|
568
|
+
|------------- | ------------- | ------------- | -------------|
|
|
569
|
+
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
570
|
+
|
|
571
|
+
|
|
572
|
+
### Return type
|
|
573
|
+
|
|
574
|
+
**OrderSummaryDTO**
|
|
575
|
+
|
|
576
|
+
### Authorization
|
|
577
|
+
|
|
578
|
+
No authorization required
|
|
579
|
+
|
|
580
|
+
### HTTP request headers
|
|
581
|
+
|
|
582
|
+
- **Content-Type**: Not defined
|
|
583
|
+
- **Accept**: application/json
|
|
584
|
+
|
|
585
|
+
|
|
586
|
+
### HTTP response details
|
|
587
|
+
| Status code | Description | Response headers |
|
|
588
|
+
|-------------|-------------|------------------|
|
|
589
|
+
|**200** | Order Summary | - |
|
|
590
|
+
|**400** | Bad Request | - |
|
|
591
|
+
|**401** | Unauthorised | - |
|
|
592
|
+
|**403** | Access Denied | - |
|
|
593
|
+
|
|
594
|
+
[[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)
|
|
595
|
+
|
|
419
596
|
# **getGetOrders**
|
|
420
597
|
> OrderSummariesModel getGetOrders()
|
|
421
598
|
|
|
@@ -488,6 +665,60 @@ No authorization required
|
|
|
488
665
|
|
|
489
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)
|
|
490
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
|
+
|
|
491
722
|
# **postAddOrderNote**
|
|
492
723
|
> AuditLogEntity postAddOrderNote()
|
|
493
724
|
|
|
@@ -726,28 +957,29 @@ No authorization required
|
|
|
726
957
|
|
|
727
958
|
[[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)
|
|
728
959
|
|
|
729
|
-
# **
|
|
730
|
-
>
|
|
960
|
+
# **postGetOrders**
|
|
961
|
+
> Array<OrderSummaryDTO> postGetOrders()
|
|
731
962
|
|
|
732
|
-
|
|
963
|
+
Create An Order (Beta)
|
|
733
964
|
|
|
734
965
|
### Example
|
|
735
966
|
|
|
736
967
|
```typescript
|
|
737
968
|
import {
|
|
738
969
|
OrdersApi,
|
|
739
|
-
Configuration
|
|
970
|
+
Configuration,
|
|
971
|
+
CustomerOrderRequestDTO
|
|
740
972
|
} from 'yellowgrid-api-ts';
|
|
741
973
|
|
|
742
974
|
const configuration = new Configuration();
|
|
743
975
|
const apiInstance = new OrdersApi(configuration);
|
|
744
976
|
|
|
745
|
-
let
|
|
746
|
-
let
|
|
977
|
+
let readonly: boolean; //Readonly Order (optional) (default to undefined)
|
|
978
|
+
let customerOrderRequestDTO: CustomerOrderRequestDTO; //Order Request (optional)
|
|
747
979
|
|
|
748
|
-
const { status, data } = await apiInstance.
|
|
749
|
-
|
|
750
|
-
|
|
980
|
+
const { status, data } = await apiInstance.postGetOrders(
|
|
981
|
+
readonly,
|
|
982
|
+
customerOrderRequestDTO
|
|
751
983
|
);
|
|
752
984
|
```
|
|
753
985
|
|
|
@@ -755,13 +987,13 @@ const { status, data } = await apiInstance.postGetItemSerialInfo(
|
|
|
755
987
|
|
|
756
988
|
|Name | Type | Description | Notes|
|
|
757
989
|
|------------- | ------------- | ------------- | -------------|
|
|
758
|
-
| **
|
|
759
|
-
| **
|
|
990
|
+
| **customerOrderRequestDTO** | **CustomerOrderRequestDTO**| Order Request | |
|
|
991
|
+
| **readonly** | [**boolean**] | Readonly Order | (optional) defaults to undefined|
|
|
760
992
|
|
|
761
993
|
|
|
762
994
|
### Return type
|
|
763
995
|
|
|
764
|
-
**
|
|
996
|
+
**Array<OrderSummaryDTO>**
|
|
765
997
|
|
|
766
998
|
### Authorization
|
|
767
999
|
|
|
@@ -769,24 +1001,24 @@ No authorization required
|
|
|
769
1001
|
|
|
770
1002
|
### HTTP request headers
|
|
771
1003
|
|
|
772
|
-
- **Content-Type**:
|
|
1004
|
+
- **Content-Type**: application/json
|
|
773
1005
|
- **Accept**: application/json
|
|
774
1006
|
|
|
775
1007
|
|
|
776
1008
|
### HTTP response details
|
|
777
1009
|
| Status code | Description | Response headers |
|
|
778
1010
|
|-------------|-------------|------------------|
|
|
779
|
-
|**200** |
|
|
1011
|
+
|**200** | Order Summaries | - |
|
|
780
1012
|
|**400** | Bad Request | - |
|
|
781
1013
|
|**401** | Unauthorised | - |
|
|
782
1014
|
|**403** | Access Denied | - |
|
|
783
1015
|
|
|
784
1016
|
[[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)
|
|
785
1017
|
|
|
786
|
-
# **
|
|
787
|
-
>
|
|
1018
|
+
# **postIssueCredit**
|
|
1019
|
+
> CreditNoteModel postIssueCredit()
|
|
788
1020
|
|
|
789
|
-
|
|
1021
|
+
Issue Credit (Admin)
|
|
790
1022
|
|
|
791
1023
|
### Example
|
|
792
1024
|
|
|
@@ -794,18 +1026,18 @@ Create An Order (Beta)
|
|
|
794
1026
|
import {
|
|
795
1027
|
OrdersApi,
|
|
796
1028
|
Configuration,
|
|
797
|
-
|
|
1029
|
+
CreditNoteDTO
|
|
798
1030
|
} from 'yellowgrid-api-ts';
|
|
799
1031
|
|
|
800
1032
|
const configuration = new Configuration();
|
|
801
1033
|
const apiInstance = new OrdersApi(configuration);
|
|
802
1034
|
|
|
803
|
-
let
|
|
804
|
-
let
|
|
1035
|
+
let id: number; //Order ID (default to undefined)
|
|
1036
|
+
let creditNoteDTO: CreditNoteDTO; //Credit Request (optional)
|
|
805
1037
|
|
|
806
|
-
const { status, data } = await apiInstance.
|
|
807
|
-
|
|
808
|
-
|
|
1038
|
+
const { status, data } = await apiInstance.postIssueCredit(
|
|
1039
|
+
id,
|
|
1040
|
+
creditNoteDTO
|
|
809
1041
|
);
|
|
810
1042
|
```
|
|
811
1043
|
|
|
@@ -813,13 +1045,13 @@ const { status, data } = await apiInstance.postGetOrders(
|
|
|
813
1045
|
|
|
814
1046
|
|Name | Type | Description | Notes|
|
|
815
1047
|
|------------- | ------------- | ------------- | -------------|
|
|
816
|
-
| **
|
|
817
|
-
| **
|
|
1048
|
+
| **creditNoteDTO** | **CreditNoteDTO**| Credit Request | |
|
|
1049
|
+
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
818
1050
|
|
|
819
1051
|
|
|
820
1052
|
### Return type
|
|
821
1053
|
|
|
822
|
-
**
|
|
1054
|
+
**CreditNoteModel**
|
|
823
1055
|
|
|
824
1056
|
### Authorization
|
|
825
1057
|
|
|
@@ -834,36 +1066,37 @@ No authorization required
|
|
|
834
1066
|
### HTTP response details
|
|
835
1067
|
| Status code | Description | Response headers |
|
|
836
1068
|
|-------------|-------------|------------------|
|
|
837
|
-
|**200** |
|
|
1069
|
+
|**200** | Credit Note | - |
|
|
838
1070
|
|**400** | Bad Request | - |
|
|
839
1071
|
|**401** | Unauthorised | - |
|
|
840
1072
|
|**403** | Access Denied | - |
|
|
841
1073
|
|
|
842
1074
|
[[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)
|
|
843
1075
|
|
|
844
|
-
# **
|
|
845
|
-
>
|
|
1076
|
+
# **postPrintShippingLabel**
|
|
1077
|
+
> File postPrintShippingLabel()
|
|
846
1078
|
|
|
847
|
-
|
|
1079
|
+
Print Shipment Label
|
|
848
1080
|
|
|
849
1081
|
### Example
|
|
850
1082
|
|
|
851
1083
|
```typescript
|
|
852
1084
|
import {
|
|
853
1085
|
OrdersApi,
|
|
854
|
-
Configuration
|
|
855
|
-
CreditNoteDTO
|
|
1086
|
+
Configuration
|
|
856
1087
|
} from 'yellowgrid-api-ts';
|
|
857
1088
|
|
|
858
1089
|
const configuration = new Configuration();
|
|
859
1090
|
const apiInstance = new OrdersApi(configuration);
|
|
860
1091
|
|
|
861
1092
|
let id: number; //Order ID (default to undefined)
|
|
862
|
-
let
|
|
1093
|
+
let shipmentId: number; //Shipment ID (default to undefined)
|
|
1094
|
+
let printer: 1 | 2 | 3; //Printer (default to undefined)
|
|
863
1095
|
|
|
864
|
-
const { status, data } = await apiInstance.
|
|
1096
|
+
const { status, data } = await apiInstance.postPrintShippingLabel(
|
|
865
1097
|
id,
|
|
866
|
-
|
|
1098
|
+
shipmentId,
|
|
1099
|
+
printer
|
|
867
1100
|
);
|
|
868
1101
|
```
|
|
869
1102
|
|
|
@@ -871,13 +1104,14 @@ const { status, data } = await apiInstance.postIssueCredit(
|
|
|
871
1104
|
|
|
872
1105
|
|Name | Type | Description | Notes|
|
|
873
1106
|
|------------- | ------------- | ------------- | -------------|
|
|
874
|
-
| **creditNoteDTO** | **CreditNoteDTO**| Credit Request | |
|
|
875
1107
|
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
1108
|
+
| **shipmentId** | [**number**] | Shipment ID | defaults to undefined|
|
|
1109
|
+
| **printer** | [**1 | 2 | 3**]**Array<1 | 2 | 3>** | Printer | defaults to undefined|
|
|
876
1110
|
|
|
877
1111
|
|
|
878
1112
|
### Return type
|
|
879
1113
|
|
|
880
|
-
**
|
|
1114
|
+
**File**
|
|
881
1115
|
|
|
882
1116
|
### Authorization
|
|
883
1117
|
|
|
@@ -885,24 +1119,25 @@ No authorization required
|
|
|
885
1119
|
|
|
886
1120
|
### HTTP request headers
|
|
887
1121
|
|
|
888
|
-
- **Content-Type**:
|
|
889
|
-
- **Accept**:
|
|
1122
|
+
- **Content-Type**: Not defined
|
|
1123
|
+
- **Accept**: text/html
|
|
890
1124
|
|
|
891
1125
|
|
|
892
1126
|
### HTTP response details
|
|
893
1127
|
| Status code | Description | Response headers |
|
|
894
1128
|
|-------------|-------------|------------------|
|
|
895
|
-
|**200** |
|
|
1129
|
+
|**200** | Shipping Label | - |
|
|
1130
|
+
|**204** | No Response | - |
|
|
896
1131
|
|**400** | Bad Request | - |
|
|
897
1132
|
|**401** | Unauthorised | - |
|
|
898
1133
|
|**403** | Access Denied | - |
|
|
899
1134
|
|
|
900
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)
|
|
901
1136
|
|
|
902
|
-
# **
|
|
903
|
-
>
|
|
1137
|
+
# **postProcessTcxLicences**
|
|
1138
|
+
> OrderDetailsDTO postProcessTcxLicences()
|
|
904
1139
|
|
|
905
|
-
|
|
1140
|
+
Process 3CX Licences (Admin)
|
|
906
1141
|
|
|
907
1142
|
### Example
|
|
908
1143
|
|
|
@@ -916,13 +1151,11 @@ const configuration = new Configuration();
|
|
|
916
1151
|
const apiInstance = new OrdersApi(configuration);
|
|
917
1152
|
|
|
918
1153
|
let id: number; //Order ID (default to undefined)
|
|
919
|
-
let
|
|
920
|
-
let printer: 1 | 2 | 3; //Printer (default to undefined)
|
|
1154
|
+
let batchId: number; //Batch ID (default to undefined)
|
|
921
1155
|
|
|
922
|
-
const { status, data } = await apiInstance.
|
|
1156
|
+
const { status, data } = await apiInstance.postProcessTcxLicences(
|
|
923
1157
|
id,
|
|
924
|
-
|
|
925
|
-
printer
|
|
1158
|
+
batchId
|
|
926
1159
|
);
|
|
927
1160
|
```
|
|
928
1161
|
|
|
@@ -931,13 +1164,12 @@ const { status, data } = await apiInstance.postPrintShippingLabel(
|
|
|
931
1164
|
|Name | Type | Description | Notes|
|
|
932
1165
|
|------------- | ------------- | ------------- | -------------|
|
|
933
1166
|
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
934
|
-
| **
|
|
935
|
-
| **printer** | [**1 | 2 | 3**]**Array<1 | 2 | 3>** | Printer | defaults to undefined|
|
|
1167
|
+
| **batchId** | [**number**] | Batch ID | defaults to undefined|
|
|
936
1168
|
|
|
937
1169
|
|
|
938
1170
|
### Return type
|
|
939
1171
|
|
|
940
|
-
**
|
|
1172
|
+
**OrderDetailsDTO**
|
|
941
1173
|
|
|
942
1174
|
### Authorization
|
|
943
1175
|
|
|
@@ -946,13 +1178,13 @@ No authorization required
|
|
|
946
1178
|
### HTTP request headers
|
|
947
1179
|
|
|
948
1180
|
- **Content-Type**: Not defined
|
|
949
|
-
- **Accept**:
|
|
1181
|
+
- **Accept**: application/json
|
|
950
1182
|
|
|
951
1183
|
|
|
952
1184
|
### HTTP response details
|
|
953
1185
|
| Status code | Description | Response headers |
|
|
954
1186
|
|-------------|-------------|------------------|
|
|
955
|
-
|**200** |
|
|
1187
|
+
|**200** | Order Details | - |
|
|
956
1188
|
|**400** | Bad Request | - |
|
|
957
1189
|
|**401** | Unauthorised | - |
|
|
958
1190
|
|**403** | Access Denied | - |
|
|
@@ -1316,6 +1548,70 @@ No authorization required
|
|
|
1316
1548
|
|
|
1317
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)
|
|
1318
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
|
+
|
|
1319
1615
|
# **putUpdateOrder**
|
|
1320
1616
|
> Array<OrderSummaryDTO> putUpdateOrder()
|
|
1321
1617
|
|
|
@@ -1377,6 +1673,63 @@ No authorization required
|
|
|
1377
1673
|
|
|
1378
1674
|
[[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)
|
|
1379
1675
|
|
|
1676
|
+
# **putUpdatePaymentStatus**
|
|
1677
|
+
> OrderDetailsDTO putUpdatePaymentStatus()
|
|
1678
|
+
|
|
1679
|
+
Change Payment Status (Admin)
|
|
1680
|
+
|
|
1681
|
+
### Example
|
|
1682
|
+
|
|
1683
|
+
```typescript
|
|
1684
|
+
import {
|
|
1685
|
+
OrdersApi,
|
|
1686
|
+
Configuration
|
|
1687
|
+
} from 'yellowgrid-api-ts';
|
|
1688
|
+
|
|
1689
|
+
const configuration = new Configuration();
|
|
1690
|
+
const apiInstance = new OrdersApi(configuration);
|
|
1691
|
+
|
|
1692
|
+
let id: number; //Order ID (default to undefined)
|
|
1693
|
+
let paid: boolean; //Paid (default to undefined)
|
|
1694
|
+
|
|
1695
|
+
const { status, data } = await apiInstance.putUpdatePaymentStatus(
|
|
1696
|
+
id,
|
|
1697
|
+
paid
|
|
1698
|
+
);
|
|
1699
|
+
```
|
|
1700
|
+
|
|
1701
|
+
### Parameters
|
|
1702
|
+
|
|
1703
|
+
|Name | Type | Description | Notes|
|
|
1704
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1705
|
+
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
1706
|
+
| **paid** | [**boolean**] | Paid | defaults to undefined|
|
|
1707
|
+
|
|
1708
|
+
|
|
1709
|
+
### Return type
|
|
1710
|
+
|
|
1711
|
+
**OrderDetailsDTO**
|
|
1712
|
+
|
|
1713
|
+
### Authorization
|
|
1714
|
+
|
|
1715
|
+
No authorization required
|
|
1716
|
+
|
|
1717
|
+
### HTTP request headers
|
|
1718
|
+
|
|
1719
|
+
- **Content-Type**: Not defined
|
|
1720
|
+
- **Accept**: application/json
|
|
1721
|
+
|
|
1722
|
+
|
|
1723
|
+
### HTTP response details
|
|
1724
|
+
| Status code | Description | Response headers |
|
|
1725
|
+
|-------------|-------------|------------------|
|
|
1726
|
+
|**200** | Order Details | - |
|
|
1727
|
+
|**400** | Bad Request | - |
|
|
1728
|
+
|**401** | Unauthorised | - |
|
|
1729
|
+
|**403** | Access Denied | - |
|
|
1730
|
+
|
|
1731
|
+
[[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)
|
|
1732
|
+
|
|
1380
1733
|
# **putUpdateShipment**
|
|
1381
1734
|
> ShipmentDTO putUpdateShipment()
|
|
1382
1735
|
|