yellowgrid-api-ts 3.2.200 → 3.2.201-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.
Files changed (99) hide show
  1. package/.openapi-generator/FILES +312 -296
  2. package/.openapi-generator/VERSION +1 -1
  3. package/README.md +28 -2
  4. package/api.ts +7139 -612
  5. package/base.ts +26 -2
  6. package/common.ts +39 -16
  7. package/config.json +3 -3
  8. package/configuration.ts +21 -27
  9. package/dist/api.d.ts +5948 -84
  10. package/dist/api.js +1964 -501
  11. package/dist/base.d.ts +25 -1
  12. package/dist/base.js +21 -2
  13. package/dist/common.d.ts +36 -5
  14. package/dist/common.js +39 -17
  15. package/dist/configuration.d.ts +18 -25
  16. package/dist/configuration.js +4 -4
  17. package/dist/index.d.ts +1 -1
  18. package/dist/index.js +1 -1
  19. package/dist/models/GroupEnum.d.ts +43 -0
  20. package/dist/models/GroupEnum.js +45 -0
  21. package/dist/models/HostingPriceListEnum.d.ts +5 -0
  22. package/dist/models/HostingPriceListEnum.js +5 -0
  23. package/dist/models/ReportEnum.d.ts +43 -0
  24. package/dist/models/ReportEnum.js +45 -0
  25. package/docs/AbstractItemDiscountModel.md +21 -0
  26. package/docs/AbstractOrderRequestDTO.md +1 -1
  27. package/docs/AccountsApi.md +115 -1
  28. package/docs/AdminOrderRequestDTO.md +1 -1
  29. package/docs/AxisDataDTO.md +25 -0
  30. package/docs/BillingApi.md +1 -1
  31. package/docs/CRMApi.md +1 -1
  32. package/docs/Class3CXApi.md +1 -1
  33. package/docs/Class3CXInstallationWizardApi.md +1 -1
  34. package/docs/Class3CXInstallationsApi.md +1 -1
  35. package/docs/Class3CXIntegrationsApi.md +1 -1
  36. package/docs/Class3CXMultiTenantApi.md +1 -1
  37. package/docs/CrmActivityDTO.md +3 -3
  38. package/docs/CrmDateActivitiesDTO.md +1 -1
  39. package/docs/CustomerOrderRequestDTO.md +1 -1
  40. package/docs/DetailedOrderRequestDTO.md +1 -1
  41. package/docs/GetCheckMacExists200Response.md +20 -0
  42. package/docs/GraphDTO.md +29 -0
  43. package/docs/MacAddressDTO.md +23 -0
  44. package/docs/MiscApi.md +63 -0
  45. package/docs/MyPBXToolsApi.md +1 -1
  46. package/docs/NumberPortModel.md +51 -0
  47. package/docs/NumberPortingApi.md +1 -1
  48. package/docs/OAuth20Api.md +1 -1
  49. package/docs/OrdersApi.md +1 -1
  50. package/docs/PartnerDTO.md +1 -1
  51. package/docs/PasswordSenderDTO.md +37 -0
  52. package/docs/PasswordSenderEntity.md +33 -0
  53. package/docs/PatchSetTcxWizardCnameRequest.md +20 -0
  54. package/docs/PatchUpdateAccountNameRequest.md +20 -0
  55. package/docs/PostAddAdminNoteRequest.md +20 -0
  56. package/docs/PostGetProductRequest.md +24 -0
  57. package/docs/PricingApi.md +1 -1
  58. package/docs/ProductDetailedSummaryDTO.md +41 -0
  59. package/docs/ProductSearchDTO.md +37 -0
  60. package/docs/ProductSummaryDTO.md +1 -3
  61. package/docs/ProductsApi.md +5 -5
  62. package/docs/ProspectDTO.md +2 -2
  63. package/docs/ProspectsApi.md +1 -1
  64. package/docs/ProvisioningApi.md +167 -1
  65. package/docs/RecordingsBackupInfoDTO.md +2 -2
  66. package/docs/ReportRequestDTO.md +37 -0
  67. package/docs/ReportsApi.md +107 -0
  68. package/docs/SIPTrunksApi.md +1 -1
  69. package/docs/SMSApi.md +1 -1
  70. package/docs/SeriesDTO.md +27 -0
  71. package/docs/ServicesApi.md +1 -1
  72. package/docs/ShipmentRequestDTO.md +2 -2
  73. package/docs/ShippingApi.md +1 -1
  74. package/docs/StockManagementApi.md +1 -1
  75. package/docs/StockReportItemModel.md +31 -0
  76. package/docs/StockReportModel.md +29 -0
  77. package/docs/SupplierItemModel.md +2 -0
  78. package/docs/SupplierItemsResultsDTO.md +21 -0
  79. package/docs/SupplierProductModel.md +25 -0
  80. package/docs/SupplierProductResultsModel.md +27 -0
  81. package/docs/SuppliersApi.md +230 -0
  82. package/docs/SystemApi.md +1 -1
  83. package/docs/TcxInstallationDetailsModel.md +45 -0
  84. package/docs/TcxInstallationModel.md +6 -0
  85. package/docs/TcxKeySummaryDTO.md +1 -1
  86. package/docs/TelephonySupportTicketModel.md +41 -0
  87. package/docs/TicketsApi.md +1 -1
  88. package/docs/WebhooksApi.md +1 -1
  89. package/getEnums.php +31 -31
  90. package/hs_err_pid16044.log +249 -0
  91. package/hs_err_pid44560.log +249 -0
  92. package/hs_err_pid53988.log +249 -0
  93. package/hs_err_pid58728.log +40 -0
  94. package/index.ts +1 -1
  95. package/models/GroupEnum.ts +44 -0
  96. package/models/HostingPriceListEnum.ts +5 -0
  97. package/models/ReportEnum.ts +44 -0
  98. package/openapitools.json +1 -1
  99. package/package.json +2 -2
