yellowgrid-api-ts 3.2.232-dev.0 → 3.2.233-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/api.ts +521 -443
- package/dist/api.d.ts +419 -425
- package/dist/api.js +276 -192
- package/docs/AbstractOrderRequestDTO.md +3 -3
- package/docs/AccountDetailedSummaryDTO.md +1 -1
- package/docs/AccountRequestModel.md +6 -6
- package/docs/AddressDTO.md +3 -3
- package/docs/AdminNumberPortDTO.md +11 -11
- package/docs/AdminOrderRequestDTO.md +3 -3
- package/docs/AdminRmaDTO.md +3 -3
- package/docs/AdminRmaItemDTO.md +2 -2
- package/docs/AdminUserModel.md +5 -5
- package/docs/AuthCodeResponseModel.md +2 -2
- package/docs/AxisDataDTO.md +2 -2
- package/docs/CreditNoteItemDTO.md +2 -2
- package/docs/CreditStatusDTO.md +3 -3
- package/docs/CrmActivityDTO.md +4 -4
- package/docs/CrmDateActivitiesDTO.md +1 -1
- package/docs/CustomerCoordinatesDTO.md +1 -1
- package/docs/CustomerOrderRequestDTO.md +3 -3
- package/docs/DetailedOrderRequestDTO.md +3 -3
- package/docs/DivertRequestModel.md +1 -1
- package/docs/DivertResponseModel.md +1 -1
- package/docs/EdTechProClientEntity.md +1 -1
- package/docs/EdTechProSchoolModel.md +2 -2
- package/docs/FreshdeskTicketEntity.md +1 -1
- package/docs/GraphDTO.md +1 -1
- package/docs/InstallationDetailsDTO.md +7 -7
- package/docs/ItemDiscountEntity.md +1 -1
- package/docs/ItemEntity.md +1 -1
- package/docs/NumberPortDTO.md +11 -11
- package/docs/NumberPortRangeDTO.md +5 -5
- package/docs/NumberPortRangeRequestDTO.md +4 -4
- package/docs/NumberPortingApi.md +69 -69
- package/docs/OAuth20Api.md +24 -24
- package/docs/OpayoRedirectDTO.md +5 -5
- package/docs/OrderDetailsDTO.md +6 -6
- package/docs/OrderEntity.md +2 -2
- package/docs/OrderRequestModel.md +7 -7
- package/docs/OrderResponseDTO.md +3 -3
- package/docs/OrderSummaryDTO.md +6 -6
- package/docs/OrderTotalModel.md +1 -1
- package/docs/PartnerDTO.md +2 -2
- package/docs/PasswordSenderDTO.md +7 -7
- package/docs/PostGenerateReport200Response.md +1 -1
- package/docs/PriceListItemModel.md +3 -3
- package/docs/ProductPriceListItemModel.md +3 -3
- package/docs/ProductSerialInfoModel.md +1 -1
- package/docs/ProspectDTO.md +3 -3
- package/docs/RecordingBackupAzureModel.md +1 -1
- package/docs/RecordingsBackupInfoDTO.md +2 -2
- package/docs/ReportRequestDTO.md +8 -8
- package/docs/RmaDTO.md +1 -1
- package/docs/RmaItemDTO.md +2 -2
- package/docs/RmaItemRequestDTO.md +2 -2
- package/docs/SbcDTO.md +8 -8
- package/docs/ScannedItemModel.md +4 -4
- package/docs/SeriesDTO.md +1 -1
- package/docs/ShipmentDTO.md +7 -7
- package/docs/ShipmentRequestDTO.md +2 -2
- package/docs/ShippingAddressDTO.md +8 -8
- package/docs/ShippingRequestDTO.md +2 -2
- package/docs/ShippingServiceModel.md +2 -2
- package/docs/SmsAccountEntity.md +1 -1
- package/docs/SmsPhoneNumberModel.md +1 -1
- package/docs/StockOrderModel.md +1 -1
- package/docs/StockProductPriceModel.md +1 -1
- package/docs/SupportTicketModel.md +1 -1
- package/docs/TcxInstallationModel.md +15 -15
- package/docs/TcxKeySummaryDTO.md +2 -2
- package/docs/TcxMultiTenantModel.md +7 -7
- package/docs/TcxSbcDTO.md +1 -1
- package/docs/TcxSetupEntity.md +1 -1
- package/docs/TcxWizardModel.md +5 -5
- package/docs/TicketSummaryModel.md +1 -1
- package/docs/UserEntity.md +2 -2
- package/package.json +1 -1
package/docs/NumberPortingApi.md
CHANGED
|
@@ -472,22 +472,20 @@ import {
|
|
|
472
472
|
const configuration = new Configuration();
|
|
473
473
|
const apiInstance = new NumberPortingApi(configuration);
|
|
474
474
|
|
|
475
|
+
let companyName: string; //Company Name (default to undefined)
|
|
476
|
+
let addressLine1: string; //Address Line 1 (default to undefined)
|
|
477
|
+
let addressLine2: string; //Address Line 2 (default to undefined)
|
|
478
|
+
let city: string; //City (default to undefined)
|
|
479
|
+
let postCode: string; //Post Code (default to undefined)
|
|
480
|
+
let trunkId: number; //Trunk ID (default to undefined)
|
|
481
|
+
let tenantId: string; //Starter Bundle ID (default to undefined)
|
|
482
|
+
let requestedPortDate: string; //Requested Port Date (default to undefined)
|
|
483
|
+
let asap: boolean; //Port Date ASAP (default to undefined)
|
|
484
|
+
let comment: string; //Comment (default to undefined)
|
|
475
485
|
let numberRanges: Array<NumberPortRangeRequestDTO>; //Number Ranges (default to undefined)
|
|
476
486
|
let cloa: File; //CLOA (only provide on submission) (default to undefined)
|
|
477
|
-
let companyName: string; //Company Name (optional) (default to undefined)
|
|
478
|
-
let addressLine1: string; //Address Line 1 (optional) (default to undefined)
|
|
479
|
-
let addressLine2: string; //Address Line 2 (optional) (default to undefined)
|
|
480
|
-
let city: string; //City (optional) (default to undefined)
|
|
481
|
-
let postCode: string; //Post Code (optional) (default to undefined)
|
|
482
|
-
let trunkId: number; //Trunk ID (optional) (default to undefined)
|
|
483
|
-
let tenantId: string; //Starter Bundle ID (optional) (default to undefined)
|
|
484
|
-
let requestedPortDate: string; //Requested Port Date (optional) (default to undefined)
|
|
485
|
-
let asap: boolean; //Port Date ASAP (optional) (default to undefined)
|
|
486
|
-
let comment: string; //Comment (optional) (default to undefined)
|
|
487
487
|
|
|
488
488
|
const { status, data } = await apiInstance.postCreateNumberPort(
|
|
489
|
-
numberRanges,
|
|
490
|
-
cloa,
|
|
491
489
|
companyName,
|
|
492
490
|
addressLine1,
|
|
493
491
|
addressLine2,
|
|
@@ -497,7 +495,9 @@ const { status, data } = await apiInstance.postCreateNumberPort(
|
|
|
497
495
|
tenantId,
|
|
498
496
|
requestedPortDate,
|
|
499
497
|
asap,
|
|
500
|
-
comment
|
|
498
|
+
comment,
|
|
499
|
+
numberRanges,
|
|
500
|
+
cloa
|
|
501
501
|
);
|
|
502
502
|
```
|
|
503
503
|
|
|
@@ -505,18 +505,18 @@ const { status, data } = await apiInstance.postCreateNumberPort(
|
|
|
505
505
|
|
|
506
506
|
|Name | Type | Description | Notes|
|
|
507
507
|
|------------- | ------------- | ------------- | -------------|
|
|
508
|
+
| **companyName** | [**string**] | Company Name | defaults to undefined|
|
|
509
|
+
| **addressLine1** | [**string**] | Address Line 1 | defaults to undefined|
|
|
510
|
+
| **addressLine2** | [**string**] | Address Line 2 | defaults to undefined|
|
|
511
|
+
| **city** | [**string**] | City | defaults to undefined|
|
|
512
|
+
| **postCode** | [**string**] | Post Code | defaults to undefined|
|
|
513
|
+
| **trunkId** | [**number**] | Trunk ID | defaults to undefined|
|
|
514
|
+
| **tenantId** | [**string**] | Starter Bundle ID | defaults to undefined|
|
|
515
|
+
| **requestedPortDate** | [**string**] | Requested Port Date | defaults to undefined|
|
|
516
|
+
| **asap** | [**boolean**] | Port Date ASAP | defaults to undefined|
|
|
517
|
+
| **comment** | [**string**] | Comment | defaults to undefined|
|
|
508
518
|
| **numberRanges** | **Array<NumberPortRangeRequestDTO>** | Number Ranges | defaults to undefined|
|
|
509
519
|
| **cloa** | [**File**] | CLOA (only provide on submission) | defaults to undefined|
|
|
510
|
-
| **companyName** | [**string**] | Company Name | (optional) defaults to undefined|
|
|
511
|
-
| **addressLine1** | [**string**] | Address Line 1 | (optional) defaults to undefined|
|
|
512
|
-
| **addressLine2** | [**string**] | Address Line 2 | (optional) defaults to undefined|
|
|
513
|
-
| **city** | [**string**] | City | (optional) defaults to undefined|
|
|
514
|
-
| **postCode** | [**string**] | Post Code | (optional) defaults to undefined|
|
|
515
|
-
| **trunkId** | [**number**] | Trunk ID | (optional) defaults to undefined|
|
|
516
|
-
| **tenantId** | [**string**] | Starter Bundle ID | (optional) defaults to undefined|
|
|
517
|
-
| **requestedPortDate** | [**string**] | Requested Port Date | (optional) defaults to undefined|
|
|
518
|
-
| **asap** | [**boolean**] | Port Date ASAP | (optional) defaults to undefined|
|
|
519
|
-
| **comment** | [**string**] | Comment | (optional) defaults to undefined|
|
|
520
520
|
|
|
521
521
|
|
|
522
522
|
### Return type
|
|
@@ -559,23 +559,21 @@ const configuration = new Configuration();
|
|
|
559
559
|
const apiInstance = new NumberPortingApi(configuration);
|
|
560
560
|
|
|
561
561
|
let id: number; //Number Port ID (default to undefined)
|
|
562
|
+
let companyName: string; //Company Name (default to undefined)
|
|
563
|
+
let addressLine1: string; //Address Line 1 (default to undefined)
|
|
564
|
+
let addressLine2: string; //Address Line 2 (default to undefined)
|
|
565
|
+
let city: string; //City (default to undefined)
|
|
566
|
+
let postCode: string; //Post Code (default to undefined)
|
|
567
|
+
let trunkId: number; //Trunk ID (default to undefined)
|
|
568
|
+
let tenantId: string; //Starter Bundle ID (default to undefined)
|
|
569
|
+
let requestedPortDate: string; //Requested Port Date (default to undefined)
|
|
570
|
+
let asap: boolean; //Port Date ASAP (default to undefined)
|
|
571
|
+
let comment: string; //Comment (default to undefined)
|
|
562
572
|
let numberRanges: Array<NumberPortRangeRequestDTO>; //Number Ranges (default to undefined)
|
|
563
573
|
let cloa: File; //CLOA (only provide on submission) (default to undefined)
|
|
564
|
-
let companyName: string; //Company Name (optional) (default to undefined)
|
|
565
|
-
let addressLine1: string; //Address Line 1 (optional) (default to undefined)
|
|
566
|
-
let addressLine2: string; //Address Line 2 (optional) (default to undefined)
|
|
567
|
-
let city: string; //City (optional) (default to undefined)
|
|
568
|
-
let postCode: string; //Post Code (optional) (default to undefined)
|
|
569
|
-
let trunkId: number; //Trunk ID (optional) (default to undefined)
|
|
570
|
-
let tenantId: string; //Starter Bundle ID (optional) (default to undefined)
|
|
571
|
-
let requestedPortDate: string; //Requested Port Date (optional) (default to undefined)
|
|
572
|
-
let asap: boolean; //Port Date ASAP (optional) (default to undefined)
|
|
573
|
-
let comment: string; //Comment (optional) (default to undefined)
|
|
574
574
|
|
|
575
575
|
const { status, data } = await apiInstance.postSubmitNumberPort(
|
|
576
576
|
id,
|
|
577
|
-
numberRanges,
|
|
578
|
-
cloa,
|
|
579
577
|
companyName,
|
|
580
578
|
addressLine1,
|
|
581
579
|
addressLine2,
|
|
@@ -585,7 +583,9 @@ const { status, data } = await apiInstance.postSubmitNumberPort(
|
|
|
585
583
|
tenantId,
|
|
586
584
|
requestedPortDate,
|
|
587
585
|
asap,
|
|
588
|
-
comment
|
|
586
|
+
comment,
|
|
587
|
+
numberRanges,
|
|
588
|
+
cloa
|
|
589
589
|
);
|
|
590
590
|
```
|
|
591
591
|
|
|
@@ -594,18 +594,18 @@ const { status, data } = await apiInstance.postSubmitNumberPort(
|
|
|
594
594
|
|Name | Type | Description | Notes|
|
|
595
595
|
|------------- | ------------- | ------------- | -------------|
|
|
596
596
|
| **id** | [**number**] | Number Port ID | defaults to undefined|
|
|
597
|
+
| **companyName** | [**string**] | Company Name | defaults to undefined|
|
|
598
|
+
| **addressLine1** | [**string**] | Address Line 1 | defaults to undefined|
|
|
599
|
+
| **addressLine2** | [**string**] | Address Line 2 | defaults to undefined|
|
|
600
|
+
| **city** | [**string**] | City | defaults to undefined|
|
|
601
|
+
| **postCode** | [**string**] | Post Code | defaults to undefined|
|
|
602
|
+
| **trunkId** | [**number**] | Trunk ID | defaults to undefined|
|
|
603
|
+
| **tenantId** | [**string**] | Starter Bundle ID | defaults to undefined|
|
|
604
|
+
| **requestedPortDate** | [**string**] | Requested Port Date | defaults to undefined|
|
|
605
|
+
| **asap** | [**boolean**] | Port Date ASAP | defaults to undefined|
|
|
606
|
+
| **comment** | [**string**] | Comment | defaults to undefined|
|
|
597
607
|
| **numberRanges** | **Array<NumberPortRangeRequestDTO>** | Number Ranges | defaults to undefined|
|
|
598
608
|
| **cloa** | [**File**] | CLOA (only provide on submission) | defaults to undefined|
|
|
599
|
-
| **companyName** | [**string**] | Company Name | (optional) defaults to undefined|
|
|
600
|
-
| **addressLine1** | [**string**] | Address Line 1 | (optional) defaults to undefined|
|
|
601
|
-
| **addressLine2** | [**string**] | Address Line 2 | (optional) defaults to undefined|
|
|
602
|
-
| **city** | [**string**] | City | (optional) defaults to undefined|
|
|
603
|
-
| **postCode** | [**string**] | Post Code | (optional) defaults to undefined|
|
|
604
|
-
| **trunkId** | [**number**] | Trunk ID | (optional) defaults to undefined|
|
|
605
|
-
| **tenantId** | [**string**] | Starter Bundle ID | (optional) defaults to undefined|
|
|
606
|
-
| **requestedPortDate** | [**string**] | Requested Port Date | (optional) defaults to undefined|
|
|
607
|
-
| **asap** | [**boolean**] | Port Date ASAP | (optional) defaults to undefined|
|
|
608
|
-
| **comment** | [**string**] | Comment | (optional) defaults to undefined|
|
|
609
609
|
|
|
610
610
|
|
|
611
611
|
### Return type
|
|
@@ -648,23 +648,21 @@ const configuration = new Configuration();
|
|
|
648
648
|
const apiInstance = new NumberPortingApi(configuration);
|
|
649
649
|
|
|
650
650
|
let id: number; //Number Port ID (default to undefined)
|
|
651
|
+
let companyName: string; //Company Name (default to undefined)
|
|
652
|
+
let addressLine1: string; //Address Line 1 (default to undefined)
|
|
653
|
+
let addressLine2: string; //Address Line 2 (default to undefined)
|
|
654
|
+
let city: string; //City (default to undefined)
|
|
655
|
+
let postCode: string; //Post Code (default to undefined)
|
|
656
|
+
let trunkId: number; //Trunk ID (default to undefined)
|
|
657
|
+
let tenantId: string; //Starter Bundle ID (default to undefined)
|
|
658
|
+
let requestedPortDate: string; //Requested Port Date (default to undefined)
|
|
659
|
+
let asap: boolean; //Port Date ASAP (default to undefined)
|
|
660
|
+
let comment: string; //Comment (default to undefined)
|
|
651
661
|
let numberRanges: Array<NumberPortRangeRequestDTO>; //Number Ranges (default to undefined)
|
|
652
662
|
let cloa: File; //CLOA (only provide on submission) (default to undefined)
|
|
653
|
-
let companyName: string; //Company Name (optional) (default to undefined)
|
|
654
|
-
let addressLine1: string; //Address Line 1 (optional) (default to undefined)
|
|
655
|
-
let addressLine2: string; //Address Line 2 (optional) (default to undefined)
|
|
656
|
-
let city: string; //City (optional) (default to undefined)
|
|
657
|
-
let postCode: string; //Post Code (optional) (default to undefined)
|
|
658
|
-
let trunkId: number; //Trunk ID (optional) (default to undefined)
|
|
659
|
-
let tenantId: string; //Starter Bundle ID (optional) (default to undefined)
|
|
660
|
-
let requestedPortDate: string; //Requested Port Date (optional) (default to undefined)
|
|
661
|
-
let asap: boolean; //Port Date ASAP (optional) (default to undefined)
|
|
662
|
-
let comment: string; //Comment (optional) (default to undefined)
|
|
663
663
|
|
|
664
664
|
const { status, data } = await apiInstance.postUpdateNumberPort(
|
|
665
665
|
id,
|
|
666
|
-
numberRanges,
|
|
667
|
-
cloa,
|
|
668
666
|
companyName,
|
|
669
667
|
addressLine1,
|
|
670
668
|
addressLine2,
|
|
@@ -674,7 +672,9 @@ const { status, data } = await apiInstance.postUpdateNumberPort(
|
|
|
674
672
|
tenantId,
|
|
675
673
|
requestedPortDate,
|
|
676
674
|
asap,
|
|
677
|
-
comment
|
|
675
|
+
comment,
|
|
676
|
+
numberRanges,
|
|
677
|
+
cloa
|
|
678
678
|
);
|
|
679
679
|
```
|
|
680
680
|
|
|
@@ -683,18 +683,18 @@ const { status, data } = await apiInstance.postUpdateNumberPort(
|
|
|
683
683
|
|Name | Type | Description | Notes|
|
|
684
684
|
|------------- | ------------- | ------------- | -------------|
|
|
685
685
|
| **id** | [**number**] | Number Port ID | defaults to undefined|
|
|
686
|
+
| **companyName** | [**string**] | Company Name | defaults to undefined|
|
|
687
|
+
| **addressLine1** | [**string**] | Address Line 1 | defaults to undefined|
|
|
688
|
+
| **addressLine2** | [**string**] | Address Line 2 | defaults to undefined|
|
|
689
|
+
| **city** | [**string**] | City | defaults to undefined|
|
|
690
|
+
| **postCode** | [**string**] | Post Code | defaults to undefined|
|
|
691
|
+
| **trunkId** | [**number**] | Trunk ID | defaults to undefined|
|
|
692
|
+
| **tenantId** | [**string**] | Starter Bundle ID | defaults to undefined|
|
|
693
|
+
| **requestedPortDate** | [**string**] | Requested Port Date | defaults to undefined|
|
|
694
|
+
| **asap** | [**boolean**] | Port Date ASAP | defaults to undefined|
|
|
695
|
+
| **comment** | [**string**] | Comment | defaults to undefined|
|
|
686
696
|
| **numberRanges** | **Array<NumberPortRangeRequestDTO>** | Number Ranges | defaults to undefined|
|
|
687
697
|
| **cloa** | [**File**] | CLOA (only provide on submission) | defaults to undefined|
|
|
688
|
-
| **companyName** | [**string**] | Company Name | (optional) defaults to undefined|
|
|
689
|
-
| **addressLine1** | [**string**] | Address Line 1 | (optional) defaults to undefined|
|
|
690
|
-
| **addressLine2** | [**string**] | Address Line 2 | (optional) defaults to undefined|
|
|
691
|
-
| **city** | [**string**] | City | (optional) defaults to undefined|
|
|
692
|
-
| **postCode** | [**string**] | Post Code | (optional) defaults to undefined|
|
|
693
|
-
| **trunkId** | [**number**] | Trunk ID | (optional) defaults to undefined|
|
|
694
|
-
| **tenantId** | [**string**] | Starter Bundle ID | (optional) defaults to undefined|
|
|
695
|
-
| **requestedPortDate** | [**string**] | Requested Port Date | (optional) defaults to undefined|
|
|
696
|
-
| **asap** | [**boolean**] | Port Date ASAP | (optional) defaults to undefined|
|
|
697
|
-
| **comment** | [**string**] | Comment | (optional) defaults to undefined|
|
|
698
698
|
|
|
699
699
|
|
|
700
700
|
### Return type
|
package/docs/OAuth20Api.md
CHANGED
|
@@ -122,18 +122,18 @@ import {
|
|
|
122
122
|
const configuration = new Configuration();
|
|
123
123
|
const apiInstance = new OAuth20Api(configuration);
|
|
124
124
|
|
|
125
|
-
let clientId: string; //OAuth 2.0 Client ID (
|
|
126
|
-
let clientSecret: string; //OAuth 2.0 Client Secret (
|
|
127
|
-
let grantType: string; //OAuth 2.0 Grant Type (
|
|
128
|
-
let scope: string; //OAuth 2.0 Scope (
|
|
129
|
-
let redirectUri: string; //OAuth 2.0 Redirect URI (
|
|
130
|
-
let code: string; //OAuth 2.0 Auth Code (
|
|
131
|
-
let refreshToken: string; //OAuth 2.0 Refresh Token (
|
|
132
|
-
let codeVerifier: string; //OAuth 2.0 Code Verifier (
|
|
133
|
-
let token: string; //OAuth 2.0 Token (Only used in Token Exchange) (
|
|
134
|
-
let tokenExchangeType: string; //Token Exchange Type (Only used in Token Exchange) (
|
|
135
|
-
let licenceKey: string; //3CX Licence Key (Only used in Token Exchange) (
|
|
136
|
-
let endUser: boolean; //End User (Only used in Token Exchange) (
|
|
125
|
+
let clientId: string; //OAuth 2.0 Client ID (default to undefined)
|
|
126
|
+
let clientSecret: string; //OAuth 2.0 Client Secret (default to undefined)
|
|
127
|
+
let grantType: string; //OAuth 2.0 Grant Type (default to undefined)
|
|
128
|
+
let scope: string; //OAuth 2.0 Scope (default to undefined)
|
|
129
|
+
let redirectUri: string; //OAuth 2.0 Redirect URI (default to undefined)
|
|
130
|
+
let code: string; //OAuth 2.0 Auth Code (default to undefined)
|
|
131
|
+
let refreshToken: string; //OAuth 2.0 Refresh Token (default to undefined)
|
|
132
|
+
let codeVerifier: string; //OAuth 2.0 Code Verifier (default to undefined)
|
|
133
|
+
let token: string; //OAuth 2.0 Token (Only used in Token Exchange) (default to undefined)
|
|
134
|
+
let tokenExchangeType: string; //Token Exchange Type (Only used in Token Exchange) (default to undefined)
|
|
135
|
+
let licenceKey: string; //3CX Licence Key (Only used in Token Exchange) (default to undefined)
|
|
136
|
+
let endUser: boolean; //End User (Only used in Token Exchange) (default to undefined)
|
|
137
137
|
|
|
138
138
|
const { status, data } = await apiInstance.postAccessToken(
|
|
139
139
|
clientId,
|
|
@@ -155,18 +155,18 @@ const { status, data } = await apiInstance.postAccessToken(
|
|
|
155
155
|
|
|
156
156
|
|Name | Type | Description | Notes|
|
|
157
157
|
|------------- | ------------- | ------------- | -------------|
|
|
158
|
-
| **clientId** | [**string**] | OAuth 2.0 Client ID |
|
|
159
|
-
| **clientSecret** | [**string**] | OAuth 2.0 Client Secret |
|
|
160
|
-
| **grantType** | [**string**]**Array<'client_credentials' | 'code' | 'refresh_token' | 'authorization_code' | 'ms_auth' | 'token_exchange' | 'password'>** | OAuth 2.0 Grant Type |
|
|
161
|
-
| **scope** | [**string**]**Array<'*' | 'fdps' | 'scope' | 'portal' | 'tcx_wizard' | 'accounts.read' | 'accounts.write' | 'number_porting.read' | 'number_porting.write' | 'pricing.read' | 'orders.read' | 'orders.write' | 'products.read' | 'provisioning.read' | 'provisioning.write' | 'rma.read' | 'rma.write' | 'sms.read' | 'sms.write' | 'trunks.read' | 'trunks.write' | 'tcx_integrations.read' | 'tcx_integrations.write' | 'tcx_licence_details.read' | 'tcx_installations.read' | 'tcx_installations.write' | 'tcx_mt.read' | 'tcx_mt.write' | 'tickets.read' | 'tickets.write'>** | OAuth 2.0 Scope |
|
|
162
|
-
| **redirectUri** | [**string**] | OAuth 2.0 Redirect URI |
|
|
163
|
-
| **code** | [**string**] | OAuth 2.0 Auth Code |
|
|
164
|
-
| **refreshToken** | [**string**] | OAuth 2.0 Refresh Token |
|
|
165
|
-
| **codeVerifier** | [**string**] | OAuth 2.0 Code Verifier |
|
|
166
|
-
| **token** | [**string**] | OAuth 2.0 Token (Only used in Token Exchange) |
|
|
167
|
-
| **tokenExchangeType** | [**string**]**Array<'tcx_wizard' | 'portal'>** | Token Exchange Type (Only used in Token Exchange) |
|
|
168
|
-
| **licenceKey** | [**string**] | 3CX Licence Key (Only used in Token Exchange) |
|
|
169
|
-
| **endUser** | [**boolean**] | End User (Only used in Token Exchange) |
|
|
158
|
+
| **clientId** | [**string**] | OAuth 2.0 Client ID | defaults to undefined|
|
|
159
|
+
| **clientSecret** | [**string**] | OAuth 2.0 Client Secret | defaults to undefined|
|
|
160
|
+
| **grantType** | [**string**]**Array<'client_credentials' | 'code' | 'refresh_token' | 'authorization_code' | 'ms_auth' | 'token_exchange' | 'password'>** | OAuth 2.0 Grant Type | defaults to undefined|
|
|
161
|
+
| **scope** | [**string**]**Array<'*' | 'fdps' | 'scope' | 'portal' | 'tcx_wizard' | 'accounts.read' | 'accounts.write' | 'number_porting.read' | 'number_porting.write' | 'pricing.read' | 'orders.read' | 'orders.write' | 'products.read' | 'provisioning.read' | 'provisioning.write' | 'rma.read' | 'rma.write' | 'sms.read' | 'sms.write' | 'trunks.read' | 'trunks.write' | 'tcx_integrations.read' | 'tcx_integrations.write' | 'tcx_licence_details.read' | 'tcx_installations.read' | 'tcx_installations.write' | 'tcx_mt.read' | 'tcx_mt.write' | 'tickets.read' | 'tickets.write'>** | OAuth 2.0 Scope | defaults to undefined|
|
|
162
|
+
| **redirectUri** | [**string**] | OAuth 2.0 Redirect URI | defaults to undefined|
|
|
163
|
+
| **code** | [**string**] | OAuth 2.0 Auth Code | defaults to undefined|
|
|
164
|
+
| **refreshToken** | [**string**] | OAuth 2.0 Refresh Token | defaults to undefined|
|
|
165
|
+
| **codeVerifier** | [**string**] | OAuth 2.0 Code Verifier | defaults to undefined|
|
|
166
|
+
| **token** | [**string**] | OAuth 2.0 Token (Only used in Token Exchange) | defaults to undefined|
|
|
167
|
+
| **tokenExchangeType** | [**string**]**Array<'tcx_wizard' | 'portal'>** | Token Exchange Type (Only used in Token Exchange) | defaults to undefined|
|
|
168
|
+
| **licenceKey** | [**string**] | 3CX Licence Key (Only used in Token Exchange) | defaults to undefined|
|
|
169
|
+
| **endUser** | [**boolean**] | End User (Only used in Token Exchange) | defaults to undefined|
|
|
170
170
|
|
|
171
171
|
|
|
172
172
|
### Return type
|
package/docs/OpayoRedirectDTO.md
CHANGED
|
@@ -6,11 +6,11 @@ Opayo Redirect
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**acsUrl** | **string** | acsUrl | [
|
|
10
|
-
**paReq** | **string** | paReq | [
|
|
11
|
-
**transactionId** | **string** | Transaction ID | [
|
|
12
|
-
**dsTranId** | **string** | dsTranId | [
|
|
13
|
-
**cReq** | **string** | cReq | [
|
|
9
|
+
**acsUrl** | **string** | acsUrl | [default to undefined]
|
|
10
|
+
**paReq** | **string** | paReq | [default to undefined]
|
|
11
|
+
**transactionId** | **string** | Transaction ID | [default to undefined]
|
|
12
|
+
**dsTranId** | **string** | dsTranId | [default to undefined]
|
|
13
|
+
**cReq** | **string** | cReq | [default to undefined]
|
|
14
14
|
|
|
15
15
|
## Example
|
|
16
16
|
|
package/docs/OrderDetailsDTO.md
CHANGED
|
@@ -7,20 +7,20 @@ Order Details
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
9
|
**id** | **number** | ID | [default to undefined]
|
|
10
|
-
**reference** | **string** | Reference | [
|
|
10
|
+
**reference** | **string** | Reference | [default to undefined]
|
|
11
11
|
**invoiceNumber** | **string** | Invoice Number | [default to undefined]
|
|
12
|
-
**invoiceId** | **string** | Invoice ID | [
|
|
12
|
+
**invoiceId** | **string** | Invoice ID | [default to undefined]
|
|
13
13
|
**orderDate** | **string** | Date Time | [default to undefined]
|
|
14
14
|
**paid** | **boolean** | Paid | [default to undefined]
|
|
15
15
|
**complete** | **boolean** | Complete | [default to undefined]
|
|
16
16
|
**quote** | **boolean** | Quote | [default to undefined]
|
|
17
17
|
**customer** | [**AccountSummaryDTO**](AccountSummaryDTO.md) | | [default to undefined]
|
|
18
|
-
**shippingAddress** | [**AddressModel**](AddressModel.md) | | [
|
|
18
|
+
**shippingAddress** | [**AddressModel**](AddressModel.md) | | [default to undefined]
|
|
19
19
|
**items** | [**Array<ItemDTO>**](ItemDTO.md) | Items | [default to undefined]
|
|
20
20
|
**carriageCharge** | **number** | Carriage Charge | [default to undefined]
|
|
21
|
-
**fulfillable** | **boolean** | Fulfillable | [
|
|
22
|
-
**provisioningUrl** | **string** | Provisioning URL | [
|
|
23
|
-
**shippingService** | [**ShippingServiceDTO**](ShippingServiceDTO.md) | | [
|
|
21
|
+
**fulfillable** | **boolean** | Fulfillable | [default to undefined]
|
|
22
|
+
**provisioningUrl** | **string** | Provisioning URL | [default to undefined]
|
|
23
|
+
**shippingService** | [**ShippingServiceDTO**](ShippingServiceDTO.md) | | [default to undefined]
|
|
24
24
|
**readonly** | **boolean** | Readonly | [default to undefined]
|
|
25
25
|
**detailedItems** | [**Array<OrderItemDTO>**](OrderItemDTO.md) | Detailed Items | [optional] [default to undefined]
|
|
26
26
|
**batches** | [**Array<BatchDTO>**](BatchDTO.md) | Batches | [optional] [default to undefined]
|
package/docs/OrderEntity.md
CHANGED
|
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
|
|
|
10
10
|
**reference** | **string** | externalId | [default to undefined]
|
|
11
11
|
**sourceId** | **number** | sourceId | [default to undefined]
|
|
12
12
|
**invoiceNumber** | **string** | sageInv | [default to undefined]
|
|
13
|
-
**invoiceId** | **string** | invoiceId | [
|
|
13
|
+
**invoiceId** | **string** | invoiceId | [default to undefined]
|
|
14
14
|
**customerId** | **number** | creditAccountId | [default to undefined]
|
|
15
15
|
**orderDate** | **string** | orderDate | [default to undefined]
|
|
16
16
|
**orderPostedDate** | **string** | orderPostedDate | [default to undefined]
|
|
@@ -63,7 +63,7 @@ Name | Type | Description | Notes
|
|
|
63
63
|
**uniqueId** | **string** | uniqueId | [default to undefined]
|
|
64
64
|
**notes** | **string** | notes | [default to undefined]
|
|
65
65
|
**promocode** | **string** | promocode | [default to undefined]
|
|
66
|
-
**fulfillable** | **boolean** | fulfillable | [
|
|
66
|
+
**fulfillable** | **boolean** | fulfillable | [default to undefined]
|
|
67
67
|
|
|
68
68
|
## Example
|
|
69
69
|
|
|
@@ -6,19 +6,19 @@ EdTechPro Order Request
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**clientId** | **number** | Client/Trust ID | [
|
|
10
|
-
**clientName** | **string** | Client/Trust Name | [
|
|
11
|
-
**clientContactName** | **string** | Client/Trust Contact Name | [
|
|
12
|
-
**clientContactEmail** | **string** | Client/Trust Contact Email | [
|
|
13
|
-
**terms** | **boolean** | Agreed to Terms and Conditions | [
|
|
9
|
+
**clientId** | **number** | Client/Trust ID | [default to undefined]
|
|
10
|
+
**clientName** | **string** | Client/Trust Name | [default to undefined]
|
|
11
|
+
**clientContactName** | **string** | Client/Trust Contact Name | [default to undefined]
|
|
12
|
+
**clientContactEmail** | **string** | Client/Trust Contact Email | [default to undefined]
|
|
13
|
+
**terms** | **boolean** | Agreed to Terms and Conditions | [default to undefined]
|
|
14
14
|
**schoolName** | **string** | School Name | [default to undefined]
|
|
15
15
|
**dfECode** | **string** | School DfE Code | [default to undefined]
|
|
16
16
|
**schoolContactName** | **string** | School Technical Contact Name | [default to undefined]
|
|
17
17
|
**schoolContactEmail** | **string** | School Technical Contact Email | [default to undefined]
|
|
18
18
|
**licenceType** | **string** | Licence Type | [default to undefined]
|
|
19
19
|
**schoolType** | **string** | School Type | [default to undefined]
|
|
20
|
-
**instanceId** | **string** | InstanceId | [
|
|
21
|
-
**orderReference** | **string** | Order Reference | [
|
|
20
|
+
**instanceId** | **string** | InstanceId | [default to undefined]
|
|
21
|
+
**orderReference** | **string** | Order Reference | [default to undefined]
|
|
22
22
|
|
|
23
23
|
## Example
|
|
24
24
|
|
package/docs/OrderResponseDTO.md
CHANGED
|
@@ -6,9 +6,9 @@ Legacy Portal Response
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**url** | **string** | URL | [
|
|
10
|
-
**orderID** | **string** | Order ID | [
|
|
11
|
-
**uniqueID** | **string** | Unique ID | [
|
|
9
|
+
**url** | **string** | URL | [default to undefined]
|
|
10
|
+
**orderID** | **string** | Order ID | [default to undefined]
|
|
11
|
+
**uniqueID** | **string** | Unique ID | [default to undefined]
|
|
12
12
|
|
|
13
13
|
## Example
|
|
14
14
|
|
package/docs/OrderSummaryDTO.md
CHANGED
|
@@ -7,20 +7,20 @@ Order Summary
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
9
|
**id** | **number** | ID | [default to undefined]
|
|
10
|
-
**reference** | **string** | Reference | [
|
|
10
|
+
**reference** | **string** | Reference | [default to undefined]
|
|
11
11
|
**invoiceNumber** | **string** | Invoice Number | [default to undefined]
|
|
12
|
-
**invoiceId** | **string** | Invoice ID | [
|
|
12
|
+
**invoiceId** | **string** | Invoice ID | [default to undefined]
|
|
13
13
|
**orderDate** | **string** | Date Time | [default to undefined]
|
|
14
14
|
**paid** | **boolean** | Paid | [default to undefined]
|
|
15
15
|
**complete** | **boolean** | Complete | [default to undefined]
|
|
16
16
|
**quote** | **boolean** | Quote | [default to undefined]
|
|
17
17
|
**customer** | [**AccountSummaryDTO**](AccountSummaryDTO.md) | | [default to undefined]
|
|
18
|
-
**shippingAddress** | [**AddressModel**](AddressModel.md) | | [
|
|
18
|
+
**shippingAddress** | [**AddressModel**](AddressModel.md) | | [default to undefined]
|
|
19
19
|
**items** | [**Array<ItemDTO>**](ItemDTO.md) | Items | [default to undefined]
|
|
20
20
|
**carriageCharge** | **number** | Carriage Charge | [default to undefined]
|
|
21
|
-
**fulfillable** | **boolean** | Fulfillable | [
|
|
22
|
-
**provisioningUrl** | **string** | Provisioning URL | [
|
|
23
|
-
**shippingService** | [**ShippingServiceDTO**](ShippingServiceDTO.md) | | [
|
|
21
|
+
**fulfillable** | **boolean** | Fulfillable | [default to undefined]
|
|
22
|
+
**provisioningUrl** | **string** | Provisioning URL | [default to undefined]
|
|
23
|
+
**shippingService** | [**ShippingServiceDTO**](ShippingServiceDTO.md) | | [default to undefined]
|
|
24
24
|
**readonly** | **boolean** | Readonly | [default to undefined]
|
|
25
25
|
|
|
26
26
|
## Example
|
package/docs/OrderTotalModel.md
CHANGED
|
@@ -13,7 +13,7 @@ Name | Type | Description | Notes
|
|
|
13
13
|
**vatRate** | **number** | VAT Rate | [default to undefined]
|
|
14
14
|
**credit** | **number** | Credit | [default to undefined]
|
|
15
15
|
**currency** | **string** | Currency | [default to undefined]
|
|
16
|
-
**delivery** | **number** | Delivery | [
|
|
16
|
+
**delivery** | **number** | Delivery | [default to undefined]
|
|
17
17
|
|
|
18
18
|
## Example
|
|
19
19
|
|
package/docs/PartnerDTO.md
CHANGED
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**partnerId** | **string** | 3CX Partner ID | [
|
|
9
|
+
**partnerId** | **string** | 3CX Partner ID | [default to undefined]
|
|
10
10
|
**companyName** | **string** | 3CX Partner Company Name | [default to undefined]
|
|
11
11
|
**contactName** | **string** | 3CX Partner Contact Name | [default to undefined]
|
|
12
12
|
**contactPhone** | **string** | 3CX Partner Contact Phone | [default to undefined]
|
|
@@ -17,7 +17,7 @@ Name | Type | Description | Notes
|
|
|
17
17
|
**hostingPriceListId** | **number** | 3CX Hosting Price List ID | [default to undefined]
|
|
18
18
|
**installationUrl** | **string** | 3CX Installation URL | [default to undefined]
|
|
19
19
|
**aligned** | **boolean** | Aligned | [default to undefined]
|
|
20
|
-
**customer** | [**AccountSummaryDTO**](AccountSummaryDTO.md) | Customer | [
|
|
20
|
+
**customer** | [**AccountSummaryDTO**](AccountSummaryDTO.md) | Customer | [default to undefined]
|
|
21
21
|
|
|
22
22
|
## Example
|
|
23
23
|
|
|
@@ -7,14 +7,14 @@ Password Sender Request
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
9
|
**username** | **string** | Username | [default to undefined]
|
|
10
|
-
**password** | **string** | Password | [
|
|
11
|
-
**expiryInterval** | **number** | Expiry Interval | [
|
|
12
|
-
**intervalType** | **string** | Interval Type | [
|
|
13
|
-
**expiry** | **string** | Expiry | [
|
|
10
|
+
**password** | **string** | Password | [default to undefined]
|
|
11
|
+
**expiryInterval** | **number** | Expiry Interval | [default to undefined]
|
|
12
|
+
**intervalType** | **string** | Interval Type | [default to undefined]
|
|
13
|
+
**expiry** | **string** | Expiry | [default to undefined]
|
|
14
14
|
**recipient** | **Array<string>** | Recipient | [default to undefined]
|
|
15
|
-
**url** | **string** | URL | [
|
|
16
|
-
**description** | **string** | Description | [
|
|
17
|
-
**passwordUrl** | **string** | Password URL | [
|
|
15
|
+
**url** | **string** | URL | [default to undefined]
|
|
16
|
+
**description** | **string** | Description | [default to undefined]
|
|
17
|
+
**passwordUrl** | **string** | Password URL | [default to undefined]
|
|
18
18
|
|
|
19
19
|
## Example
|
|
20
20
|
|
|
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
|
|
|
10
10
|
**yAxis** | [**Array<AxisDataDTO>**](AxisDataDTO.md) | Y Axis | [default to undefined]
|
|
11
11
|
**legend** | **Array<string>** | Legend | [default to undefined]
|
|
12
12
|
**series** | [**Array<SeriesDTO>**](SeriesDTO.md) | Series | [default to undefined]
|
|
13
|
-
**currency** | **string** | Currency | [
|
|
13
|
+
**currency** | **string** | Currency | [default to undefined]
|
|
14
14
|
**locale** | **string** | Locale | [default to undefined]
|
|
15
15
|
**headers** | [**TableRowDTO**](TableRowDTO.md) | | [default to undefined]
|
|
16
16
|
**rows** | [**Array<TableRowDTO>**](TableRowDTO.md) | Rows | [default to undefined]
|
|
@@ -7,10 +7,10 @@ Price & Stock List
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
9
|
**title** | **string** | Title | [default to undefined]
|
|
10
|
-
**sku** | **string** | SKU | [
|
|
10
|
+
**sku** | **string** | SKU | [default to undefined]
|
|
11
11
|
**price** | **number** | Price | [default to undefined]
|
|
12
|
-
**rrp** | **number** | RRP | [
|
|
13
|
-
**stock** | **number** | Stock | [
|
|
12
|
+
**rrp** | **number** | RRP | [default to undefined]
|
|
13
|
+
**stock** | **number** | Stock | [default to undefined]
|
|
14
14
|
|
|
15
15
|
## Example
|
|
16
16
|
|
|
@@ -7,10 +7,10 @@ Product Price List Item
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
9
|
**title** | **string** | Title | [default to undefined]
|
|
10
|
-
**sku** | **string** | SKU | [
|
|
10
|
+
**sku** | **string** | SKU | [default to undefined]
|
|
11
11
|
**price** | **number** | Price | [default to undefined]
|
|
12
|
-
**rrp** | **number** | RRP | [
|
|
13
|
-
**stock** | **number** | Stock | [
|
|
12
|
+
**rrp** | **number** | RRP | [default to undefined]
|
|
13
|
+
**stock** | **number** | Stock | [default to undefined]
|
|
14
14
|
**brand** | **string** | Brand | [optional] [default to undefined]
|
|
15
15
|
|
|
16
16
|
## Example
|
|
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
|
|
|
9
9
|
**sku** | **string** | SKU | [default to undefined]
|
|
10
10
|
**title** | **string** | Product Title | [default to undefined]
|
|
11
11
|
**mac** | **boolean** | Has MAC Address | [default to undefined]
|
|
12
|
-
**serial_prefixes** | **Array<string>** | Serial Prefix | [
|
|
12
|
+
**serial_prefixes** | **Array<string>** | Serial Prefix | [default to undefined]
|
|
13
13
|
|
|
14
14
|
## Example
|
|
15
15
|
|
package/docs/ProspectDTO.md
CHANGED
|
@@ -7,9 +7,9 @@ Prospect
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
9
|
**companyName** | **string** | Company Name | [default to undefined]
|
|
10
|
-
**telephone** | **string** | Telephone | [
|
|
11
|
-
**lastOrderDate** | **string** | Last Order Date | [
|
|
12
|
-
**callbackDate** | **string** | Call Back Date | [
|
|
10
|
+
**telephone** | **string** | Telephone | [default to undefined]
|
|
11
|
+
**lastOrderDate** | **string** | Last Order Date | [default to undefined]
|
|
12
|
+
**callbackDate** | **string** | Call Back Date | [default to undefined]
|
|
13
13
|
**xeroId** | **string** | Xero ID | [default to undefined]
|
|
14
14
|
**removed** | **boolean** | Removed From Prospects | [default to undefined]
|
|
15
15
|
**status** | **string** | Status | [default to undefined]
|
|
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
|
|
|
10
10
|
**key** | **string** | Storage Account Key | [default to undefined]
|
|
11
11
|
**connection_string** | **string** | Storage Account Connection String | [default to undefined]
|
|
12
12
|
**sasUrl** | **string** | SAS Url | [default to undefined]
|
|
13
|
-
**recordings_path** | **string** | Recordings Path | [
|
|
13
|
+
**recordings_path** | **string** | Recordings Path | [default to undefined]
|
|
14
14
|
|
|
15
15
|
## Example
|
|
16
16
|
|
|
@@ -6,8 +6,8 @@ Recordings Backup Info
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**backup** | [**RecordingBackupAzureModel**](RecordingBackupAzureModel.md) | Azure Backup Storage | [
|
|
10
|
-
**storage** | [**TcxRemoteStorageModel**](TcxRemoteStorageModel.md) | 3CX Remote Storage | [
|
|
9
|
+
**backup** | [**RecordingBackupAzureModel**](RecordingBackupAzureModel.md) | Azure Backup Storage | [default to undefined]
|
|
10
|
+
**storage** | [**TcxRemoteStorageModel**](TcxRemoteStorageModel.md) | 3CX Remote Storage | [default to undefined]
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|
package/docs/ReportRequestDTO.md
CHANGED
|
@@ -7,14 +7,14 @@ Report Request
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
9
|
**report** | **string** | Report | [default to undefined]
|
|
10
|
-
**start** | **string** | Start | [
|
|
11
|
-
**end** | **string** | End | [
|
|
12
|
-
**month** | **number** | Month | [
|
|
13
|
-
**year** | **number** | Year | [
|
|
14
|
-
**sku** | **string** | SKU | [
|
|
15
|
-
**price** | **number** | Price | [
|
|
16
|
-
**recipients** | **Array<string>** | Recipients | [
|
|
17
|
-
**graphType** | **string** | Graph Type | [
|
|
10
|
+
**start** | **string** | Start | [default to undefined]
|
|
11
|
+
**end** | **string** | End | [default to undefined]
|
|
12
|
+
**month** | **number** | Month | [default to undefined]
|
|
13
|
+
**year** | **number** | Year | [default to undefined]
|
|
14
|
+
**sku** | **string** | SKU | [default to undefined]
|
|
15
|
+
**price** | **number** | Price | [default to undefined]
|
|
16
|
+
**recipients** | **Array<string>** | Recipients | [default to undefined]
|
|
17
|
+
**graphType** | **string** | Graph Type | [default to undefined]
|
|
18
18
|
|
|
19
19
|
## Example
|
|
20
20
|
|
package/docs/RmaDTO.md
CHANGED
|
@@ -17,7 +17,7 @@ Name | Type | Description | Notes
|
|
|
17
17
|
**status** | **number** | RMA Status | [default to undefined]
|
|
18
18
|
**statusText** | **string** | RMA Status Text | [default to undefined]
|
|
19
19
|
**approved** | **boolean** | RMA Approval Status | [default to undefined]
|
|
20
|
-
**address** | [**AddressDTO**](AddressDTO.md) |
|
|
20
|
+
**address** | [**AddressDTO**](AddressDTO.md) | | [default to undefined]
|
|
21
21
|
**items** | [**Array<RmaItemDTO>**](RmaItemDTO.md) | RMA Items | [default to undefined]
|
|
22
22
|
|
|
23
23
|
## Example
|
package/docs/RmaItemDTO.md
CHANGED
|
@@ -9,8 +9,8 @@ Name | Type | Description | Notes
|
|
|
9
9
|
**id** | **number** | RMA Item ID | [default to undefined]
|
|
10
10
|
**itemId** | **number** | RMA Order Item ID | [default to undefined]
|
|
11
11
|
**itemName** | **string** | RMA Item Name | [default to undefined]
|
|
12
|
-
**macAddress** | **string** | RMA Item MAC Address | [
|
|
13
|
-
**serialNumber** | **string** | RMA Item Serial Number | [
|
|
12
|
+
**macAddress** | **string** | RMA Item MAC Address | [default to undefined]
|
|
13
|
+
**serialNumber** | **string** | RMA Item Serial Number | [default to undefined]
|
|
14
14
|
**received** | **boolean** | RMA Item Received Status | [default to undefined]
|
|
15
15
|
**status** | **number** | RMA Item Status | [default to undefined]
|
|
16
16
|
**statusText** | **string** | RMA Item Status Text | [default to undefined]
|
|
@@ -7,8 +7,8 @@ RMA Request Item
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
9
|
**itemId** | **number** | RMA Item ID | [default to undefined]
|
|
10
|
-
**macAddress** | **string** | RMA Item MAC Address | [
|
|
11
|
-
**serialNumber** | **string** | RMA Item Serial Number | [
|
|
10
|
+
**macAddress** | **string** | RMA Item MAC Address | [default to undefined]
|
|
11
|
+
**serialNumber** | **string** | RMA Item Serial Number | [default to undefined]
|
|
12
12
|
|
|
13
13
|
## Example
|
|
14
14
|
|