yellowgrid-api-ts 3.2.237 → 3.2.238-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 (155) hide show
  1. package/.openapi-generator/FILES +367 -306
  2. package/.openapi-generator/VERSION +1 -1
  3. package/README.md +132 -3
  4. package/api.ts +20035 -6358
  5. package/base.ts +26 -2
  6. package/common.ts +39 -16
  7. package/config.json +4 -3
  8. package/configuration.ts +21 -27
  9. package/dist/api.d.ts +15872 -5106
  10. package/dist/api.js +6725 -603
  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/ConnectionTypeEnum.d.ts +73 -0
  20. package/dist/models/ConnectionTypeEnum.js +75 -0
  21. package/dist/models/GraphTypeEnum.d.ts +13 -0
  22. package/dist/models/GraphTypeEnum.js +15 -0
  23. package/dist/models/GroupEnum.d.ts +43 -0
  24. package/dist/models/GroupEnum.js +45 -0
  25. package/dist/models/HostingPriceListEnum.d.ts +5 -0
  26. package/dist/models/HostingPriceListEnum.js +5 -0
  27. package/dist/models/ReportEnum.d.ts +68 -0
  28. package/dist/models/ReportEnum.js +70 -0
  29. package/docs/AbstractItemDiscountModel.md +21 -0
  30. package/docs/AbstractOrderRequestDTO.md +1 -1
  31. package/docs/AccountDetailedSummaryDTO.md +2 -0
  32. package/docs/AccountsApi.md +49 -1
  33. package/docs/AdminOrderRequestDTO.md +1 -1
  34. package/docs/AxisDataDTO.md +25 -0
  35. package/docs/BaseService.md +36 -0
  36. package/docs/BillingApi.md +3631 -26
  37. package/docs/Bundle.md +34 -0
  38. package/docs/BundleCustomer.md +34 -0
  39. package/docs/CRMApi.md +1 -1
  40. package/docs/CallTariff.md +34 -0
  41. package/docs/CallTariffPlan.md +36 -0
  42. package/docs/CallTariffResponse.md +26 -0
  43. package/docs/Cdr.md +112 -0
  44. package/docs/Class3CXApi.md +1 -1
  45. package/docs/Class3CXInstallationWizardApi.md +1 -1
  46. package/docs/Class3CXInstallationsApi.md +1 -1
  47. package/docs/Class3CXIntegrationsApi.md +1 -1
  48. package/docs/Class3CXMultiTenantApi.md +1 -1
  49. package/docs/ConnectionRequest.md +36 -0
  50. package/docs/ConnectionType.md +28 -0
  51. package/docs/ContactDetail.md +58 -0
  52. package/docs/CrmActivityDTO.md +1 -1
  53. package/docs/CrmDateActivitiesDTO.md +1 -1
  54. package/docs/Customer.md +98 -0
  55. package/docs/CustomerCoordinatesDTO.md +31 -0
  56. package/docs/CustomerOrderRequestDTO.md +1 -1
  57. package/docs/CustomerRate.md +22 -0
  58. package/docs/CustomerRateType.md +12 -0
  59. package/docs/DetailedOrderRequestDTO.md +1 -1
  60. package/docs/GetDisconnectDDIRequest.md +20 -0
  61. package/docs/GraphDTO.md +33 -0
  62. package/docs/InboundCli.md +50 -0
  63. package/docs/InboundTariffPlan.md +32 -0
  64. package/docs/InboundTariffPlanResponse.md +28 -0
  65. package/docs/MiscApi.md +63 -0
  66. package/docs/MultiTenantSipTrunkRequest.md +22 -0
  67. package/docs/MyPBXToolsApi.md +1 -1
  68. package/docs/NumberPortModel.md +51 -0
  69. package/docs/NumberPortingApi.md +1 -1
  70. package/docs/OAuth20Api.md +1 -1
  71. package/docs/OrdersApi.md +1 -1
  72. package/docs/OutboundCli.md +70 -0
  73. package/docs/PartnerDTO.md +1 -1
  74. package/docs/PasswordSenderDTO.md +37 -0
  75. package/docs/PasswordSenderEntity.md +33 -0
  76. package/docs/PatchSetTcxWizardCnameRequest.md +20 -0
  77. package/docs/PostAddAdminNoteRequest.md +20 -0
  78. package/docs/PostAddBroadbandRequest.md +28 -0
  79. package/docs/PostAddCallTariffToCallTariffPlanRequest.md +34 -0
  80. package/docs/PostAddEthernetRequest.md +28 -0
  81. package/docs/PostAddRecurringChargeRequest.md +30 -0
  82. package/docs/PostAddServiceToServicePlanRequest.md +30 -0
  83. package/docs/PostAddSipTrunkDDIsRequest.md +30 -0
  84. package/docs/PostDisconnectDDIRequest.md +20 -0
  85. package/docs/PostGenerateReport200Response.md +36 -0
  86. package/docs/PostGetBaseServicesRequest.md +22 -0
  87. package/docs/PostGetPriceGroupsRequest.md +22 -0
  88. package/docs/PostGetProductRequest.md +24 -0
  89. package/docs/PostGetServicePlansRequest.md +22 -0
  90. package/docs/PostGetSipTrunksBillingRequest.md +34 -0
  91. package/docs/PostUpdateConnectionRequest.md +22 -0
  92. package/docs/PostUpdateRecurringChargeRequest.md +30 -0
  93. package/docs/PriceGroup.md +30 -0
  94. package/docs/PriceGroupResponse.md +24 -0
  95. package/docs/PricingApi.md +1 -1
  96. package/docs/ProcessedCdr.md +96 -0
  97. package/docs/ProductDetailedSummaryDTO.md +2 -2
  98. package/docs/ProductSearchDTO.md +37 -0
  99. package/docs/ProductSummaryDTO.md +1 -1
  100. package/docs/ProductsApi.md +1 -1
  101. package/docs/PromoSummariesModel.md +27 -0
  102. package/docs/PromoSummaryDTO.md +29 -0
  103. package/docs/PromotionsApi.md +71 -0
  104. package/docs/ProspectDTO.md +2 -2
  105. package/docs/ProspectsApi.md +1 -1
  106. package/docs/ProvisioningApi.md +1 -1
  107. package/docs/PutAddCallTariffToCallTariffPlanRequest.md +30 -0
  108. package/docs/PutAddServiceToServicePlanRequest.md +26 -0
  109. package/docs/PutConnectionSearchRequest.md +20 -0
  110. package/docs/PutGetBaseServicesRequest.md +28 -0
  111. package/docs/PutGetCallTariffPlanRequest.md +28 -0
  112. package/docs/PutGetPriceGroupsRequest.md +28 -0
  113. package/docs/RecordingsBackupInfoDTO.md +2 -2
  114. package/docs/RecurringCharge.md +48 -0
  115. package/docs/ReportRequestDTO.md +37 -0
  116. package/docs/ReportsApi.md +56 -1
  117. package/docs/SIPTrunksApi.md +1 -1
  118. package/docs/SMSApi.md +1 -1
  119. package/docs/Sdr.md +66 -0
  120. package/docs/SdrReferenceType.md +24 -0
  121. package/docs/SeriesDTO.md +27 -0
  122. package/docs/Service.md +42 -0
  123. package/docs/ServicePlan.md +36 -0
  124. package/docs/ServicesApi.md +1 -1
  125. package/docs/ShipmentRequestDTO.md +2 -2
  126. package/docs/ShippingApi.md +1 -1
  127. package/docs/SpecialService.md +40 -0
  128. package/docs/StockManagementApi.md +1 -1
  129. package/docs/SuppliersApi.md +1 -1
  130. package/docs/SystemApi.md +1 -1
  131. package/docs/TableDTO.md +25 -0
  132. package/docs/TableDataDTO.md +21 -0
  133. package/docs/TableRowDTO.md +21 -0
  134. package/docs/TariffRate.md +30 -0
  135. package/docs/TcxHostingPricingEntity.md +35 -0
  136. package/docs/TcxInstallationDetailsModel.md +45 -0
  137. package/docs/TcxInstallationModel.md +2 -0
  138. package/docs/TcxKeySummaryDTO.md +1 -1
  139. package/docs/TelephonySupportTicketModel.md +41 -0
  140. package/docs/TicketsApi.md +1 -1
  141. package/docs/UnconnectedSdr.md +68 -0
  142. package/docs/WebhooksApi.md +1 -1
  143. package/getEnums.php +31 -31
  144. package/hs_err_pid16044.log +249 -0
  145. package/hs_err_pid44560.log +249 -0
  146. package/hs_err_pid53988.log +249 -0
  147. package/hs_err_pid58728.log +40 -0
  148. package/index.ts +1 -1
  149. package/models/ConnectionTypeEnum.ts +74 -0
  150. package/models/GraphTypeEnum.ts +14 -0
  151. package/models/GroupEnum.ts +44 -0
  152. package/models/HostingPriceListEnum.ts +5 -0
  153. package/models/ReportEnum.ts +69 -0
  154. package/openapitools.json +1 -1
  155. package/package.json +2 -2