@@ -0,0 +1,45 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.ReportEnum = void 0;
4
+ exports.ReportEnum = {
5
+ "STOCK": {
6
+ "name": "STOCK",
7
+ "value": 1,
8
+ "publicValue": "Stock"
9
+ },
10
+ "POS": {
11
+ "name": "POS",
12
+ "value": 2,
13
+ "publicValue": "POS"
14
+ },
15
+ "CUSTOMER_SPEND": {
16
+ "name": "CUSTOMER_SPEND",
17
+ "value": 3,
18
+ "publicValue": "Customer Spend"
19
+ },
20
+ "MONTHLY_SALES": {
21
+ "name": "MONTHLY_SALES",
22
+ "value": 4,
23
+ "publicValue": "Monthly Sales"
24
+ },
25
+ "CUSTOMER_ANNUAL_COMPARISON": {
26
+ "name": "CUSTOMER_ANNUAL_COMPARISON",
27
+ "value": 5,
28
+ "publicValue": "Customer Annual Comparison"
29
+ },
30
+ "LOW_STOCK": {
31
+ "name": "LOW_STOCK",
32
+ "value": 6,
33
+ "publicValue": "Low Stock"
34
+ },
35
+ "LEAGUE_TABLE": {
36
+ "name": "LEAGUE_TABLE",
37
+ "value": 7,
38
+ "publicValue": "League Table"
39
+ },
40
+ "REVENUE": {
41
+ "name": "REVENUE",
42
+ "value": 8,
43
+ "publicValue": "Revenue"
44
+ }
45
+ };
@@ -0,0 +1,21 @@
1
+ # AbstractItemDiscountModel
2
+
3
+ Item Discount
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **description** | **string** | Description | [optional] [default to undefined]
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import { AbstractItemDiscountModel } from 'yellowgrid-api-ts';
15
+
16
+ const instance: AbstractItemDiscountModel = {
17
+ description,
18
+ };
19
+ ```
20
+
21
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
10
10
  **items** | [**Array<CustomerItemRequestDTO>**](CustomerItemRequestDTO.md) | Items | [optional] [default to undefined]
11
11
  **shippingService** | [**ShippingServiceDTO**](ShippingServiceDTO.md) | | [optional] [default to undefined]
12
12
  **provisioningUrl** | **string** | Provisioning URL | [optional] [default to undefined]
13
- **shippingAddress** | [**AddressModel**](AddressModel.md) | Shipping Address | [optional] [default to undefined]
13
+ **shippingAddress** | [**AddressModel**](AddressModel.md) | | [optional] [default to undefined]
14
14
  **partShip** | **boolean** | Part Ship Order | [optional] [default to undefined]
15
15
  **quote** | **boolean** | Quote | [optional] [default to undefined]
16
16
 
@@ -1,6 +1,6 @@
1
1
  # AccountsApi
2
2
 
3
- All URIs are relative to *https://bitbucket.org*
3
+ All URIs are relative to *https://api.local.yellowgrid.co.uk*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
@@ -19,6 +19,7 @@ All URIs are relative to *https://bitbucket.org*
19
19
  |[**getGetCustomerKeys**](#getgetcustomerkeys) | **GET** /accounts/me/tcx/keys | Get 3CX Keys|
20
20
  |[**getGetFinanceSettings**](#getgetfinancesettings) | **GET** /admin/accounts/{id}/finance | |
21
21
  |[**getGetLastAccount**](#getgetlastaccount) | **GET** /admin/accounts/last | Get Last Account|
22
+ |[**getGetNewPriceList**](#getgetnewpricelist) | **GET** /admin/accounts/priceList/new | Download New Price List|
22
23
  |[**getGetTcxPartnerDetails**](#getgettcxpartnerdetails) | **GET** /admin/accounts/{id}/tcx/partner | |
23
24
  |[**getVerifyEmailAddress**](#getverifyemailaddress) | **GET** /accounts/contacts/verify | Verify account email address|
24
25
  |[**patchSetAccountStatus**](#patchsetaccountstatus) | **PATCH** /admin/accounts/{id}/status/{state} | |
@@ -29,6 +30,7 @@ All URIs are relative to *https://bitbucket.org*
29
30
  |[**patchUpdateAccountCname**](#patchupdateaccountcname) | **PATCH** /admin/accounts/{id}/cname | |
30
31
  |[**patchUpdateAccountCompanyNumber**](#patchupdateaccountcompanynumber) | **PATCH** /admin/accounts/{id}/companyNumber | |
31
32
  |[**patchUpdateAccountContactPassword**](#patchupdateaccountcontactpassword) | **PATCH** /accounts/contacts/password | Update Account Password|
33
+ |[**patchUpdateAccountName**](#patchupdateaccountname) | **PATCH** /admin/accounts/{id}/name | |
32
34
  |[**patchUpdateAccountPhone**](#patchupdateaccountphone) | **PATCH** /admin/accounts/{id}/phone | |
33
35
  |[**patchUpdateAccountVatNumber**](#patchupdateaccountvatnumber) | **PATCH** /admin/accounts/{id}/vatNumber | |
34
36
  |[**patchUpdateCreditLimit**](#patchupdatecreditlimit) | **PATCH** /admin/accounts/{id}/creditLimit | |
@@ -837,6 +839,60 @@ No authorization required
837
839
 
838
840
  [[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)
839
841
 
842
+ # **getGetNewPriceList**
843
+ > string getGetNewPriceList()
844
+
845
+ Download New Price List
846
+
847
+ ### Example
848
+
849
+ ```typescript
850
+ import {
851
+ AccountsApi,
852
+ Configuration
853
+ } from 'yellowgrid-api-ts';
854
+
855
+ const configuration = new Configuration();
856
+ const apiInstance = new AccountsApi(configuration);
857
+
858
+ let id: string; //Xero ID (default to undefined)
859
+
860
+ const { status, data } = await apiInstance.getGetNewPriceList(
861
+ id
862
+ );
863
+ ```
864
+
865
+ ### Parameters
866
+
867
+ |Name | Type | Description | Notes|
868
+ |------------- | ------------- | ------------- | -------------|
869
+ | **id** | [**string**] | Xero ID | defaults to undefined|
870
+
871
+
872
+ ### Return type
873
+
874
+ **string**
875
+
876
+ ### Authorization
877
+
878
+ No authorization required
879
+
880
+ ### HTTP request headers
881
+
882
+ - **Content-Type**: Not defined
883
+ - **Accept**: text/csv
884
+
885
+
886
+ ### HTTP response details
887
+ | Status code | Description | Response headers |
888
+ |-------------|-------------|------------------|
889
+ |**200** | Price List | - |
890
+ |**400** | Bad Request | - |
891
+ |**401** | Unauthorised | - |
892
+ |**403** | Access Denied | - |
893
+
894
+ [[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)
895
+
840
896
  # **getGetTcxPartnerDetails**
841
897
  > PartnerDTO getGetTcxPartnerDetails()
842
898
 
@@ -1402,6 +1458,64 @@ No authorization required
1402
1458
 
1403
1459
  [[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)
1404
1460
 
1461
+ # **patchUpdateAccountName**
1462
+ > patchUpdateAccountName()
1463
+
1464
+ Set Account Name
1465
+
1466
+ ### Example
1467
+
1468
+ ```typescript
1469
+ import {
1470
+ AccountsApi,
1471
+ Configuration,
1472
+ PatchUpdateAccountNameRequest
1473
+ } from 'yellowgrid-api-ts';
1474
+
1475
+ const configuration = new Configuration();
1476
+ const apiInstance = new AccountsApi(configuration);
1477
+
1478
+ let id: string; //Xero ID (default to undefined)
1479
+ let patchUpdateAccountNameRequest: PatchUpdateAccountNameRequest; //Account Name Request (optional)
1480
+
1481
+ const { status, data } = await apiInstance.patchUpdateAccountName(
1482
+ id,
1483
+ patchUpdateAccountNameRequest
1484
+ );
1485
+ ```
1486
+
1487
+ ### Parameters
1488
+
1489
+ |Name | Type | Description | Notes|
1490
+ |------------- | ------------- | ------------- | -------------|
1491
+ | **patchUpdateAccountNameRequest** | **PatchUpdateAccountNameRequest**| Account Name Request | |
1492
+ | **id** | [**string**] | Xero ID | defaults to undefined|
1493
+
1494
+
1495
+ ### Return type
1496
+
1497
+ void (empty response body)
1498
+
1499
+ ### Authorization
1500
+
1501
+ No authorization required
1502
+
1503
+ ### HTTP request headers
1504
+
1505
+ - **Content-Type**: application/json
1506
+ - **Accept**: Not defined
1507
+
1508
+
1509
+ ### HTTP response details
1510
+ | Status code | Description | Response headers |
1511
+ |-------------|-------------|------------------|
1512
+ |**204** | No Response | - |
1513
+ |**400** | Bad Request | - |
1514
+ |**401** | Unauthorised | - |
1515
+ |**403** | Access Denied | - |
1516
+
1517
+ [[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)
1518
+
1405
1519
  # **patchUpdateAccountPhone**
1406
1520
  > patchUpdateAccountPhone()
1407
1521
 
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
10
10
  **items** | [**Array<DetailedItemRequestDTO>**](DetailedItemRequestDTO.md) | Items | [optional] [default to undefined]
11
11
  **shippingService** | [**ShippingServiceDTO**](ShippingServiceDTO.md) | | [optional] [default to undefined]
12
12
  **provisioningUrl** | **string** | Provisioning URL | [optional] [default to undefined]
13
- **shippingAddress** | [**AddressModel**](AddressModel.md) | Shipping Address | [optional] [default to undefined]
13
+ **shippingAddress** | [**AddressModel**](AddressModel.md) | | [optional] [default to undefined]
14
14
  **partShip** | **boolean** | Part Ship Order | [optional] [default to undefined]
15
15
  **quote** | **boolean** | Quote | [optional] [default to undefined]
16
16
  **customerId** | **number** | Customer ID | [optional] [default to undefined]
@@ -0,0 +1,25 @@
1
+ # AxisDataDTO
2
+
3
+ Graph Axis Data
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **type** | **string** | Type | [optional] [default to undefined]
10
+ **data** | **Array<string>** | Data | [optional] [default to undefined]
11
+ **name** | **string** | Name | [optional] [default to undefined]
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import { AxisDataDTO } from 'yellowgrid-api-ts';
17
+
18
+ const instance: AxisDataDTO = {
19
+ type,
20
+ data,
21
+ name,
22
+ };
23
+ ```
24
+
25
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,6 +1,6 @@
1
1
  # BillingApi