package/docs/Bundle.md ADDED
@@ -0,0 +1,34 @@
1
+ # Bundle
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **createdDate** | **string** | | [optional] [default to undefined]
9
+ **id** | **number** | | [optional] [default to undefined]
10
+ **name** | **string** | | [default to undefined]
11
+ **category** | **string** | | [default to undefined]
12
+ **description** | **string** | | [default to undefined]
13
+ **customers** | [**Array<Customer>**](Customer.md) | | [optional] [readonly] [default to undefined]
14
+ **bundleCustomers** | [**Array<BundleCustomer>**](BundleCustomer.md) | | [optional] [readonly] [default to undefined]
15
+ **filePeriod** | **string** | | [optional] [default to undefined]
16
+
17
+ ## Example
18
+
19
+ ```typescript
20
+ import { Bundle } from 'yellowgrid-api-ts';
21
+
22
+ const instance: Bundle = {
23
+ createdDate,
24
+ id,
25
+ name,
26
+ category,
27
+ description,
28
+ customers,
29
+ bundleCustomers,
30
+ filePeriod,
31
+ };
32
+ ```
33
+
34
+ [[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,34 @@
1
+ # BundleCustomer
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **createdDate** | **string** | | [optional] [default to undefined]
9
+ **id** | **number** | | [optional] [default to undefined]
10
+ **bundleId** | **number** | | [optional] [default to undefined]
11
+ **bundle** | [**Bundle**](Bundle.md) | | [default to undefined]
12
+ **customerId** | **number** | | [optional] [default to undefined]
13
+ **customer** | [**Customer**](Customer.md) | | [default to undefined]
14
+ **endDate** | **string** | | [optional] [default to undefined]
15
+ **filePeriod** | **string** | | [optional] [default to undefined]
16
+
17
+ ## Example
18
+
19
+ ```typescript
20
+ import { BundleCustomer } from 'yellowgrid-api-ts';
21
+
22
+ const instance: BundleCustomer = {
23
+ createdDate,
24
+ id,
25
+ bundleId,
26
+ bundle,
27
+ customerId,
28
+ customer,
29
+ endDate,
30
+ filePeriod,
31
+ };
32
+ ```
33
+
34
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
package/docs/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
  |------------- | ------------- | -------------|
@@ -0,0 +1,34 @@
1
+ # CallTariff
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **createdDate** | **string** | | [optional] [default to undefined]
9
+ **id** | **number** | | [optional] [default to undefined]
10
+ **callTariffPlanId** | **number** | | [optional] [default to undefined]
11
+ **inboundTariffPlanId** | **number** | | [optional] [default to undefined]
12
+ **priceGroupId** | **number** | | [optional] [default to undefined]
13
+ **priceGroup** | [**PriceGroup**](PriceGroup.md) | | [default to undefined]
14
+ **tariffRate** | [**TariffRate**](TariffRate.md) | | [default to undefined]
15
+ **filePeriod** | **string** | | [optional] [default to undefined]
16
+
17
+ ## Example
18
+
19
+ ```typescript
20
+ import { CallTariff } from 'yellowgrid-api-ts';
21
+
22
+ const instance: CallTariff = {
23
+ createdDate,
24
+ id,
25
+ callTariffPlanId,
26
+ inboundTariffPlanId,
27
+ priceGroupId,
28
+ priceGroup,
29
+ tariffRate,
30
+ filePeriod,
31
+ };
32
+ ```
33
+
34
+ [[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,36 @@
1
+ # CallTariffPlan
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **createdDate** | **string** | | [optional] [default to undefined]
9
+ **id** | **number** | | [optional] [default to undefined]
10
+ **name** | **string** | | [default to undefined]
11
+ **unknownDestinationsRate** | [**CustomerRate**](CustomerRate.md) | | [default to undefined]
12
+ **ngcsAccessChargePerMin** | **number** | | [optional] [default to undefined]
13
+ **ngcsAccessChargePerCall** | **number** | | [optional] [default to undefined]
14
+ **callTariffs** | [**Array<CallTariff>**](CallTariff.md) | | [optional] [readonly] [default to undefined]
15
+ **filePeriod** | **string** | | [optional] [default to undefined]
16
+ **closed** | **boolean** | | [optional] [default to undefined]
17
+
18
+ ## Example
19
+
20
+ ```typescript
21
+ import { CallTariffPlan } from 'yellowgrid-api-ts';
22
+
23
+ const instance: CallTariffPlan = {
24
+ createdDate,
25
+ id,
26
+ name,
27
+ unknownDestinationsRate,
28
+ ngcsAccessChargePerMin,
29
+ ngcsAccessChargePerCall,
30
+ callTariffs,
31
+ filePeriod,
32
+ closed,
33
+ };
34
+ ```
35
+
36
+ [[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,26 @@
1
+ # CallTariffResponse
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **id** | **number** | | [optional] [default to undefined]
9
+ **priceGroupId** | **number** | | [optional] [default to undefined]
10
+ **priceGroup** | [**PriceGroupResponse**](PriceGroupResponse.md) | | [optional] [default to undefined]
11
+ **tariffRate** | [**TariffRate**](TariffRate.md) | | [optional] [default to undefined]
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import { CallTariffResponse } from 'yellowgrid-api-ts';
17
+
18
+ const instance: CallTariffResponse = {
19
+ id,
20
+ priceGroupId,
21
+ priceGroup,
22
+ tariffRate,
23
+ };
24
+ ```
25
+
26
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
package/docs/Cdr.md ADDED
@@ -0,0 +1,112 @@
1
+ # Cdr
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **id** | **number** | | [optional] [default to undefined]
9
+ **callType** | **string** | | [default to undefined]
10
+ **callCause** | **string** | | [optional] [default to undefined]
11
+ **customerIdentifier** | **string** | | [default to undefined]
12
+ **nonChargedParty** | **string** | | [default to undefined]
13
+ **callDate** | **string** | | [default to undefined]
14
+ **callTime** | **string** | | [default to undefined]
15
+ **duration** | **number** | | [optional] [default to undefined]
16
+ **bytesTransmitted** | **number** | | [optional] [default to undefined]
17
+ **bytesReceived** | **number** | | [optional] [default to undefined]
18
+ **description** | **string** | | [optional] [default to undefined]
19
+ **chargecode** | **string** | | [optional] [default to undefined]
20
+ **timeBand** | **string** | | [optional] [default to undefined]
21
+ **salesprice** | **number** | | [optional] [default to undefined]
22
+ **salespricePreBundle** | **number** | | [optional] [default to undefined]
23
+ **extension** | **string** | | [optional] [default to undefined]
24
+ **ddi** | **string** | | [optional] [default to undefined]
25
+ **groupingID** | **string** | | [optional] [default to undefined]
26
+ **callClass** | **string** | | [optional] [default to undefined]
27
+ **carrier** | **string** | | [optional] [default to undefined]
28
+ **recording** | **boolean** | | [optional] [default to undefined]
29
+ **vat** | **string** | | [optional] [default to undefined]
30
+ **countryOfOrigin** | **string** | | [optional] [default to undefined]
31
+ **network** | **string** | | [optional] [default to undefined]
32
+ **retailTariffCode** | **string** | | [optional] [default to undefined]
33
+ **remoteNetwork** | **string** | | [optional] [default to undefined]
34
+ **apn** | **string** | | [optional] [default to undefined]
35
+ **divertedNumber** | **string** | | [optional] [default to undefined]
36
+ **ringTime** | **number** | | [optional] [default to undefined]
37
+ **recordID** | **string** | | [optional] [default to undefined]
38
+ **currency** | **string** | | [optional] [default to undefined]
39
+ **presentationNumber** | **string** | | [optional] [default to undefined]
40
+ **networkAccessReference** | **string** | | [optional] [default to undefined]
41
+ **ngcsAccessCharge** | **number** | | [optional] [default to undefined]
42
+ **ngcsServiceCharge** | **number** | | [optional] [default to undefined]
43
+ **totalBytesTransferred** | **number** | | [optional] [default to undefined]
44
+ **userID** | **string** | | [optional] [default to undefined]
45
+ **onwardBillingReference** | **string** | | [optional] [default to undefined]
46
+ **contractName** | **string** | | [optional] [default to undefined]
47
+ **bundleName** | **string** | | [optional] [default to undefined]
48
+ **bundleAllowance** | **number** | | [optional] [default to undefined]
49
+ **discountReference** | **string** | | [optional] [default to undefined]
50
+ **routingCode** | **string** | | [optional] [default to undefined]
51
+ **filename** | **string** | | [default to undefined]
52
+ **contentReference** | **string** | | [default to undefined]
53
+ **processedCdr** | [**ProcessedCdr**](ProcessedCdr.md) | | [optional] [default to undefined]
54
+ **filePeriod** | **string** | | [default to undefined]
55
+
56
+ ## Example
57
+
58
+ ```typescript
59
+ import { Cdr } from 'yellowgrid-api-ts';
60
+
61
+ const instance: Cdr = {
62
+ id,
63
+ callType,
64
+ callCause,
65
+ customerIdentifier,
66
+ nonChargedParty,
67
+ callDate,
68
+ callTime,
69
+ duration,
70
+ bytesTransmitted,
71
+ bytesReceived,
72
+ description,
73
+ chargecode,
74
+ timeBand,
75
+ salesprice,
76
+ salespricePreBundle,
77
+ extension,
78
+ ddi,
79
+ groupingID,
80
+ callClass,
81
+ carrier,
82
+ recording,
83
+ vat,
84
+ countryOfOrigin,
85
+ network,
86
+ retailTariffCode,
87
+ remoteNetwork,
88
+ apn,
89
+ divertedNumber,
90
+ ringTime,
91
+ recordID,
92
+ currency,
93
+ presentationNumber,
94
+ networkAccessReference,
95
+ ngcsAccessCharge,
96
+ ngcsServiceCharge,
97
+ totalBytesTransferred,
98
+ userID,
99
+ onwardBillingReference,
100
+ contractName,
101
+ bundleName,
102
+ bundleAllowance,
103
+ discountReference,
104
+ routingCode,
105
+ filename,
106
+ contentReference,
107
+ processedCdr,
108
+ filePeriod,
109
+ };
110
+ ```
111
+
112
+ [[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
  # 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
  |------------- | ------------- | -------------|
@@ -0,0 +1,36 @@
1
+ # ConnectionRequest
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **customerId** | **number** | | [default to undefined]
9
+ **reference** | **string** | | [default to undefined]
10
+ **connectionDate** | **string** | | [default to undefined]
11
+ **servicePlanId** | **number** | | [default to undefined]
12
+ **zeroRated** | **boolean** | | [optional] [default to undefined]
13
+ **callTariffPlanId** | **number** | | [optional] [default to undefined]
14
+ **inboundTariffPlanId** | **number** | | [optional] [default to undefined]
15
+ **invoiceDescription** | **string** | | [optional] [default to undefined]
16
+ **mtSipTrunkRequest** | [**MultiTenantSipTrunkRequest**](MultiTenantSipTrunkRequest.md) | | [optional] [default to undefined]
17
+
18
+ ## Example
19
+
20
+ ```typescript
21
+ import { ConnectionRequest } from 'yellowgrid-api-ts';
22
+
23
+ const instance: ConnectionRequest = {
24
+ customerId,
25
+ reference,
26
+ connectionDate,
27
+ servicePlanId,
28
+ zeroRated,
29
+ callTariffPlanId,
30
+ inboundTariffPlanId,
31
+ invoiceDescription,
32
+ mtSipTrunkRequest,
33
+ };
34
+ ```
35
+
36
+ [[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,28 @@
1
+ # ConnectionType
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **createdDate** | **string** | | [optional] [default to undefined]
9
+ **id** | **number** | | [optional] [default to undefined]
10
+ **name** | **string** | | [default to undefined]
11
+ **description** | **string** | | [optional] [default to undefined]
12
+ **accountCode** | **string** | | [default to undefined]
13
+
14
+ ## Example
15
+
16
+ ```typescript
17
+ import { ConnectionType } from 'yellowgrid-api-ts';
18
+
19
+ const instance: ConnectionType = {
20
+ createdDate,
21
+ id,
22
+ name,
23
+ description,
24
+ accountCode,
25
+ };
26
+ ```
27
+
28
+ [[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,58 @@
1
+ # ContactDetail
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **customerName** | **string** | | [default to undefined]
9
+ **contactName** | **string** | | [optional] [default to undefined]
10
+ **address1** | **string** | | [optional] [default to undefined]
11
+ **address2** | **string** | | [optional] [default to undefined]
12
+ **address3** | **string** | | [optional] [default to undefined]
13
+ **address4** | **string** | | [optional] [default to undefined]
14
+ **postCode** | **string** | | [optional] [default to undefined]
15
+ **country** | **string** | | [optional] [default to undefined]
16
+ **phone1** | **string** | | [optional] [default to undefined]
17
+ **email** | **string** | | [optional] [default to undefined]
18
+ **siteInfo** | **string** | | [optional] [default to undefined]
19
+ **siteContactName** | **string** | | [optional] [default to undefined]
20
+ **siteAddress1** | **string** | | [optional] [default to undefined]
21
+ **siteAddress2** | **string** | | [optional] [default to undefined]
22
+ **siteAddress3** | **string** | | [optional] [default to undefined]
23
+ **siteAddress4** | **string** | | [optional] [default to undefined]
24
+ **sitePostcode** | **string** | | [optional] [default to undefined]
25
+ **siteCountry** | **string** | | [optional] [default to undefined]
26
+ **sitePhone1** | **string** | | [optional] [default to undefined]
27
+ **siteEmail** | **string** | | [optional] [default to undefined]
28
+
29
+ ## Example
30
+
31
+ ```typescript
32
+ import { ContactDetail } from 'yellowgrid-api-ts';
33
+
34
+ const instance: ContactDetail = {
35
+ customerName,
36
+ contactName,
37
+ address1,
38
+ address2,
39
+ address3,
40
+ address4,
41
+ postCode,
42
+ country,
43
+ phone1,
44
+ email,
45
+ siteInfo,
46
+ siteContactName,
47
+ siteAddress1,
48
+ siteAddress2,
49
+ siteAddress3,
50
+ siteAddress4,
51
+ sitePostcode,
52
+ siteCountry,
53
+ sitePhone1,
54
+ siteEmail,
55
+ };
56
+ ```
57
+
58
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -7,7 +7,7 @@ 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
13
  **user** | **string** | Activity User Name | [optional] [default to undefined]
@@ -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
@@ -0,0 +1,98 @@
1
+ # Customer
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **createdDate** | **string** | | [optional] [default to undefined]
9
+ **id** | **number** | | [optional] [default to undefined]
10
+ **customerCode** | **string** | | [default to undefined]
11
+ **parentCustomerCode** | **string** | | [optional] [default to undefined]
12
+ **customerName** | **string** | | [default to undefined]
13
+ **accountId** | **string** | | [optional] [default to undefined]
14
+ **contactName** | **string** | | [optional] [default to undefined]
15
+ **address1** | **string** | | [optional] [default to undefined]
16
+ **address2** | **string** | | [optional] [default to undefined]
17
+ **address3** | **string** | | [optional] [default to undefined]
18
+ **address4** | **string** | | [optional] [default to undefined]
19
+ **postCode** | **string** | | [optional] [default to undefined]
20
+ **country** | **string** | | [optional] [default to undefined]
21
+ **phone1** | **string** | | [optional] [default to undefined]
22
+ **email** | **string** | | [optional] [default to undefined]
23
+ **ddEnabled** | **boolean** | | [optional] [default to undefined]
24
+ **acClosedDate** | **string** | | [optional] [default to undefined]
25
+ **siteInfo** | **string** | | [optional] [default to undefined]
26
+ **siteContactName** | **string** | | [optional] [default to undefined]
27
+ **siteAddress1** | **string** | | [optional] [default to undefined]
28
+ **siteAddress2** | **string** | | [optional] [default to undefined]
29
+ **siteAddress3** | **string** | | [optional] [default to undefined]
30
+ **siteAddress4** | **string** | | [optional] [default to undefined]
31
+ **sitePostcode** | **string** | | [optional] [default to undefined]
32
+ **siteCountry** | **string** | | [optional] [default to undefined]
33
+ **sitePhone1** | **string** | | [optional] [default to undefined]
34
+ **siteEmail** | **string** | | [optional] [default to undefined]
35
+ **vatCode** | **string** | | [optional] [default to undefined]
36
+ **outboundClis** | [**Array<OutboundCli>**](OutboundCli.md) | | [optional] [readonly] [default to undefined]
37
+ **inboundClis** | [**Array<InboundCli>**](InboundCli.md) | | [optional] [readonly] [default to undefined]
38
+ **bundles** | [**Array<Bundle>**](Bundle.md) | | [optional] [readonly] [default to undefined]
39
+ **bundleCustomers** | [**Array<BundleCustomer>**](BundleCustomer.md) | | [optional] [readonly] [default to undefined]
40
+ **ddiBilling** | **boolean** | | [optional] [default to undefined]
41
+ **lastInvoiceNumber** | **string** | | [optional] [default to undefined]
42
+ **username** | **string** | | [optional] [default to undefined]
43
+ **sshKey** | **string** | | [optional] [default to undefined]
44
+ **directCustomer** | **boolean** | | [optional] [readonly] [default to undefined]
45
+ **parentCustomer** | **boolean** | | [optional] [readonly] [default to undefined]
46
+ **childCustomer** | **boolean** | | [optional] [readonly] [default to undefined]
47
+ **acClosed** | **boolean** | | [optional] [readonly] [default to undefined]
48
+
49
+ ## Example
50
+
51
+ ```typescript
52
+ import { Customer } from 'yellowgrid-api-ts';
53
+
54
+ const instance: Customer = {
55
+ createdDate,
56
+ id,
57
+ customerCode,
58
+ parentCustomerCode,
59
+ customerName,
60
+ accountId,
61
+ contactName,
62
+ address1,
63
+ address2,
64
+ address3,
65
+ address4,
66
+ postCode,
67
+ country,
68
+ phone1,
69
+ email,
70
+ ddEnabled,
71
+ acClosedDate,
72
+ siteInfo,
73
+ siteContactName,
74
+ siteAddress1,
75
+ siteAddress2,
76
+ siteAddress3,
77
+ siteAddress4,
78
+ sitePostcode,
79
+ siteCountry,
80
+ sitePhone1,
81
+ siteEmail,
82
+ vatCode,
83
+ outboundClis,
84
+ inboundClis,
85
+ bundles,
86
+ bundleCustomers,
87
+ ddiBilling,
88
+ lastInvoiceNumber,
89
+ username,
90
+ sshKey,
91
+ directCustomer,
92
+ parentCustomer,
93
+ childCustomer,
94
+ acClosed,
95
+ };
96
+ ```
97
+
98
+ [[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,31 @@
1
+ # CustomerCoordinatesDTO
2
+
3
+ Customer Coordinates
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **id** | **string** | ID | [optional] [default to undefined]
10
+ **company** | **string** | Company | [optional] [default to undefined]
11
+ **resellerId** | **string** | 3CX Reseller ID | [optional] [default to undefined]
12
+ **postCode** | **string** | Post Code | [optional] [default to undefined]
13
+ **latitude** | **string** | Latitude | [optional] [default to undefined]
14
+ **longitude** | **string** | Longitude | [optional] [default to undefined]
15
+
16
+ ## Example
17
+
18
+ ```typescript
19
+ import { CustomerCoordinatesDTO } from 'yellowgrid-api-ts';
20
+
21
+ const instance: CustomerCoordinatesDTO = {
22
+ id,
23
+ company,
24
+ resellerId,
25
+ postCode,
26
+ latitude,
27
+ longitude,
28
+ };
29
+ ```
30
+
31
+ [[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
 
@@ -0,0 +1,22 @@
1
+ # CustomerRate
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **markup** | [**CustomerRateType**](CustomerRateType.md) | | [optional] [default to undefined]
9
+ **amount** | **number** | | [optional] [default to undefined]
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import { CustomerRate } from 'yellowgrid-api-ts';
15
+
16
+ const instance: CustomerRate = {
17
+ markup,
18
+ amount,
19
+ };
20
+ ```
21
+
22
+ [[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,12 @@
1
+ # CustomerRateType
2
+
3
+
4
+ ## Enum
5
+
6
+ * `Fixed` (value: `'FIXED'`)
7
+
8
+ * `MarkupPercent` (value: `'MARKUP_PERCENT'`)
9
+
10
+ * `MarkupFixed` (value: `'MARKUP_FIXED'`)
11
+
12
+ [[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<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