2
2
 
3
- All URIs are relative to *https://bitbucket.org*
3
+ All URIs are relative to *https://api.local.yellowgrid.co.uk*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
package/docs/CRMApi.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # CRMApi
2
2
 
3
- All URIs are relative to *https://bitbucket.org*
3
+ All URIs are relative to *https://api.local.yellowgrid.co.uk*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
@@ -1,6 +1,6 @@
1
1
  # Class3CXApi
2
2
 
3
- All URIs are relative to *https://bitbucket.org*
3
+ All URIs are relative to *https://api.local.yellowgrid.co.uk*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
@@ -1,6 +1,6 @@
1
1
  # Class3CXInstallationWizardApi
2
2
 
3
- All URIs are relative to *https://bitbucket.org*
3
+ All URIs are relative to *https://api.local.yellowgrid.co.uk*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
@@ -1,6 +1,6 @@
1
1
  # Class3CXInstallationsApi
2
2
 
3
- All URIs are relative to *https://bitbucket.org*
3
+ All URIs are relative to *https://api.local.yellowgrid.co.uk*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
@@ -1,6 +1,6 @@
1
1
  # Class3CXIntegrationsApi
2
2
 
3
- All URIs are relative to *https://bitbucket.org*
3
+ All URIs are relative to *https://api.local.yellowgrid.co.uk*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
@@ -1,6 +1,6 @@
1
1
  # Class3CXMultiTenantApi
2
2
 
3
- All URIs are relative to *https://bitbucket.org*
3
+ All URIs are relative to *https://api.local.yellowgrid.co.uk*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
@@ -7,12 +7,12 @@ CRM Activity
7
7
  Name | Type | Description | Notes
8
8
  ------------ | ------------- | ------------- | -------------
9
9
  **type** | **string** | Activity Type | [optional] [default to undefined]
10
- **timestamp** | **string** | Activity Timestamp | [optional] [default to undefined]
10
+ **timestamp** | **string** | Date Time | [optional] [default to undefined]
11
11
  **title** | **string** | Activity Title | [optional] [default to undefined]
12
12
  **description** | **string** | Activity Description | [optional] [default to undefined]
13
- **url** | **string** | Activity URL | [optional] [default to undefined]
14
13
  **user** | **string** | Activity User Name | [optional] [default to undefined]
15
14
  **contact** | **string** | Activity Contact Name | [optional] [default to undefined]
15
+ **orderId** | **number** | Activity Order ID | [optional] [default to undefined]
16
16
 
17
17
  ## Example
18
18
 
@@ -24,9 +24,9 @@ const instance: CrmActivityDTO = {
24
24
  timestamp,
25
25
  title,
26
26
  description,
27
- url,
28
27
  user,
29
28
  contact,
29
+ orderId,
30
30
  };
31
31
  ```
32
32
 
@@ -6,7 +6,7 @@ CRM Date Activities
6
6
 
7
7
  Name | Type | Description | Notes
8
8
  ------------ | ------------- | ------------- | -------------
9
- **date** | **string** | Date | [optional] [default to undefined]
9
+ **date** | **string** | Date Time | [optional] [default to undefined]
10
10
  **activities** | [**Array<CrmActivityDTO>**](CrmActivityDTO.md) | Activities | [optional] [default to undefined]
11
11
 
12
12
  ## Example
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
10
10
  **items** | [**Array<CustomerItemRequestDTO>**](CustomerItemRequestDTO.md) | Items | [optional] [default to undefined]
11
11
  **shippingService** | [**ShippingServiceDTO**](ShippingServiceDTO.md) | | [optional] [default to undefined]
12
12
  **provisioningUrl** | **string** | Provisioning URL | [optional] [default to undefined]
13
- **shippingAddress** | [**AddressModel**](AddressModel.md) | Shipping Address | [optional] [default to undefined]
13
+ **shippingAddress** | [**AddressModel**](AddressModel.md) | | [optional] [default to undefined]
14
14
  **partShip** | **boolean** | Part Ship Order | [optional] [default to undefined]
15
15
  **quote** | **boolean** | Quote | [optional] [default to undefined]
16
16
 
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
10
10
  **items** | [**Array<DetailedItemRequestDTO>**](DetailedItemRequestDTO.md) | Items | [optional] [default to undefined]
11
11
  **shippingService** | [**ShippingServiceDTO**](ShippingServiceDTO.md) | | [optional] [default to undefined]
12
12
  **provisioningUrl** | **string** | Provisioning URL | [optional] [default to undefined]
13
- **shippingAddress** | [**AddressModel**](AddressModel.md) | Shipping Address | [optional] [default to undefined]
13
+ **shippingAddress** | [**AddressModel**](AddressModel.md) | | [optional] [default to undefined]
14
14
  **partShip** | **boolean** | Part Ship Order | [optional] [default to undefined]
15
15
  **quote** | **boolean** | Quote | [optional] [default to undefined]
16
16
 
@@ -0,0 +1,20 @@
1
+ # GetCheckMacExists200Response
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **found** | **boolean** | | [optional] [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { GetCheckMacExists200Response } from 'yellowgrid-api-ts';
14
+
15
+ const instance: GetCheckMacExists200Response = {
16
+ found,
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)
@@ -0,0 +1,29 @@
1
+ # GraphDTO
2
+
3
+ Graph
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **title** | **string** | Title | [optional] [default to undefined]
10
+ **xAxis** | [**Array<AxisDataDTO>**](AxisDataDTO.md) | X Axis | [optional] [default to undefined]
11
+ **yAxis** | [**Array<AxisDataDTO>**](AxisDataDTO.md) | Y Axis | [optional] [default to undefined]
12
+ **legend** | **Array<string>** | Legend | [optional] [default to undefined]
13
+ **series** | [**Array<SeriesDTO>**](SeriesDTO.md) | Series | [optional] [default to undefined]
14
+
15
+ ## Example
16
+
17
+ ```typescript
18
+ import { GraphDTO } from 'yellowgrid-api-ts';
19
+
20
+ const instance: GraphDTO = {
21
+ title,
22
+ xAxis,
23
+ yAxis,
24
+ legend,
25
+ series,
26
+ };
27
+ ```
28
+
29
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,23 @@
1
+ # MacAddressDTO
2
+
3
+ MAC Address DTO
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **groupId** | **number** | Group ID | [optional] [default to undefined]
10
+ **macAddress** | **string** | MAC Address | [optional] [default to undefined]
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import { MacAddressDTO } from 'yellowgrid-api-ts';
16
+
17
+ const instance: MacAddressDTO = {
18
+ groupId,
19
+ macAddress,
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)
@@ -0,0 +1,63 @@
1
+ # MiscApi
2
+
3
+ All URIs are relative to *https://api.local.yellowgrid.co.uk*
4
+
5
+ |Method | HTTP request | Description|
6
+ |------------- | ------------- | -------------|
7
+ |[**postSendPassword**](#postsendpassword) | **POST** /admin/password/send | |
8
+
9
+ # **postSendPassword**
10
+ > PasswordSenderDTO postSendPassword()
11
+
12
+ Share Credentials
13
+
14
+ ### Example
15
+
16
+ ```typescript
17
+ import {
18
+ MiscApi,
19
+ Configuration,
20
+ PasswordSenderDTO
21
+ } from 'yellowgrid-api-ts';
22
+
23
+ const configuration = new Configuration();
24
+ const apiInstance = new MiscApi(configuration);
25
+
26
+ let passwordSenderDTO: PasswordSenderDTO; //Password Sender Request (optional)
27
+
28
+ const { status, data } = await apiInstance.postSendPassword(
29
+ passwordSenderDTO
30
+ );
31
+ ```
32
+
33
+ ### Parameters
34
+
35
+ |Name | Type | Description | Notes|
36
+ |------------- | ------------- | ------------- | -------------|
37
+ | **passwordSenderDTO** | **PasswordSenderDTO**| Password Sender Request | |
38
+
39
+
40
+ ### Return type
41
+
42
+ **PasswordSenderDTO**
43
+
44
+ ### Authorization
45
+
46
+ No authorization required
47
+
48
+ ### HTTP request headers
49
+
50
+ - **Content-Type**: application/json
51
+ - **Accept**: application/json
52
+
53
+
54
+ ### HTTP response details
55
+ | Status code | Description | Response headers |
56
+ |-------------|-------------|------------------|
57
+ |**200** | Password Sender Response | - |
58
+ |**400** | Bad Request | - |
59
+ |**401** | Unauthorised | - |
60
+ |**403** | Access Denied | - |
61
+
62
+ [[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)
63
+
@@ -1,6 +1,6 @@
1
1
  # MyPBXToolsApi
2
2
 
3
- All URIs are relative to *https://bitbucket.org*
3
+ All URIs are relative to *https://api.local.yellowgrid.co.uk*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
@@ -0,0 +1,51 @@
1
+ # NumberPortModel
2
+
3
+ Number Port Model
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **id** | **number** | Number Port ID | [optional] [default to undefined]
10
+ **customerId** | **number** | Customer ID | [optional] [default to undefined]
11
+ **endUser** | **string** | End User | [optional] [default to undefined]
12
+ **addressLine1** | **string** | Address Line 1 | [optional] [default to undefined]
13
+ **addressLine2** | **string** | Address Line 2 | [optional] [default to undefined]
14
+ **city** | **string** | City | [optional] [default to undefined]
15
+ **postCode** | **string** | Post Code | [optional] [default to undefined]
16
+ **trunkId** | **number** | Trunk ID | [optional] [default to undefined]
17
+ **tenantId** | **string** | Tenant ID | [optional] [default to undefined]
18
+ **requestedPortDate** | **string** | Requested Port Date | [optional] [default to undefined]
19
+ **portDate** | **string** | Port Date | [optional] [default to undefined]
20
+ **comment** | **string** | Comment | [optional] [default to undefined]
21
+ **status** | **number** | Status | [optional] [default to undefined]
22
+ **ticketId** | **number** | Ticket ID | [optional] [default to undefined]
23
+ **ranges** | **Array<any>** | Number Port Ranges | [optional] [default to undefined]
24
+ **customerName** | **string** | Customer Company Name | [optional] [default to undefined]
25
+
26
+ ## Example
27
+
28
+ ```typescript
29
+ import { NumberPortModel } from 'yellowgrid-api-ts';
30
+
31
+ const instance: NumberPortModel = {
32
+ id,
33
+ customerId,
34
+ endUser,
35
+ addressLine1,
36
+ addressLine2,
37
+ city,
38
+ postCode,
39
+ trunkId,
40
+ tenantId,
41
+ requestedPortDate,
42
+ portDate,
43
+ comment,
44
+ status,
45
+ ticketId,
46
+ ranges,
47
+ customerName,
48
+ };
49
+ ```
50
+
51
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,6 +1,6 @@
1
1
  # NumberPortingApi
2
2
 
3
- All URIs are relative to *https://bitbucket.org*
3
+ All URIs are relative to *https://api.local.yellowgrid.co.uk*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
@@ -1,6 +1,6 @@
1
1
  # OAuth20Api
2
2
 
3
- All URIs are relative to *https://bitbucket.org*
3
+ All URIs are relative to *https://api.local.yellowgrid.co.uk*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
package/docs/OrdersApi.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # OrdersApi
2
2
 
3
- All URIs are relative to *https://bitbucket.org*
3
+ All URIs are relative to *https://api.local.yellowgrid.co.uk*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
@@ -17,7 +17,7 @@ Name | Type | Description | Notes
17
17
  **hostingPriceListId** | **number** | 3CX Hosting Price List ID | [optional] [default to undefined]
18
18
  **installationUrl** | **string** | 3CX Installation URL | [optional] [default to undefined]
19
19
  **aligned** | **boolean** | Aligned | [optional] [default to undefined]
20
- **customer** | [**AccountSummaryDTO**](AccountSummaryDTO.md) | Customer | [optional] [default to undefined]
20
+ **customer** | [**AccountSummaryDTO**](AccountSummaryDTO.md) | | [optional] [default to undefined]
21
21
 
22
22
  ## Example
23
23
 
@@ -0,0 +1,37 @@
1
+ # PasswordSenderDTO
2
+
3
+ Password Sender Request
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **username** | **string** | Username | [optional] [default to undefined]
10
+ **password** | **string** | Password | [optional] [default to undefined]
11
+ **expiryInterval** | **number** | Expiry Interval | [optional] [default to undefined]
12
+ **intervalType** | **string** | Interval Type | [optional] [default to undefined]
13
+ **expiry** | **string** | Date Time | [optional] [default to undefined]
14
+ **recipient** | **Array<string>** | Recipient | [optional] [default to undefined]
15
+ **url** | **string** | URL | [optional] [default to undefined]
16
+ **description** | **string** | Description | [optional] [default to undefined]
17
+ **passwordUrl** | **string** | Password URL | [optional] [default to undefined]
18
+
19
+ ## Example
20
+
21
+ ```typescript
22
+ import { PasswordSenderDTO } from 'yellowgrid-api-ts';
23
+
24
+ const instance: PasswordSenderDTO = {
25
+ username,
26
+ password,
27
+ expiryInterval,
28
+ intervalType,
29
+ expiry,
30
+ recipient,
31
+ url,
32
+ description,
33
+ passwordUrl,
34
+ };
35
+ ```
36
+
37
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)