yellowgrid-api-ts 3.2.232 → 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.
Files changed (865) hide show
  1. package/.openapi-generator/FILES +394 -299
  2. package/.openapi-generator/VERSION +1 -1
  3. package/README.md +198 -3
  4. package/api.ts +19590 -10472
  5. package/base.ts +2 -2
  6. package/common.ts +1 -1
  7. package/config.json +4 -3
  8. package/configuration.ts +1 -1
  9. package/dist/api.d.ts +12161 -7129
  10. package/dist/api.js +17737 -8997
  11. package/dist/base.d.ts +1 -1
  12. package/dist/base.js +2 -2
  13. package/dist/common.d.ts +1 -1
  14. package/dist/common.js +1 -1
  15. package/dist/configuration.d.ts +1 -1
  16. package/dist/configuration.js +1 -1
  17. package/dist/index.d.ts +1 -1
  18. package/dist/index.js +1 -1
  19. package/dist/models/ConnectionTypeEnum.d.ts +63 -0
  20. package/dist/models/ConnectionTypeEnum.js +65 -0
  21. package/dist/models/GraphTypeEnum.d.ts +13 -0
  22. package/dist/models/GraphTypeEnum.js +15 -0
  23. package/dist/models/HostingPriceListEnum.d.ts +5 -0
  24. package/dist/models/HostingPriceListEnum.js +5 -0
  25. package/dist/models/ReasonEnum.d.ts +23 -0
  26. package/dist/models/ReasonEnum.js +25 -0
  27. package/dist/models/ReportEnum.d.ts +68 -0
  28. package/dist/models/ReportEnum.js +70 -0
  29. package/dist/models/ResolutionEnum.d.ts +18 -0
  30. package/dist/models/ResolutionEnum.js +20 -0
  31. package/dist/models/RmaItemCreditTypeEnum.d.ts +13 -0
  32. package/dist/models/RmaItemCreditTypeEnum.js +15 -0
  33. package/dist/models/RmaItemResolutionEnum.d.ts +28 -0
  34. package/dist/models/RmaItemResolutionEnum.js +30 -0
  35. package/dist/models/RmaItemStatusEnum.d.ts +18 -0
  36. package/dist/models/RmaItemStatusEnum.js +20 -0
  37. package/dist/models/RmaStatusEnum.d.ts +28 -0
  38. package/dist/models/RmaStatusEnum.js +30 -0
  39. package/dist/models/StatusEnum.d.ts +18 -0
  40. package/dist/models/StatusEnum.js +20 -0
  41. package/dist/src/apis/AccountsApi.d.ts +258 -0
  42. package/dist/src/apis/AccountsApi.js +975 -0
  43. package/dist/src/apis/CRMApi.d.ts +26 -0
  44. package/dist/src/apis/CRMApi.js +122 -0
  45. package/dist/src/apis/Class3CXApi.d.ts +44 -0
  46. package/dist/src/apis/Class3CXApi.js +177 -0
  47. package/dist/src/apis/Class3CXInstallationWizardApi.d.ts +446 -0
  48. package/dist/src/apis/Class3CXInstallationWizardApi.js +1740 -0
  49. package/dist/src/apis/Class3CXInstallationsApi.d.ts +253 -0
  50. package/dist/src/apis/Class3CXInstallationsApi.js +806 -0
  51. package/dist/src/apis/Class3CXIntegrationsApi.d.ts +102 -0
  52. package/dist/src/apis/Class3CXIntegrationsApi.js +386 -0
  53. package/dist/src/apis/Class3CXMultiTenantApi.d.ts +122 -0
  54. package/dist/src/apis/Class3CXMultiTenantApi.js +431 -0
  55. package/dist/src/apis/MyPBXToolsApi.d.ts +32 -0
  56. package/dist/src/apis/MyPBXToolsApi.js +136 -0
  57. package/dist/src/apis/OAuth20Api.d.ts +185 -0
  58. package/dist/src/apis/OAuth20Api.js +507 -0
  59. package/dist/src/apis/OrdersApi.d.ts +154 -0
  60. package/dist/src/apis/OrdersApi.js +512 -0
  61. package/dist/src/apis/PricingApi.d.ts +154 -0
  62. package/dist/src/apis/PricingApi.js +308 -0
  63. package/dist/src/apis/ProductsApi.d.ts +135 -0
  64. package/dist/src/apis/ProductsApi.js +531 -0
  65. package/dist/src/apis/ProvisioningApi.d.ts +112 -0
  66. package/dist/src/apis/ProvisioningApi.js +427 -0
  67. package/dist/src/apis/SIPTrunksApi.d.ts +315 -0
  68. package/dist/src/apis/SIPTrunksApi.js +1197 -0
  69. package/dist/src/apis/SMSApi.d.ts +30 -0
  70. package/dist/src/apis/SMSApi.js +130 -0
  71. package/dist/src/apis/ServicesApi.d.ts +81 -0
  72. package/dist/src/apis/ServicesApi.js +386 -0
  73. package/dist/src/apis/ShippingApi.d.ts +45 -0
  74. package/dist/src/apis/ShippingApi.js +179 -0
  75. package/dist/src/apis/StockManagementApi.d.ts +345 -0
  76. package/dist/src/apis/StockManagementApi.js +1293 -0
  77. package/dist/src/apis/SystemApi.d.ts +37 -0
  78. package/dist/src/apis/SystemApi.js +146 -0
  79. package/dist/src/apis/TicketsApi.d.ts +79 -0
  80. package/dist/src/apis/TicketsApi.js +360 -0
  81. package/dist/src/apis/WebhooksApi.d.ts +56 -0
  82. package/dist/src/apis/WebhooksApi.js +189 -0
  83. package/dist/src/apis/index.d.ts +21 -0
  84. package/dist/src/apis/index.js +39 -0
  85. package/dist/src/index.d.ts +3 -0
  86. package/dist/src/index.js +21 -0
  87. package/dist/src/models/AbstractOrderRequestDTO.d.ts +71 -0
  88. package/dist/src/models/AbstractOrderRequestDTO.js +64 -0
  89. package/dist/src/models/AccountContactEntity.d.ts +104 -0
  90. package/dist/src/models/AccountContactEntity.js +73 -0
  91. package/dist/src/models/AccountContactModel.d.ts +104 -0
  92. package/dist/src/models/AccountContactModel.js +73 -0
  93. package/dist/src/models/AccountContactRequestModel.d.ts +80 -0
  94. package/dist/src/models/AccountContactRequestModel.js +65 -0
  95. package/dist/src/models/AccountDetailedSummaryDTO.d.ts +89 -0
  96. package/dist/src/models/AccountDetailedSummaryDTO.js +70 -0
  97. package/dist/src/models/AccountRequestModel.d.ts +128 -0
  98. package/dist/src/models/AccountRequestModel.js +81 -0
  99. package/dist/src/models/AccountSummaryDTO.d.ts +44 -0
  100. package/dist/src/models/AccountSummaryDTO.js +53 -0
  101. package/dist/src/models/AccountsResponseModel.d.ts +51 -0
  102. package/dist/src/models/AccountsResponseModel.js +56 -0
  103. package/dist/src/models/AddressModel.d.ts +110 -0
  104. package/dist/src/models/AddressModel.js +75 -0
  105. package/dist/src/models/AddressRequestModel.d.ts +50 -0
  106. package/dist/src/models/AddressRequestModel.js +55 -0
  107. package/dist/src/models/AdminOrderRequestDTO.d.ts +113 -0
  108. package/dist/src/models/AdminOrderRequestDTO.js +78 -0
  109. package/dist/src/models/AdminUserModel.d.ts +79 -0
  110. package/dist/src/models/AdminUserModel.js +72 -0
  111. package/dist/src/models/AgentHoursGraphModel.d.ts +51 -0
  112. package/dist/src/models/AgentHoursGraphModel.js +56 -0
  113. package/dist/src/models/AgentHoursGraphMonthModel.d.ts +38 -0
  114. package/dist/src/models/AgentHoursGraphMonthModel.js +51 -0
  115. package/dist/src/models/ApiLogEntity.d.ts +98 -0
  116. package/dist/src/models/ApiLogEntity.js +71 -0
  117. package/dist/src/models/AreaCodeModel.d.ts +38 -0
  118. package/dist/src/models/AreaCodeModel.js +51 -0
  119. package/dist/src/models/AttachmentModel.d.ts +56 -0
  120. package/dist/src/models/AttachmentModel.js +57 -0
  121. package/dist/src/models/AttributeSetEnum.d.ts +38 -0
  122. package/dist/src/models/AttributeSetEnum.js +51 -0
  123. package/dist/src/models/AuditLogEntity.d.ts +80 -0
  124. package/dist/src/models/AuditLogEntity.js +65 -0
  125. package/dist/src/models/AuthCodeResponseModel.d.ts +44 -0
  126. package/dist/src/models/AuthCodeResponseModel.js +53 -0
  127. package/dist/src/models/BasicItemDTO.d.ts +38 -0
  128. package/dist/src/models/BasicItemDTO.js +51 -0
  129. package/dist/src/models/BasicProductDTO.d.ts +38 -0
  130. package/dist/src/models/BasicProductDTO.js +51 -0
  131. package/dist/src/models/BatchEntity.d.ts +128 -0
  132. package/dist/src/models/BatchEntity.js +81 -0
  133. package/dist/src/models/CallBarringModel.d.ts +56 -0
  134. package/dist/src/models/CallBarringModel.js +57 -0
  135. package/dist/src/models/ClientDetailsModel.d.ts +68 -0
  136. package/dist/src/models/ClientDetailsModel.js +61 -0
  137. package/dist/src/models/ClientModel.d.ts +50 -0
  138. package/dist/src/models/ClientModel.js +55 -0
  139. package/dist/src/models/CompanyContractModel.d.ts +56 -0
  140. package/dist/src/models/CompanyContractModel.js +57 -0
  141. package/dist/src/models/ContactInfoModel.d.ts +56 -0
  142. package/dist/src/models/ContactInfoModel.js +57 -0
  143. package/dist/src/models/ConversationModel.d.ts +75 -0
  144. package/dist/src/models/ConversationModel.js +64 -0
  145. package/dist/src/models/CourierPriceEntity.d.ts +86 -0
  146. package/dist/src/models/CourierPriceEntity.js +67 -0
  147. package/dist/src/models/CreditAccountEntity.d.ts +152 -0
  148. package/dist/src/models/CreditAccountEntity.js +89 -0
  149. package/dist/src/models/CrmContactDTO.d.ts +68 -0
  150. package/dist/src/models/CrmContactDTO.js +61 -0
  151. package/dist/src/models/CustomerInformationModel.d.ts +68 -0
  152. package/dist/src/models/CustomerInformationModel.js +61 -0
  153. package/dist/src/models/CustomerItemRequestDTO.d.ts +81 -0
  154. package/dist/src/models/CustomerItemRequestDTO.js +66 -0
  155. package/dist/src/models/CustomerOrderRequestDTO.d.ts +71 -0
  156. package/dist/src/models/CustomerOrderRequestDTO.js +64 -0
  157. package/dist/src/models/CustomerPriceListEnum.d.ts +38 -0
  158. package/dist/src/models/CustomerPriceListEnum.js +51 -0
  159. package/dist/src/models/CustomerSummaryReportDTO.d.ts +65 -0
  160. package/dist/src/models/CustomerSummaryReportDTO.js +62 -0
  161. package/dist/src/models/DdiRangeRequestModel.d.ts +44 -0
  162. package/dist/src/models/DdiRangeRequestModel.js +53 -0
  163. package/dist/src/models/DdiRangesRequestModel.d.ts +33 -0
  164. package/dist/src/models/DdiRangesRequestModel.js +50 -0
  165. package/dist/src/models/DetailedItemRequestDTO.d.ts +99 -0
  166. package/dist/src/models/DetailedItemRequestDTO.js +72 -0
  167. package/dist/src/models/DetailedOrderRequestDTO.d.ts +71 -0
  168. package/dist/src/models/DetailedOrderRequestDTO.js +64 -0
  169. package/dist/src/models/DivertRequestModel.d.ts +38 -0
  170. package/dist/src/models/DivertRequestModel.js +51 -0
  171. package/dist/src/models/DivertResponseModel.d.ts +52 -0
  172. package/dist/src/models/DivertResponseModel.js +61 -0
  173. package/dist/src/models/EdTechProClientEntity.d.ts +56 -0
  174. package/dist/src/models/EdTechProClientEntity.js +57 -0
  175. package/dist/src/models/EdTechProSchoolModel.d.ts +104 -0
  176. package/dist/src/models/EdTechProSchoolModel.js +73 -0
  177. package/dist/src/models/EdTechProSchoolsModel.d.ts +51 -0
  178. package/dist/src/models/EdTechProSchoolsModel.js +56 -0
  179. package/dist/src/models/EdTechProSetupModel.d.ts +56 -0
  180. package/dist/src/models/EdTechProSetupModel.js +57 -0
  181. package/dist/src/models/EventDTO.d.ts +84 -0
  182. package/dist/src/models/EventDTO.js +73 -0
  183. package/dist/src/models/EventRequestDTO.d.ts +44 -0
  184. package/dist/src/models/EventRequestDTO.js +53 -0
  185. package/dist/src/models/EventSubscriptionModel.d.ts +38 -0
  186. package/dist/src/models/EventSubscriptionModel.js +51 -0
  187. package/dist/src/models/EventTypeEnum.d.ts +19 -0
  188. package/dist/src/models/EventTypeEnum.js +24 -0
  189. package/dist/src/models/EventUpdateDTO.d.ts +50 -0
  190. package/dist/src/models/EventUpdateDTO.js +55 -0
  191. package/dist/src/models/EventUpdateEntity.d.ts +56 -0
  192. package/dist/src/models/EventUpdateEntity.js +57 -0
  193. package/dist/src/models/EventUpdateRequestDTO.d.ts +44 -0
  194. package/dist/src/models/EventUpdateRequestDTO.js +53 -0
  195. package/dist/src/models/FraudManagementModel.d.ts +38 -0
  196. package/dist/src/models/FraudManagementModel.js +51 -0
  197. package/dist/src/models/FreshdeskCompanyTicketsModel.d.ts +51 -0
  198. package/dist/src/models/FreshdeskCompanyTicketsModel.js +56 -0
  199. package/dist/src/models/FreshdeskTicketEntity.d.ts +68 -0
  200. package/dist/src/models/FreshdeskTicketEntity.js +61 -0
  201. package/dist/src/models/FtpAccountsEntity.d.ts +56 -0
  202. package/dist/src/models/FtpAccountsEntity.js +57 -0
  203. package/dist/src/models/GenericFileModel.d.ts +44 -0
  204. package/dist/src/models/GenericFileModel.js +53 -0
  205. package/dist/src/models/GetGetPrice200Response.d.ts +32 -0
  206. package/dist/src/models/GetGetPrice200Response.js +49 -0
  207. package/dist/src/models/GetGetRecording200Response.d.ts +32 -0
  208. package/dist/src/models/GetGetRecording200Response.js +49 -0
  209. package/dist/src/models/HostingChangeResponseModel.d.ts +64 -0
  210. package/dist/src/models/HostingChangeResponseModel.js +65 -0
  211. package/dist/src/models/HostingRegionDTO.d.ts +59 -0
  212. package/dist/src/models/HostingRegionDTO.js +68 -0
  213. package/dist/src/models/InstanceAutoFailoverEntity.d.ts +56 -0
  214. package/dist/src/models/InstanceAutoFailoverEntity.js +57 -0
  215. package/dist/src/models/InstanceDeletionScheduleEntity.d.ts +50 -0
  216. package/dist/src/models/InstanceDeletionScheduleEntity.js +55 -0
  217. package/dist/src/models/InstanceEntity.d.ts +152 -0
  218. package/dist/src/models/InstanceEntity.js +89 -0
  219. package/dist/src/models/InstanceFailoverEntity.d.ts +92 -0
  220. package/dist/src/models/InstanceFailoverEntity.js +69 -0
  221. package/dist/src/models/InstanceMonitoringEntity.d.ts +44 -0
  222. package/dist/src/models/InstanceMonitoringEntity.js +53 -0
  223. package/dist/src/models/InstanceMonitoringLogEntity.d.ts +62 -0
  224. package/dist/src/models/InstanceMonitoringLogEntity.js +59 -0
  225. package/dist/src/models/InstanceScheduledTasksEntity.d.ts +62 -0
  226. package/dist/src/models/InstanceScheduledTasksEntity.js +59 -0
  227. package/dist/src/models/InstanceTcxDetailsEntity.d.ts +86 -0
  228. package/dist/src/models/InstanceTcxDetailsEntity.js +67 -0
  229. package/dist/src/models/InstanceUserCredentialsEntity.d.ts +56 -0
  230. package/dist/src/models/InstanceUserCredentialsEntity.js +57 -0
  231. package/dist/src/models/ItemDTO.d.ts +117 -0
  232. package/dist/src/models/ItemDTO.js +78 -0
  233. package/dist/src/models/ItemDiscountEntity.d.ts +77 -0
  234. package/dist/src/models/ItemDiscountEntity.js +70 -0
  235. package/dist/src/models/ItemEntity.d.ts +158 -0
  236. package/dist/src/models/ItemEntity.js +91 -0
  237. package/dist/src/models/LinkedOrderEntity.d.ts +38 -0
  238. package/dist/src/models/LinkedOrderEntity.js +51 -0
  239. package/dist/src/models/MFARequiredModel.d.ts +38 -0
  240. package/dist/src/models/MFARequiredModel.js +51 -0
  241. package/dist/src/models/MonthlyUsageModel.d.ts +38 -0
  242. package/dist/src/models/MonthlyUsageModel.js +51 -0
  243. package/dist/src/models/MultiTenantChangeResponseModel.d.ts +70 -0
  244. package/dist/src/models/MultiTenantChangeResponseModel.js +75 -0
  245. package/dist/src/models/NavigationModel.d.ts +50 -0
  246. package/dist/src/models/NavigationModel.js +55 -0
  247. package/dist/src/models/OfflineInstancesEntity.d.ts +56 -0
  248. package/dist/src/models/OfflineInstancesEntity.js +57 -0
  249. package/dist/src/models/OrderEntity.d.ts +374 -0
  250. package/dist/src/models/OrderEntity.js +163 -0
  251. package/dist/src/models/OrderRequestModel.d.ts +120 -0
  252. package/dist/src/models/OrderRequestModel.js +88 -0
  253. package/dist/src/models/OrderSummariesModel.d.ts +51 -0
  254. package/dist/src/models/OrderSummariesModel.js +56 -0
  255. package/dist/src/models/OrderSummaryDTO.d.ts +126 -0
  256. package/dist/src/models/OrderSummaryDTO.js +83 -0
  257. package/dist/src/models/OrderTotalModel.d.ts +111 -0
  258. package/dist/src/models/OrderTotalModel.js +100 -0
  259. package/dist/src/models/OrderedItemEntity.d.ts +110 -0
  260. package/dist/src/models/OrderedItemEntity.js +75 -0
  261. package/dist/src/models/PatchSetTcxWizardCnameRequest.d.ts +32 -0
  262. package/dist/src/models/PatchSetTcxWizardCnameRequest.js +49 -0
  263. package/dist/src/models/PatchUpdateAccountContactPasswordRequest.d.ts +32 -0
  264. package/dist/src/models/PatchUpdateAccountContactPasswordRequest.js +49 -0
  265. package/dist/src/models/PortalAccountModel.d.ts +171 -0
  266. package/dist/src/models/PortalAccountModel.js +96 -0
  267. package/dist/src/models/PortalLoginModel.d.ts +68 -0
  268. package/dist/src/models/PortalLoginModel.js +61 -0
  269. package/dist/src/models/PostAddWebhook200Response.d.ts +32 -0
  270. package/dist/src/models/PostAddWebhook200Response.js +49 -0
  271. package/dist/src/models/PostGetClientCredentialsRequest.d.ts +32 -0
  272. package/dist/src/models/PostGetClientCredentialsRequest.js +49 -0
  273. package/dist/src/models/PostGetProductForCustomerRequest.d.ts +50 -0
  274. package/dist/src/models/PostGetProductForCustomerRequest.js +55 -0
  275. package/dist/src/models/PostGetProductRequest.d.ts +44 -0
  276. package/dist/src/models/PostGetProductRequest.js +53 -0
  277. package/dist/src/models/PriceListItemModel.d.ts +56 -0
  278. package/dist/src/models/PriceListItemModel.js +57 -0
  279. package/dist/src/models/PrizesEntity.d.ts +62 -0
  280. package/dist/src/models/PrizesEntity.js +59 -0
  281. package/dist/src/models/ProductPriceListItemModel.d.ts +62 -0
  282. package/dist/src/models/ProductPriceListItemModel.js +59 -0
  283. package/dist/src/models/ProductSearchResultsModel.d.ts +33 -0
  284. package/dist/src/models/ProductSearchResultsModel.js +50 -0
  285. package/dist/src/models/ProductSerialInfoModel.d.ts +50 -0
  286. package/dist/src/models/ProductSerialInfoModel.js +55 -0
  287. package/dist/src/models/ProductSummaryDTO.d.ts +81 -0
  288. package/dist/src/models/ProductSummaryDTO.js +66 -0
  289. package/dist/src/models/PromoCodesEntity.d.ts +98 -0
  290. package/dist/src/models/PromoCodesEntity.js +71 -0
  291. package/dist/src/models/PromoItemsEntity.d.ts +74 -0
  292. package/dist/src/models/PromoItemsEntity.js +63 -0
  293. package/dist/src/models/ProvisioningModel.d.ts +56 -0
  294. package/dist/src/models/ProvisioningModel.js +57 -0
  295. package/dist/src/models/ProvisioningRequestEntity.d.ts +44 -0
  296. package/dist/src/models/ProvisioningRequestEntity.js +53 -0
  297. package/dist/src/models/RecordingBackupAzureModel.d.ts +50 -0
  298. package/dist/src/models/RecordingBackupAzureModel.js +55 -0
  299. package/dist/src/models/RecordingsBackupInfoDTO.d.ts +40 -0
  300. package/dist/src/models/RecordingsBackupInfoDTO.js +53 -0
  301. package/dist/src/models/ResourceNotReadyException.d.ts +44 -0
  302. package/dist/src/models/ResourceNotReadyException.js +53 -0
  303. package/dist/src/models/RootAccessModel.d.ts +44 -0
  304. package/dist/src/models/RootAccessModel.js +53 -0
  305. package/dist/src/models/S3BucketEntity.d.ts +50 -0
  306. package/dist/src/models/S3BucketEntity.js +55 -0
  307. package/dist/src/models/ScannedItemModel.d.ts +56 -0
  308. package/dist/src/models/ScannedItemModel.js +57 -0
  309. package/dist/src/models/ScopeModel.d.ts +38 -0
  310. package/dist/src/models/ScopeModel.js +51 -0
  311. package/dist/src/models/ServiceEnum.d.ts +14 -0
  312. package/dist/src/models/ServiceEnum.js +19 -0
  313. package/dist/src/models/ServiceHealthDTO.d.ts +48 -0
  314. package/dist/src/models/ServiceHealthDTO.js +61 -0
  315. package/dist/src/models/ServiceHealthEnum.d.ts +19 -0
  316. package/dist/src/models/ServiceHealthEnum.js +24 -0
  317. package/dist/src/models/ServiceStatusDTO.d.ts +60 -0
  318. package/dist/src/models/ServiceStatusDTO.js +65 -0
  319. package/dist/src/models/ServiceStatusEnum.d.ts +19 -0
  320. package/dist/src/models/ServiceStatusEnum.js +24 -0
  321. package/dist/src/models/ShipmentAddressEntity.d.ts +92 -0
  322. package/dist/src/models/ShipmentAddressEntity.js +69 -0
  323. package/dist/src/models/ShipmentEntity.d.ts +98 -0
  324. package/dist/src/models/ShipmentEntity.js +71 -0
  325. package/dist/src/models/ShipmentItemEntity.d.ts +56 -0
  326. package/dist/src/models/ShipmentItemEntity.js +57 -0
  327. package/dist/src/models/ShippingConsignmentModel.d.ts +51 -0
  328. package/dist/src/models/ShippingConsignmentModel.js +56 -0
  329. package/dist/src/models/ShippingInformationDTO.d.ts +45 -0
  330. package/dist/src/models/ShippingInformationDTO.js +54 -0
  331. package/dist/src/models/ShippingServiceDTO.d.ts +47 -0
  332. package/dist/src/models/ShippingServiceDTO.js +60 -0
  333. package/dist/src/models/ShippingServiceModel.d.ts +71 -0
  334. package/dist/src/models/ShippingServiceModel.js +68 -0
  335. package/dist/src/models/ShippingServicesModel.d.ts +33 -0
  336. package/dist/src/models/ShippingServicesModel.js +50 -0
  337. package/dist/src/models/SipTrunkChangeResponseModel.d.ts +77 -0
  338. package/dist/src/models/SipTrunkChangeResponseModel.js +78 -0
  339. package/dist/src/models/SipTrunkCreationRequestModel.d.ts +66 -0
  340. package/dist/src/models/SipTrunkCreationRequestModel.js +63 -0
  341. package/dist/src/models/SipTrunkEntity.d.ts +98 -0
  342. package/dist/src/models/SipTrunkEntity.js +71 -0
  343. package/dist/src/models/SipTrunksResponseModel.d.ts +51 -0
  344. package/dist/src/models/SipTrunksResponseModel.js +56 -0
  345. package/dist/src/models/SmsAccountEntity.d.ts +68 -0
  346. package/dist/src/models/SmsAccountEntity.js +61 -0
  347. package/dist/src/models/SmsDataModel.d.ts +33 -0
  348. package/dist/src/models/SmsDataModel.js +50 -0
  349. package/dist/src/models/SmsMessageModel.d.ts +44 -0
  350. package/dist/src/models/SmsMessageModel.js +53 -0
  351. package/dist/src/models/SmsNumbersEntity.d.ts +38 -0
  352. package/dist/src/models/SmsNumbersEntity.js +51 -0
  353. package/dist/src/models/SmsPayloadModel.d.ts +45 -0
  354. package/dist/src/models/SmsPayloadModel.js +54 -0
  355. package/dist/src/models/SmsPhoneNumberModel.d.ts +53 -0
  356. package/dist/src/models/SmsPhoneNumberModel.js +66 -0
  357. package/dist/src/models/SmsResponseModel.d.ts +67 -0
  358. package/dist/src/models/SmsResponseModel.js +68 -0
  359. package/dist/src/models/SmsWhitelistEntity.d.ts +38 -0
  360. package/dist/src/models/SmsWhitelistEntity.js +51 -0
  361. package/dist/src/models/StockOrderCourierEntity.d.ts +50 -0
  362. package/dist/src/models/StockOrderCourierEntity.js +55 -0
  363. package/dist/src/models/StockOrderDeductionModel.d.ts +50 -0
  364. package/dist/src/models/StockOrderDeductionModel.js +55 -0
  365. package/dist/src/models/StockOrderDeductionRequestModel.d.ts +38 -0
  366. package/dist/src/models/StockOrderDeductionRequestModel.js +51 -0
  367. package/dist/src/models/StockOrderDeductionsEntity.d.ts +50 -0
  368. package/dist/src/models/StockOrderDeductionsEntity.js +55 -0
  369. package/dist/src/models/StockOrderEntity.d.ts +158 -0
  370. package/dist/src/models/StockOrderEntity.js +91 -0
  371. package/dist/src/models/StockOrderItemEntity.d.ts +68 -0
  372. package/dist/src/models/StockOrderItemEntity.js +61 -0
  373. package/dist/src/models/StockOrderItemModel.d.ts +80 -0
  374. package/dist/src/models/StockOrderItemModel.js +65 -0
  375. package/dist/src/models/StockOrderItemRequestModel.d.ts +50 -0
  376. package/dist/src/models/StockOrderItemRequestModel.js +55 -0
  377. package/dist/src/models/StockOrderModel.d.ts +137 -0
  378. package/dist/src/models/StockOrderModel.js +97 -0
  379. package/dist/src/models/StockOrderProductEntity.d.ts +62 -0
  380. package/dist/src/models/StockOrderProductEntity.js +59 -0
  381. package/dist/src/models/StockOrderRequestModel.d.ts +46 -0
  382. package/dist/src/models/StockOrderRequestModel.js +55 -0
  383. package/dist/src/models/StockOrderSupplierEntity.d.ts +80 -0
  384. package/dist/src/models/StockOrderSupplierEntity.js +65 -0
  385. package/dist/src/models/StockOrderSupplierModel.d.ts +80 -0
  386. package/dist/src/models/StockOrderSupplierModel.js +65 -0
  387. package/dist/src/models/StockOrdersModel.d.ts +51 -0
  388. package/dist/src/models/StockOrdersModel.js +56 -0
  389. package/dist/src/models/StockProductModel.d.ts +120 -0
  390. package/dist/src/models/StockProductModel.js +81 -0
  391. package/dist/src/models/StockProductPriceModel.d.ts +39 -0
  392. package/dist/src/models/StockProductPriceModel.js +52 -0
  393. package/dist/src/models/StockProductSummariesModel.d.ts +51 -0
  394. package/dist/src/models/StockProductSummariesModel.js +56 -0
  395. package/dist/src/models/StockProductSummaryModel.d.ts +69 -0
  396. package/dist/src/models/StockProductSummaryModel.js +62 -0
  397. package/dist/src/models/StockTransactionsEntity.d.ts +74 -0
  398. package/dist/src/models/StockTransactionsEntity.js +63 -0
  399. package/dist/src/models/SupplierEntity.d.ts +80 -0
  400. package/dist/src/models/SupplierEntity.js +65 -0
  401. package/dist/src/models/SupplierItemEntity.d.ts +74 -0
  402. package/dist/src/models/SupplierItemEntity.js +63 -0
  403. package/dist/src/models/TcxBackupEntity.d.ts +80 -0
  404. package/dist/src/models/TcxBackupEntity.js +65 -0
  405. package/dist/src/models/TcxBackupModel.d.ts +140 -0
  406. package/dist/src/models/TcxBackupModel.js +85 -0
  407. package/dist/src/models/TcxBillingEntity.d.ts +86 -0
  408. package/dist/src/models/TcxBillingEntity.js +67 -0
  409. package/dist/src/models/TcxBulkLicenceDetailsModel.d.ts +40 -0
  410. package/dist/src/models/TcxBulkLicenceDetailsModel.js +53 -0
  411. package/dist/src/models/TcxDeadLicenceEntity.d.ts +44 -0
  412. package/dist/src/models/TcxDeadLicenceEntity.js +53 -0
  413. package/dist/src/models/TcxExtsEntity.d.ts +74 -0
  414. package/dist/src/models/TcxExtsEntity.js +63 -0
  415. package/dist/src/models/TcxHostingPricingEntity.d.ts +74 -0
  416. package/dist/src/models/TcxHostingPricingEntity.js +63 -0
  417. package/dist/src/models/TcxInstallationDetailsModel.d.ts +106 -0
  418. package/dist/src/models/TcxInstallationDetailsModel.js +75 -0
  419. package/dist/src/models/TcxInstallationModel.d.ts +200 -0
  420. package/dist/src/models/TcxInstallationModel.js +105 -0
  421. package/dist/src/models/TcxInstallationsModel.d.ts +51 -0
  422. package/dist/src/models/TcxInstallationsModel.js +56 -0
  423. package/dist/src/models/TcxKeySummaryDTO.d.ts +56 -0
  424. package/dist/src/models/TcxKeySummaryDTO.js +57 -0
  425. package/dist/src/models/TcxKeysEntity.d.ts +62 -0
  426. package/dist/src/models/TcxKeysEntity.js +59 -0
  427. package/dist/src/models/TcxLicenceDetailsErrorModel.d.ts +50 -0
  428. package/dist/src/models/TcxLicenceDetailsErrorModel.js +55 -0
  429. package/dist/src/models/TcxLicenceDetailsModel.d.ts +92 -0
  430. package/dist/src/models/TcxLicenceDetailsModel.js +69 -0
  431. package/dist/src/models/TcxMacsEntity.d.ts +44 -0
  432. package/dist/src/models/TcxMacsEntity.js +53 -0
  433. package/dist/src/models/TcxMultiTenantModel.d.ts +118 -0
  434. package/dist/src/models/TcxMultiTenantModel.js +83 -0
  435. package/dist/src/models/TcxMultiTenantUserModel.d.ts +44 -0
  436. package/dist/src/models/TcxMultiTenantUserModel.js +53 -0
  437. package/dist/src/models/TcxMultiTenantsModel.d.ts +51 -0
  438. package/dist/src/models/TcxMultiTenantsModel.js +56 -0
  439. package/dist/src/models/TcxNumbersEntity.d.ts +44 -0
  440. package/dist/src/models/TcxNumbersEntity.js +53 -0
  441. package/dist/src/models/TcxOfficeHoursEntity.d.ts +116 -0
  442. package/dist/src/models/TcxOfficeHoursEntity.js +77 -0
  443. package/dist/src/models/TcxPhoneModel.d.ts +68 -0
  444. package/dist/src/models/TcxPhoneModel.js +61 -0
  445. package/dist/src/models/TcxPhonesEntity.d.ts +62 -0
  446. package/dist/src/models/TcxPhonesEntity.js +59 -0
  447. package/dist/src/models/TcxRemoteStorageModel.d.ts +50 -0
  448. package/dist/src/models/TcxRemoteStorageModel.js +55 -0
  449. package/dist/src/models/TcxSbcDTO.d.ts +62 -0
  450. package/dist/src/models/TcxSbcDTO.js +59 -0
  451. package/dist/src/models/TcxSbcEntity.d.ts +122 -0
  452. package/dist/src/models/TcxSbcEntity.js +79 -0
  453. package/dist/src/models/TcxSbcModel.d.ts +122 -0
  454. package/dist/src/models/TcxSbcModel.js +79 -0
  455. package/dist/src/models/TcxSetupEntity.d.ts +207 -0
  456. package/dist/src/models/TcxSetupEntity.js +123 -0
  457. package/dist/src/models/TcxSetupsModel.d.ts +51 -0
  458. package/dist/src/models/TcxSetupsModel.js +56 -0
  459. package/dist/src/models/TcxSipTrunksEntity.d.ts +104 -0
  460. package/dist/src/models/TcxSipTrunksEntity.js +73 -0
  461. package/dist/src/models/TcxTemplateXmlEnum.d.ts +38 -0
  462. package/dist/src/models/TcxTemplateXmlEnum.js +51 -0
  463. package/dist/src/models/TcxUsersEntity.d.ts +62 -0
  464. package/dist/src/models/TcxUsersEntity.js +59 -0
  465. package/dist/src/models/TcxWizardConfigModel.d.ts +39 -0
  466. package/dist/src/models/TcxWizardConfigModel.js +52 -0
  467. package/dist/src/models/TcxWizardModel.d.ts +150 -0
  468. package/dist/src/models/TcxWizardModel.js +114 -0
  469. package/dist/src/models/TechSupportCompanySummaryDTO.d.ts +57 -0
  470. package/dist/src/models/TechSupportCompanySummaryDTO.js +58 -0
  471. package/dist/src/models/TelephonySupportTicketModel.d.ts +94 -0
  472. package/dist/src/models/TelephonySupportTicketModel.js +71 -0
  473. package/dist/src/models/TicketSummaryModel.d.ts +74 -0
  474. package/dist/src/models/TicketSummaryModel.js +63 -0
  475. package/dist/src/models/TicketTimeDTO.d.ts +80 -0
  476. package/dist/src/models/TicketTimeDTO.js +65 -0
  477. package/dist/src/models/TokenResponseModel.d.ts +44 -0
  478. package/dist/src/models/TokenResponseModel.js +53 -0
  479. package/dist/src/models/UpdateTypeEnum.d.ts +19 -0
  480. package/dist/src/models/UpdateTypeEnum.js +24 -0
  481. package/dist/src/models/UpgradeOrderResponseModel.d.ts +38 -0
  482. package/dist/src/models/UpgradeOrderResponseModel.js +51 -0
  483. package/dist/src/models/UpgradeRequestModel.d.ts +66 -0
  484. package/dist/src/models/UpgradeRequestModel.js +70 -0
  485. package/dist/src/models/UserEntity.d.ts +98 -0
  486. package/dist/src/models/UserEntity.js +71 -0
  487. package/dist/src/models/XeroLogEntity.d.ts +86 -0
  488. package/dist/src/models/XeroLogEntity.js +67 -0
  489. package/dist/src/models/index.d.ts +196 -0
  490. package/dist/src/models/index.js +214 -0
  491. package/dist/src/runtime.d.ts +184 -0
  492. package/dist/src/runtime.js +564 -0
  493. package/docs/AbstractOrderRequestDTO.md +7 -7
  494. package/docs/AccountAddressesDTO.md +3 -3
  495. package/docs/AccountContactEntity.md +13 -13
  496. package/docs/AccountContactModel.md +13 -13
  497. package/docs/AccountContactRequestModel.md +9 -9
  498. package/docs/AccountDetailedSummaryDTO.md +10 -10
  499. package/docs/AccountFinanceDTO.md +10 -10
  500. package/docs/AccountRequestModel.md +17 -17
  501. package/docs/AccountSummaryDTO.md +3 -3
  502. package/docs/AccountsApi.md +49 -1
  503. package/docs/AccountsResponseModel.md +4 -4
  504. package/docs/AddressDTO.md +12 -6
  505. package/docs/AddressModel.md +5 -5
  506. package/docs/AddressRequestModel.md +4 -4
  507. package/docs/AdminCustomerRmasModel.md +27 -0
  508. package/docs/AdminNumberPortDTO.md +18 -18
  509. package/docs/AdminOrderRequestDTO.md +7 -7
  510. package/docs/AdminRmaDTO.md +63 -0
  511. package/docs/AdminRmaItemDTO.md +49 -0
  512. package/docs/AdminRmaNoteDTO.md +27 -0
  513. package/docs/AdminRmaSummaryDTO.md +39 -0
  514. package/docs/AdminUserModel.md +10 -10
  515. package/docs/AgentHoursGraphModel.md +4 -4
  516. package/docs/AgentHoursGraphMonthModel.md +2 -2
  517. package/docs/ApiLogEntity.md +12 -12
  518. package/docs/AreaCodeModel.md +2 -2
  519. package/docs/AttachmentModel.md +5 -5
  520. package/docs/AttributeSetEnum.md +2 -2
  521. package/docs/AuditLogEntity.md +9 -9
  522. package/docs/AuthCodeResponseModel.md +3 -3
  523. package/docs/AxisDataDTO.md +25 -0
  524. package/docs/BaseService.md +36 -0
  525. package/docs/BasicItemDTO.md +2 -2
  526. package/docs/BasicProductDTO.md +2 -2
  527. package/docs/BatchDTO.md +17 -17
  528. package/docs/BatchEntity.md +17 -17
  529. package/docs/BillingApi.md +3576 -26
  530. package/docs/Bundle.md +34 -0
  531. package/docs/BundleCustomer.md +34 -0
  532. package/docs/CRMApi.md +1 -1
  533. package/docs/CallBarringModel.md +5 -5
  534. package/docs/CallTariff.md +34 -0
  535. package/docs/CallTariffPlan.md +36 -0
  536. package/docs/CallTariffResponse.md +26 -0
  537. package/docs/Cdr.md +112 -0
  538. package/docs/Class3CXApi.md +1 -1
  539. package/docs/Class3CXInstallationWizardApi.md +1 -1
  540. package/docs/Class3CXInstallationsApi.md +1 -1
  541. package/docs/Class3CXIntegrationsApi.md +1 -1
  542. package/docs/Class3CXMultiTenantApi.md +1 -1
  543. package/docs/ClientDetailsModel.md +7 -7
  544. package/docs/ClientModel.md +4 -4
  545. package/docs/CompanyContractModel.md +5 -5
  546. package/docs/ConnectionRequest.md +36 -0
  547. package/docs/ConnectionType.md +28 -0
  548. package/docs/ContactDetail.md +58 -0
  549. package/docs/ContactInfoModel.md +5 -5
  550. package/docs/ConversationModel.md +8 -8
  551. package/docs/CourierPriceEntity.md +10 -10
  552. package/docs/CreditAccountEntity.md +23 -23
  553. package/docs/CreditNoteDTO.md +1 -1
  554. package/docs/CreditNoteEntity.md +5 -5
  555. package/docs/CreditNoteItemDTO.md +3 -3
  556. package/docs/CreditNoteItemEntity.md +7 -5
  557. package/docs/CreditNoteItemModel.md +7 -5
  558. package/docs/CreditNoteModel.md +5 -5
  559. package/docs/CreditStatusDTO.md +3 -3
  560. package/docs/CrmActivitiesResponseDTO.md +2 -2
  561. package/docs/CrmActivityDTO.md +7 -7
  562. package/docs/CrmContactDTO.md +7 -7
  563. package/docs/CrmDateActivitiesDTO.md +2 -2
  564. package/docs/CrmNoteEntity.md +10 -10
  565. package/docs/CrmNoteModel.md +10 -10
  566. package/docs/Customer.md +98 -0
  567. package/docs/CustomerCoordinatesDTO.md +31 -0
  568. package/docs/CustomerInformationModel.md +4 -4
  569. package/docs/CustomerItemRequestDTO.md +2 -2
  570. package/docs/CustomerListAccountDTO.md +13 -13
  571. package/docs/CustomerOrderRequestDTO.md +7 -7
  572. package/docs/CustomerPriceListEnum.md +2 -2
  573. package/docs/CustomerRate.md +22 -0
  574. package/docs/CustomerRateType.md +12 -0
  575. package/docs/CustomerRmasModel.md +27 -0
  576. package/docs/CustomerSummaryReportDTO.md +6 -6
  577. package/docs/DdiRangeRequestModel.md +3 -3
  578. package/docs/DdiRangesRequestModel.md +1 -1
  579. package/docs/DetailedItemRequestDTO.md +2 -2
  580. package/docs/DetailedOrderRequestDTO.md +7 -7
  581. package/docs/DivertRequestModel.md +2 -2
  582. package/docs/DivertResponseModel.md +3 -3
  583. package/docs/EdTechProClientEntity.md +5 -5
  584. package/docs/EdTechProSchoolModel.md +13 -13
  585. package/docs/EdTechProSchoolsModel.md +4 -4
  586. package/docs/EdTechProSetupModel.md +5 -5
  587. package/docs/EmailRequestModel.md +21 -0
  588. package/docs/EventDTO.md +8 -8
  589. package/docs/EventRequestDTO.md +3 -3
  590. package/docs/EventSubscriptionModel.md +2 -2
  591. package/docs/EventUpdateDTO.md +4 -4
  592. package/docs/EventUpdateEntity.md +5 -5
  593. package/docs/EventUpdateRequestDTO.md +3 -3
  594. package/docs/ExpiringKeyDTO.md +5 -5
  595. package/docs/FraudManagementModel.md +2 -2
  596. package/docs/FreshdeskCompanyTicketsModel.md +4 -4
  597. package/docs/FreshdeskTicketEntity.md +7 -7
  598. package/docs/FtpAccountsEntity.md +5 -5
  599. package/docs/GenericFileModel.md +3 -3
  600. package/docs/GraphDTO.md +33 -0
  601. package/docs/HostingChangeResponseModel.md +5 -5
  602. package/docs/HostingRegionDTO.md +3 -3
  603. package/docs/InboundCli.md +50 -0
  604. package/docs/InboundTariffPlan.md +32 -0
  605. package/docs/InboundTariffPlanResponse.md +28 -0
  606. package/docs/InstallationDetailsDTO.md +10 -10
  607. package/docs/InstanceAutoFailoverEntity.md +5 -5
  608. package/docs/InstanceDeletionScheduleEntity.md +4 -4
  609. package/docs/InstanceEntity.md +21 -21
  610. package/docs/InstanceFailoverEntity.md +11 -11
  611. package/docs/InstanceMonitoringEntity.md +3 -3
  612. package/docs/InstanceMonitoringLogEntity.md +6 -6
  613. package/docs/InstanceScheduledTasksEntity.md +6 -6
  614. package/docs/InstanceTcxDetailsEntity.md +10 -10
  615. package/docs/InstanceUserCredentialsEntity.md +5 -5
  616. package/docs/ItemDTO.md +2 -2
  617. package/docs/ItemDiscountEntity.md +7 -7
  618. package/docs/ItemEntity.md +22 -22
  619. package/docs/ItemResolutionRequestModel.md +21 -0
  620. package/docs/LinkedOrderEntity.md +2 -2
  621. package/docs/MFARequiredModel.md +2 -2
  622. package/docs/MacAddressDTO.md +2 -2
  623. package/docs/MacAddressRequestModel.md +21 -0
  624. package/docs/MiscApi.md +63 -0
  625. package/docs/MonthlyUsageModel.md +2 -2
  626. package/docs/MultiTenantChangeResponseModel.md +4 -4
  627. package/docs/MultiTenantSipTrunkRequest.md +22 -0
  628. package/docs/MyPBXToolsApi.md +1 -1
  629. package/docs/NameRequestModel.md +21 -0
  630. package/docs/NavigationModel.md +4 -4
  631. package/docs/NoteRequestModel.md +21 -0
  632. package/docs/NumberPortDTO.md +18 -18
  633. package/docs/NumberPortNoteDTO.md +5 -5
  634. package/docs/NumberPortRangeDTO.md +7 -7
  635. package/docs/NumberPortRangeRequestDTO.md +4 -4
  636. package/docs/NumberPortingApi.md +73 -73
  637. package/docs/NumberPortsModel.md +4 -4
  638. package/docs/OAuth20Api.md +27 -27
  639. package/docs/OfflineInstancesEntity.md +5 -5
  640. package/docs/OpayoRedirectDTO.md +5 -5
  641. package/docs/OrderDTO.md +3 -3
  642. package/docs/OrderDetailsDTO.md +16 -16
  643. package/docs/OrderEntity.md +58 -58
  644. package/docs/OrderItemDTO.md +2 -2
  645. package/docs/OrderRequestModel.md +13 -13
  646. package/docs/OrderResponseDTO.md +3 -3
  647. package/docs/OrderSummariesModel.md +4 -4
  648. package/docs/OrderSummaryDTO.md +16 -16
  649. package/docs/OrderTotalModel.md +8 -8
  650. package/docs/OrderedItemEntity.md +14 -14
  651. package/docs/OrderedItemModel.md +14 -14
  652. package/docs/OrdersApi.md +1 -1
  653. package/docs/OutboundCli.md +70 -0
  654. package/docs/PartnerDTO.md +12 -12
  655. package/docs/PasswordSenderDTO.md +37 -0
  656. package/docs/PasswordSenderEntity.md +33 -0
  657. package/docs/PortalAccountModel.md +23 -23
  658. package/docs/PortalLoginModel.md +7 -7
  659. package/docs/PostAddBroadbandRequest.md +28 -0
  660. package/docs/PostAddCallTariffToCallTariffPlanRequest.md +34 -0
  661. package/docs/PostAddEthernetRequest.md +28 -0
  662. package/docs/PostAddRecurringChargeRequest.md +30 -0
  663. package/docs/PostAddServiceToServicePlanRequest.md +30 -0
  664. package/docs/PostAddSipTrunkDDIsRequest.md +30 -0
  665. package/docs/PostDisconnectDDIRequest.md +20 -0
  666. package/docs/PostGenerateReport200Response.md +36 -0
  667. package/docs/PostGetBaseServicesRequest.md +22 -0
  668. package/docs/PostGetPriceGroupsRequest.md +22 -0
  669. package/docs/PostGetServicePlansRequest.md +22 -0
  670. package/docs/PostGetSipTrunksBillingRequest.md +34 -0
  671. package/docs/PostUpdateConnectionRequest.md +22 -0
  672. package/docs/PostUpdateRecurringChargeRequest.md +30 -0
  673. package/docs/PriceGroup.md +30 -0
  674. package/docs/PriceGroupResponse.md +24 -0
  675. package/docs/PriceListItemModel.md +5 -5
  676. package/docs/PricingApi.md +1 -1
  677. package/docs/PrinterEntity.md +5 -5
  678. package/docs/PrizesEntity.md +6 -6
  679. package/docs/ProcessedCdr.md +96 -0
  680. package/docs/ProductDetailedSummaryDTO.md +2 -2
  681. package/docs/ProductPriceListItemModel.md +5 -5
  682. package/docs/ProductSearchResultsModel.md +1 -1
  683. package/docs/ProductSerialInfoDTO.md +27 -0
  684. package/docs/ProductSerialInfoModel.md +4 -4
  685. package/docs/ProductSummaryDTO.md +2 -2
  686. package/docs/ProductsApi.md +1 -1
  687. package/docs/PromoCodesEntity.md +12 -12
  688. package/docs/PromoItemsEntity.md +8 -8
  689. package/docs/ProspectDTO.md +10 -10
  690. package/docs/ProspectEntity.md +11 -11
  691. package/docs/ProspectsApi.md +1 -1
  692. package/docs/ProvisioningApi.md +1 -1
  693. package/docs/ProvisioningModel.md +3 -3
  694. package/docs/ProvisioningRequestEntity.md +3 -3
  695. package/docs/PutAddCallTariffToCallTariffPlanRequest.md +30 -0
  696. package/docs/PutAddServiceToServicePlanRequest.md +26 -0
  697. package/docs/PutConnectionSearchRequest.md +20 -0
  698. package/docs/PutGetBaseServicesRequest.md +28 -0
  699. package/docs/PutGetCallTariffPlanRequest.md +28 -0
  700. package/docs/PutGetPriceGroupsRequest.md +28 -0
  701. package/docs/RMAApi.md +1691 -0
  702. package/docs/ReasonRequestModel.md +21 -0
  703. package/docs/RecordingBackupAzureModel.md +5 -5
  704. package/docs/RecordingsBackupInfoDTO.md +2 -2
  705. package/docs/RecurringCharge.md +48 -0
  706. package/docs/RemoteStorageDTO.md +4 -4
  707. package/docs/ReportRequestDTO.md +37 -0
  708. package/docs/ReportsApi.md +107 -0
  709. package/docs/ResolutionRequestModel.md +21 -0
  710. package/docs/ResourceNotReadyException.md +3 -3
  711. package/docs/RmaCollectionDTO.md +27 -0
  712. package/docs/RmaCreditItemRequestDTO.md +25 -0
  713. package/docs/RmaDTO.md +45 -0
  714. package/docs/RmaItemDTO.md +35 -0
  715. package/docs/RmaItemRequestDTO.md +25 -0
  716. package/docs/RmaOrderDTO.md +29 -0
  717. package/docs/RmaOrderItemDTO.md +37 -0
  718. package/docs/RmaOrderSummaryDTO.md +25 -0
  719. package/docs/RmaReplacementOrderItemDTO.md +23 -0
  720. package/docs/RmaReplacementOrderRequestDTO.md +21 -0
  721. package/docs/RmaRequestDTO.md +34 -0
  722. package/docs/RmaReturnDTO.md +31 -0
  723. package/docs/RmaSummaryDTO.md +31 -0
  724. package/docs/RmaSummaryItemDTO.md +23 -0
  725. package/docs/RootAccessModel.md +3 -3
  726. package/docs/S3BucketEntity.md +4 -4
  727. package/docs/SIPTrunksApi.md +1 -1
  728. package/docs/SMSApi.md +1 -1
  729. package/docs/SbcDTO.md +8 -8
  730. package/docs/ScannedItemModel.md +5 -5
  731. package/docs/ScopeModel.md +2 -2
  732. package/docs/Sdr.md +66 -0
  733. package/docs/SdrReferenceType.md +24 -0
  734. package/docs/SerialNumberRequestModel.md +21 -0
  735. package/docs/SeriesDTO.md +27 -0
  736. package/docs/Service.md +42 -0
  737. package/docs/ServiceHealthDTO.md +2 -2
  738. package/docs/ServicePlan.md +36 -0
  739. package/docs/ServiceStatusDTO.md +4 -4
  740. package/docs/ServicesApi.md +1 -1
  741. package/docs/ShipmentAddressEntity.md +11 -11
  742. package/docs/ShipmentDTO.md +11 -11
  743. package/docs/ShipmentEntity.md +12 -12
  744. package/docs/ShipmentItemDTO.md +2 -2
  745. package/docs/ShipmentItemEntity.md +5 -5
  746. package/docs/ShipmentItemModel.md +5 -5
  747. package/docs/ShipmentModel.md +12 -12
  748. package/docs/ShipmentRequestDTO.md +6 -6
  749. package/docs/ShippingAddressDTO.md +8 -8
  750. package/docs/ShippingApi.md +1 -1
  751. package/docs/ShippingConsignmentModel.md +4 -4
  752. package/docs/ShippingInformationDTO.md +3 -3
  753. package/docs/ShippingRequestDTO.md +5 -5
  754. package/docs/ShippingServiceDTO.md +2 -2
  755. package/docs/ShippingServiceModel.md +6 -6
  756. package/docs/ShippingServicesModel.md +1 -1
  757. package/docs/SipTrunkChangeResponseModel.md +5 -5
  758. package/docs/SipTrunkCreationRequestModel.md +6 -6
  759. package/docs/SipTrunkEntity.md +12 -12
  760. package/docs/SipTrunksResponseModel.md +4 -4
  761. package/docs/SmsAccountDTO.md +6 -6
  762. package/docs/SmsAccountEntity.md +7 -7
  763. package/docs/SmsAccountRequestDTO.md +5 -5
  764. package/docs/SmsDataModel.md +1 -1
  765. package/docs/SmsMessageModel.md +3 -3
  766. package/docs/SmsNumbersEntity.md +2 -2
  767. package/docs/SmsPayloadModel.md +3 -3
  768. package/docs/SmsPhoneNumberModel.md +2 -2
  769. package/docs/SmsResponseModel.md +3 -3
  770. package/docs/SmsWhitelistEntity.md +2 -2
  771. package/docs/SpecialService.md +40 -0
  772. package/docs/StockManagementApi.md +1 -1
  773. package/docs/StockOrderCourierEntity.md +4 -4
  774. package/docs/StockOrderDeductionModel.md +4 -4
  775. package/docs/StockOrderDeductionRequestModel.md +2 -2
  776. package/docs/StockOrderDeductionsEntity.md +4 -4
  777. package/docs/StockOrderEntity.md +22 -22
  778. package/docs/StockOrderItemEntity.md +7 -7
  779. package/docs/StockOrderItemModel.md +7 -7
  780. package/docs/StockOrderItemRequestModel.md +4 -4
  781. package/docs/StockOrderModel.md +15 -15
  782. package/docs/StockOrderProductEntity.md +6 -6
  783. package/docs/StockOrderRequestModel.md +3 -3
  784. package/docs/StockOrderSupplierEntity.md +9 -9
  785. package/docs/StockOrderSupplierModel.md +9 -9
  786. package/docs/StockOrdersModel.md +4 -4
  787. package/docs/StockProductModel.md +6 -6
  788. package/docs/StockProductPriceModel.md +2 -2
  789. package/docs/StockProductSummariesModel.md +4 -4
  790. package/docs/StockProductSummaryModel.md +6 -6
  791. package/docs/StockReportItemModel.md +31 -0
  792. package/docs/StockReportModel.md +29 -0
  793. package/docs/StockTransactionsEntity.md +8 -8
  794. package/docs/SupplierEntity.md +9 -9
  795. package/docs/SupplierItemEntity.md +8 -8
  796. package/docs/SupplierItemModel.md +10 -8
  797. package/docs/SupplierItemsResultsDTO.md +21 -0
  798. package/docs/SupplierModel.md +9 -9
  799. package/docs/SupplierProductModel.md +25 -0
  800. package/docs/SupplierProductResultsModel.md +27 -0
  801. package/docs/SuppliersApi.md +230 -0
  802. package/docs/SupportTicketModel.md +11 -11
  803. package/docs/SystemApi.md +1 -1
  804. package/docs/TableDTO.md +25 -0
  805. package/docs/TableDataDTO.md +21 -0
  806. package/docs/TableHistoryEntity.md +8 -8
  807. package/docs/TableRowDTO.md +21 -0
  808. package/docs/TariffRate.md +30 -0
  809. package/docs/TcxBackupEntity.md +9 -9
  810. package/docs/TcxBackupModel.md +9 -9
  811. package/docs/TcxBillingEntity.md +10 -10
  812. package/docs/TcxBulkLicenceDetailsModel.md +2 -2
  813. package/docs/TcxDeadLicenceEntity.md +3 -3
  814. package/docs/TcxExtsEntity.md +8 -8
  815. package/docs/TcxInstallationModel.md +33 -31
  816. package/docs/TcxInstallationsModel.md +4 -4
  817. package/docs/TcxKeySummaryDTO.md +5 -5
  818. package/docs/TcxKeysEntity.md +6 -6
  819. package/docs/TcxLicenceDetailsErrorModel.md +4 -4
  820. package/docs/TcxLicenceDetailsModel.md +11 -11
  821. package/docs/TcxMacsEntity.md +3 -3
  822. package/docs/TcxMultiTenantModel.md +14 -14
  823. package/docs/TcxMultiTenantUserModel.md +3 -3
  824. package/docs/TcxMultiTenantsModel.md +4 -4
  825. package/docs/TcxNumbersEntity.md +3 -3
  826. package/docs/TcxOfficeHoursEntity.md +15 -15
  827. package/docs/TcxPhoneModel.md +6 -6
  828. package/docs/TcxPhonesEntity.md +6 -6
  829. package/docs/TcxRemoteStorageModel.md +4 -4
  830. package/docs/TcxSbcDTO.md +8 -8
  831. package/docs/TcxSbcEntity.md +16 -16
  832. package/docs/TcxSbcModel.md +16 -16
  833. package/docs/TcxSbcResponseDTO.md +2 -2
  834. package/docs/TcxSetupEntity.md +26 -26
  835. package/docs/TcxSetupsModel.md +4 -4
  836. package/docs/TcxSipTrunksEntity.md +13 -13
  837. package/docs/TcxTemplateXmlEnum.md +2 -2
  838. package/docs/TcxUsersEntity.md +6 -6
  839. package/docs/TcxWizardConfigModel.md +2 -2
  840. package/docs/TcxWizardModel.md +14 -14
  841. package/docs/TechSupportCompanySummaryDTO.md +5 -5
  842. package/docs/TicketSummaryModel.md +7 -7
  843. package/docs/TicketTimeDTO.md +9 -9
  844. package/docs/TicketsApi.md +11 -11
  845. package/docs/TokenResponseModel.md +3 -3
  846. package/docs/UnconnectedSdr.md +68 -0
  847. package/docs/UpgradeOrderResponseModel.md +2 -2
  848. package/docs/UpgradeRequestModel.md +4 -4
  849. package/docs/UserEntity.md +12 -12
  850. package/docs/WebhooksApi.md +1 -1
  851. package/docs/XeroLogEntity.md +10 -10
  852. package/getEnums.php +31 -31
  853. package/index.ts +1 -1
  854. package/models/ConnectionTypeEnum.ts +64 -0
  855. package/models/GraphTypeEnum.ts +14 -0
  856. package/models/HostingPriceListEnum.ts +5 -0
  857. package/models/ReasonEnum.ts +24 -0
  858. package/models/ReportEnum.ts +69 -0
  859. package/models/ResolutionEnum.ts +19 -0
  860. package/models/RmaItemCreditTypeEnum.ts +14 -0
  861. package/models/RmaItemResolutionEnum.ts +29 -0
  862. package/models/RmaItemStatusEnum.ts +19 -0
  863. package/models/RmaStatusEnum.ts +29 -0
  864. package/openapitools.json +1 -1
  865. package/package.json +2 -2
@@ -1,16 +1,3280 @@
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
  |------------- | ------------- | -------------|
7
+ |[**deleteAddCallTariffToCallTariffPlan**](#deleteaddcalltarifftocalltariffplan) | **DELETE** /billing/admin/callTariffPlan/callTariff | |
8
+ |[**deleteAddRecurringCharge**](#deleteaddrecurringcharge) | **DELETE** /billing/customer/recurringCharges | |
9
+ |[**deleteAddServiceToServicePlan**](#deleteaddservicetoserviceplan) | **DELETE** /billing/admin/servicePlan/service | |
10
+ |[**deleteCloseAccount**](#deletecloseaccount) | **DELETE** /billing/customer/customer | |
11
+ |[**deleteGetBaseServices**](#deletegetbaseservices) | **DELETE** /billing/admin/baseServices | |
12
+ |[**deleteGetCallTariffPlan**](#deletegetcalltariffplan) | **DELETE** /billing/admin/callTariffPlan | |
13
+ |[**deleteGetPriceGroups**](#deletegetpricegroups) | **DELETE** /billing/admin/priceGroups | |
14
+ |[**deleteGetServicePlan**](#deletegetserviceplan) | **DELETE** /billing/admin/servicePlan | |
15
+ |[**getAddRecurringCharge**](#getaddrecurringcharge) | **GET** /billing/customer/recurringCharges | |
16
+ |[**getAddServiceToServicePlan**](#getaddservicetoserviceplan) | **GET** /billing/admin/servicePlan/service | |
17
+ |[**getAddSipTrunkDDIs**](#getaddsiptrunkddis) | **GET** /billing/customer/sipTrunkDDIs | |
18
+ |[**getConnectionSearch**](#getconnectionsearch) | **GET** /billing/admin/connections | |
7
19
  |[**getGetAllCustomer**](#getgetallcustomer) | **GET** /billing/admin/customerList | Get Billing Customers|
8
- |[**putTransferConnection**](#puttransferconnection) | **PUT** /billing/admin/connections | |
20
+ |[**getGetAllMtSipTrunks**](#getgetallmtsiptrunks) | **GET** /billing/customer/list/allMtSipTrunks | |
21
+ |[**getGetAllSipTrunks**](#getgetallsiptrunks) | **GET** /billing/customer/list/allSipTrunks | |
22
+ |[**getGetBaseServices**](#getgetbaseservices) | **GET** /billing/admin/baseServices | |
23
+ |[**getGetBillingCustomerDetails**](#getgetbillingcustomerdetails) | **GET** /billing/customer/details | |
24
+ |[**getGetBundleCallsWithCost**](#getgetbundlecallswithcost) | **GET** /billing/admin/bundleCallsWithCost | |
25
+ |[**getGetCallTariffPlan**](#getgetcalltariffplan) | **GET** /billing/admin/callTariffPlan | |
26
+ |[**getGetCallTariffs**](#getgetcalltariffs) | **GET** /billing/admin/callTariffs | |
27
+ |[**getGetCallTariffsDetails**](#getgetcalltariffsdetails) | **GET** /billing/admin/callTariffs/details | |
28
+ |[**getGetChildren**](#getgetchildren) | **GET** /billing/customer/children | |
29
+ |[**getGetConnection**](#getgetconnection) | **GET** /billing/customer/connections/{id} | |
30
+ |[**getGetConnections**](#getgetconnections) | **GET** /billing/customer/connections | |
31
+ |[**getGetCustomer**](#getgetcustomer) | **GET** /billing/admin/customer | |
32
+ |[**getGetInboundTariffs**](#getgetinboundtariffs) | **GET** /billing/admin/inboundTariffs | |
33
+ |[**getGetInboundTariffsDetails**](#getgetinboundtariffsdetails) | **GET** /billing/admin/inboundTariffs/details | |
34
+ |[**getGetPriceGroups**](#getgetpricegroups) | **GET** /billing/admin/priceGroups | |
35
+ |[**getGetServicePlan**](#getgetserviceplan) | **GET** /billing/admin/servicePlan | |
36
+ |[**getGetServicePlans**](#getgetserviceplans) | **GET** /billing/admin/servicePlans | |
37
+ |[**getGetServicesPlanDetails**](#getgetservicesplandetails) | **GET** /billing/admin/servicePlans/details | |
38
+ |[**getGetSipTrunkList**](#getgetsiptrunklist) | **GET** /billing/customer/list/sipTrunks | |
39
+ |[**getGetSipTrunksBilling**](#getgetsiptrunksbilling) | **GET** /billing/customer/sipTrunks | |
40
+ |[**getGetUnconnectedCalls**](#getgetunconnectedcalls) | **GET** /billing/admin/unconnectedCalls | |
41
+ |[**getGetUnconnectedServices**](#getgetunconnectedservices) | **GET** /billing/admin/unconnectedServices | |
42
+ |[**getIsBundleCustomer**](#getisbundlecustomer) | **GET** /billing/customer/bundleCustomer | |
43
+ |[**postAddBroadband**](#postaddbroadband) | **POST** /billing/customer/broadband | |
44
+ |[**postAddCallTariffToCallTariffPlan**](#postaddcalltarifftocalltariffplan) | **POST** /billing/admin/callTariffPlan/callTariff | |
45
+ |[**postAddChildCustomer**](#postaddchildcustomer) | **POST** /billing/customer/child | |
46
+ |[**postAddEthernet**](#postaddethernet) | **POST** /billing/customer/ethernet | |
47
+ |[**postAddRecurringCharge**](#postaddrecurringcharge) | **POST** /billing/customer/recurringCharges | |
48
+ |[**postAddServiceToServicePlan**](#postaddservicetoserviceplan) | **POST** /billing/admin/servicePlan/service | |
49
+ |[**postAddSipTrunkDDIs**](#postaddsiptrunkddis) | **POST** /billing/customer/sipTrunkDDIs | |
50
+ |[**postDisconnectConnection**](#postdisconnectconnection) | **POST** /billing/customer/disconnectConnection | |
51
+ |[**postDisconnectDDI**](#postdisconnectddi) | **POST** /billing/customer/disconnectDDI | |
52
+ |[**postGetBaseServices**](#postgetbaseservices) | **POST** /billing/admin/baseServices | |
53
+ |[**postGetCallTariffPlan**](#postgetcalltariffplan) | **POST** /billing/admin/callTariffPlan | |
54
+ |[**postGetConnections**](#postgetconnections) | **POST** /billing/customer/connections | |
55
+ |[**postGetPriceGroups**](#postgetpricegroups) | **POST** /billing/admin/priceGroups | |
56
+ |[**postGetServicePlans**](#postgetserviceplans) | **POST** /billing/admin/servicePlans | |
57
+ |[**postGetSipTrunksBilling**](#postgetsiptrunksbilling) | **POST** /billing/customer/sipTrunks | |
58
+ |[**postSendInvoices**](#postsendinvoices) | **POST** /billing/admin/sendInvoices | |
59
+ |[**postUpdateConnection**](#postupdateconnection) | **POST** /billing/customer/updateConnection | |
60
+ |[**postUpdateRecurringCharge**](#postupdaterecurringcharge) | **POST** /billing/customer/updateRecurringCharges | |
61
+ |[**putAddCallTariffToCallTariffPlan**](#putaddcalltarifftocalltariffplan) | **PUT** /billing/admin/callTariffPlan/callTariff | |
62
+ |[**putAddServiceToServicePlan**](#putaddservicetoserviceplan) | **PUT** /billing/admin/servicePlan/service | |
63
+ |[**putConnectionSearch**](#putconnectionsearch) | **PUT** /billing/admin/connections | |
64
+ |[**putConvertChildToParent**](#putconvertchildtoparent) | **PUT** /billing/customer/makeParent | |
65
+ |[**putDisableBundles**](#putdisablebundles) | **PUT** /billing/customer/disableBundles | |
66
+ |[**putDisableDdiBilling**](#putdisableddibilling) | **PUT** /billing/customer/disableDdiBilling | |
67
+ |[**putEnableBundles**](#putenablebundles) | **PUT** /billing/customer/enableBundles | |
68
+ |[**putEnableDdiBilling**](#putenableddibilling) | **PUT** /billing/customer/enableDdiBilling | |
69
+ |[**putGetBaseServices**](#putgetbaseservices) | **PUT** /billing/admin/baseServices | |
70
+ |[**putGetCallTariffPlan**](#putgetcalltariffplan) | **PUT** /billing/admin/callTariffPlan | |
71
+ |[**putGetConnections**](#putgetconnections) | **PUT** /billing/customer/connections | |
72
+ |[**putGetPriceGroups**](#putgetpricegroups) | **PUT** /billing/admin/priceGroups | |
73
+
74
+ # **deleteAddCallTariffToCallTariffPlan**
75
+ > boolean deleteAddCallTariffToCallTariffPlan()
76
+
77
+ Delete Call Tariff
78
+
79
+ ### Example
80
+
81
+ ```typescript
82
+ import {
83
+ BillingApi,
84
+ Configuration
85
+ } from 'yellowgrid-api-ts';
86
+
87
+ const configuration = new Configuration();
88
+ const apiInstance = new BillingApi(configuration);
89
+
90
+ let priceGroupName: string; //Price Group Name (default to undefined)
91
+
92
+ const { status, data } = await apiInstance.deleteAddCallTariffToCallTariffPlan(
93
+ priceGroupName
94
+ );
95
+ ```
96
+
97
+ ### Parameters
98
+
99
+ |Name | Type | Description | Notes|
100
+ |------------- | ------------- | ------------- | -------------|
101
+ | **priceGroupName** | [**string**] | Price Group Name | defaults to undefined|
102
+
103
+
104
+ ### Return type
105
+
106
+ **boolean**
107
+
108
+ ### Authorization
109
+
110
+ No authorization required
111
+
112
+ ### HTTP request headers
113
+
114
+ - **Content-Type**: Not defined
115
+ - **Accept**: application/json
116
+
117
+
118
+ ### HTTP response details
119
+ | Status code | Description | Response headers |
120
+ |-------------|-------------|------------------|
121
+ |**200** | Successful | - |
122
+ |**400** | Bad Request | - |
123
+ |**401** | Unauthorised | - |
124
+ |**403** | Access Denied | - |
125
+
126
+ [[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)
127
+
128
+ # **deleteAddRecurringCharge**
129
+ > number deleteAddRecurringCharge()
130
+
131
+ Delete Recurring Charges
132
+
133
+ ### Example
134
+
135
+ ```typescript
136
+ import {
137
+ BillingApi,
138
+ Configuration
139
+ } from 'yellowgrid-api-ts';
140
+
141
+ const configuration = new Configuration();
142
+ const apiInstance = new BillingApi(configuration);
143
+
144
+ let id: number; //Recurring Charge ID (default to undefined)
145
+ let billCustomerId: number; //Customer ID (optional) (default to undefined)
146
+
147
+ const { status, data } = await apiInstance.deleteAddRecurringCharge(
148
+ id,
149
+ billCustomerId
150
+ );
151
+ ```
152
+
153
+ ### Parameters
154
+
155
+ |Name | Type | Description | Notes|
156
+ |------------- | ------------- | ------------- | -------------|
157
+ | **id** | [**number**] | Recurring Charge ID | defaults to undefined|
158
+ | **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
159
+
160
+
161
+ ### Return type
162
+
163
+ **number**
164
+
165
+ ### Authorization
166
+
167
+ No authorization required
168
+
169
+ ### HTTP request headers
170
+
171
+ - **Content-Type**: Not defined
172
+ - **Accept**: application/json
173
+
174
+
175
+ ### HTTP response details
176
+ | Status code | Description | Response headers |
177
+ |-------------|-------------|------------------|
178
+ |**200** | Recurring Charge ID | - |
179
+ |**400** | Bad Request | - |
180
+ |**401** | Unauthorised | - |
181
+ |**403** | Access Denied | - |
182
+
183
+ [[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)
184
+
185
+ # **deleteAddServiceToServicePlan**
186
+ > boolean deleteAddServiceToServicePlan()
187
+
188
+ Delete Service
189
+
190
+ ### Example
191
+
192
+ ```typescript
193
+ import {
194
+ BillingApi,
195
+ Configuration
196
+ } from 'yellowgrid-api-ts';
197
+
198
+ const configuration = new Configuration();
199
+ const apiInstance = new BillingApi(configuration);
200
+
201
+ let planGroup: string; //Plan Group (default to undefined)
202
+ let serviceCode: string; //Service Code (default to undefined)
203
+
204
+ const { status, data } = await apiInstance.deleteAddServiceToServicePlan(
205
+ planGroup,
206
+ serviceCode
207
+ );
208
+ ```
209
+
210
+ ### Parameters
211
+
212
+ |Name | Type | Description | Notes|
213
+ |------------- | ------------- | ------------- | -------------|
214
+ | **planGroup** | [**string**] | Plan Group | defaults to undefined|
215
+ | **serviceCode** | [**string**] | Service Code | defaults to undefined|
216
+
217
+
218
+ ### Return type
219
+
220
+ **boolean**
221
+
222
+ ### Authorization
223
+
224
+ No authorization required
225
+
226
+ ### HTTP request headers
227
+
228
+ - **Content-Type**: Not defined
229
+ - **Accept**: application/json
230
+
231
+
232
+ ### HTTP response details
233
+ | Status code | Description | Response headers |
234
+ |-------------|-------------|------------------|
235
+ |**200** | Successful | - |
236
+ |**400** | Bad Request | - |
237
+ |**401** | Unauthorised | - |
238
+ |**403** | Access Denied | - |
239
+
240
+ [[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)
241
+
242
+ # **deleteCloseAccount**
243
+ > number deleteCloseAccount()
244
+
245
+ Delete Customer
246
+
247
+ ### Example
248
+
249
+ ```typescript
250
+ import {
251
+ BillingApi,
252
+ Configuration
253
+ } from 'yellowgrid-api-ts';
254
+
255
+ const configuration = new Configuration();
256
+ const apiInstance = new BillingApi(configuration);
257
+
258
+ let billCustomerId: number; //Customer ID (optional) (default to undefined)
259
+
260
+ const { status, data } = await apiInstance.deleteCloseAccount(
261
+ billCustomerId
262
+ );
263
+ ```
264
+
265
+ ### Parameters
266
+
267
+ |Name | Type | Description | Notes|
268
+ |------------- | ------------- | ------------- | -------------|
269
+ | **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
270
+
271
+
272
+ ### Return type
273
+
274
+ **number**
275
+
276
+ ### Authorization
277
+
278
+ No authorization required
279
+
280
+ ### HTTP request headers
281
+
282
+ - **Content-Type**: Not defined
283
+ - **Accept**: application/json
284
+
285
+
286
+ ### HTTP response details
287
+ | Status code | Description | Response headers |
288
+ |-------------|-------------|------------------|
289
+ |**200** | Customer ID | - |
290
+ |**400** | Bad Request | - |
291
+ |**401** | Unauthorised | - |
292
+ |**403** | Access Denied | - |
293
+
294
+ [[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)
295
+
296
+ # **deleteGetBaseServices**
297
+ > boolean deleteGetBaseServices()
298
+
299
+ Delete Base Service
300
+
301
+ ### Example
302
+
303
+ ```typescript
304
+ import {
305
+ BillingApi,
306
+ Configuration
307
+ } from 'yellowgrid-api-ts';
308
+
309
+ const configuration = new Configuration();
310
+ const apiInstance = new BillingApi(configuration);
311
+
312
+ let baseServiceId: number; //Base Service Plan ID (default to undefined)
313
+
314
+ const { status, data } = await apiInstance.deleteGetBaseServices(
315
+ baseServiceId
316
+ );
317
+ ```
318
+
319
+ ### Parameters
320
+
321
+ |Name | Type | Description | Notes|
322
+ |------------- | ------------- | ------------- | -------------|
323
+ | **baseServiceId** | [**number**] | Base Service Plan ID | defaults to undefined|
324
+
325
+
326
+ ### Return type
327
+
328
+ **boolean**
329
+
330
+ ### Authorization
331
+
332
+ No authorization required
333
+
334
+ ### HTTP request headers
335
+
336
+ - **Content-Type**: Not defined
337
+ - **Accept**: application/json
338
+
339
+
340
+ ### HTTP response details
341
+ | Status code | Description | Response headers |
342
+ |-------------|-------------|------------------|
343
+ |**200** | Successful | - |
344
+ |**400** | Bad Request | - |
345
+ |**401** | Unauthorised | - |
346
+ |**403** | Access Denied | - |
347
+
348
+ [[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)
349
+
350
+ # **deleteGetCallTariffPlan**
351
+ > boolean deleteGetCallTariffPlan()
352
+
353
+ Delete Call Tariff Plan
354
+
355
+ ### Example
356
+
357
+ ```typescript
358
+ import {
359
+ BillingApi,
360
+ Configuration
361
+ } from 'yellowgrid-api-ts';
362
+
363
+ const configuration = new Configuration();
364
+ const apiInstance = new BillingApi(configuration);
365
+
366
+ let callTariffPlanId: number; //Call Tariff Plan ID (default to undefined)
367
+
368
+ const { status, data } = await apiInstance.deleteGetCallTariffPlan(
369
+ callTariffPlanId
370
+ );
371
+ ```
372
+
373
+ ### Parameters
374
+
375
+ |Name | Type | Description | Notes|
376
+ |------------- | ------------- | ------------- | -------------|
377
+ | **callTariffPlanId** | [**number**] | Call Tariff Plan ID | defaults to undefined|
378
+
379
+
380
+ ### Return type
381
+
382
+ **boolean**
383
+
384
+ ### Authorization
385
+
386
+ No authorization required
387
+
388
+ ### HTTP request headers
389
+
390
+ - **Content-Type**: Not defined
391
+ - **Accept**: application/json
392
+
393
+
394
+ ### HTTP response details
395
+ | Status code | Description | Response headers |
396
+ |-------------|-------------|------------------|
397
+ |**200** | Successful | - |
398
+ |**400** | Bad Request | - |
399
+ |**401** | Unauthorised | - |
400
+ |**403** | Access Denied | - |
401
+
402
+ [[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)
403
+
404
+ # **deleteGetPriceGroups**
405
+ > boolean deleteGetPriceGroups()
406
+
407
+ Delete Price Group
408
+
409
+ ### Example
410
+
411
+ ```typescript
412
+ import {
413
+ BillingApi,
414
+ Configuration
415
+ } from 'yellowgrid-api-ts';
416
+
417
+ const configuration = new Configuration();
418
+ const apiInstance = new BillingApi(configuration);
419
+
420
+ let priceGroupId: number; //Price Group ID (default to undefined)
421
+
422
+ const { status, data } = await apiInstance.deleteGetPriceGroups(
423
+ priceGroupId
424
+ );
425
+ ```
426
+
427
+ ### Parameters
428
+
429
+ |Name | Type | Description | Notes|
430
+ |------------- | ------------- | ------------- | -------------|
431
+ | **priceGroupId** | [**number**] | Price Group ID | defaults to undefined|
432
+
433
+
434
+ ### Return type
435
+
436
+ **boolean**
437
+
438
+ ### Authorization
439
+
440
+ No authorization required
441
+
442
+ ### HTTP request headers
443
+
444
+ - **Content-Type**: Not defined
445
+ - **Accept**: application/json
446
+
447
+
448
+ ### HTTP response details
449
+ | Status code | Description | Response headers |
450
+ |-------------|-------------|------------------|
451
+ |**200** | Successful | - |
452
+ |**400** | Bad Request | - |
453
+ |**401** | Unauthorised | - |
454
+ |**403** | Access Denied | - |
455
+
456
+ [[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)
457
+
458
+ # **deleteGetServicePlan**
459
+ > number deleteGetServicePlan()
460
+
461
+ Delete Service Plan
462
+
463
+ ### Example
464
+
465
+ ```typescript
466
+ import {
467
+ BillingApi,
468
+ Configuration
469
+ } from 'yellowgrid-api-ts';
470
+
471
+ const configuration = new Configuration();
472
+ const apiInstance = new BillingApi(configuration);
473
+
474
+ let servicePlanId: number; //Service Plan ID (default to undefined)
475
+
476
+ const { status, data } = await apiInstance.deleteGetServicePlan(
477
+ servicePlanId
478
+ );
479
+ ```
480
+
481
+ ### Parameters
482
+
483
+ |Name | Type | Description | Notes|
484
+ |------------- | ------------- | ------------- | -------------|
485
+ | **servicePlanId** | [**number**] | Service Plan ID | defaults to undefined|
486
+
487
+
488
+ ### Return type
489
+
490
+ **number**
491
+
492
+ ### Authorization
493
+
494
+ No authorization required
495
+
496
+ ### HTTP request headers
497
+
498
+ - **Content-Type**: Not defined
499
+ - **Accept**: application/json
500
+
501
+
502
+ ### HTTP response details
503
+ | Status code | Description | Response headers |
504
+ |-------------|-------------|------------------|
505
+ |**200** | Service Plan ID | - |
506
+ |**400** | Bad Request | - |
507
+ |**401** | Unauthorised | - |
508
+ |**403** | Access Denied | - |
509
+
510
+ [[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)
511
+
512
+ # **getAddRecurringCharge**
513
+ > Array<RecurringCharge> getAddRecurringCharge()
514
+
515
+ Get Recurring Charges
516
+
517
+ ### Example
518
+
519
+ ```typescript
520
+ import {
521
+ BillingApi,
522
+ Configuration
523
+ } from 'yellowgrid-api-ts';
524
+
525
+ const configuration = new Configuration();
526
+ const apiInstance = new BillingApi(configuration);
527
+
528
+ let billCustomerId: number; //Customer ID (optional) (default to undefined)
529
+
530
+ const { status, data } = await apiInstance.getAddRecurringCharge(
531
+ billCustomerId
532
+ );
533
+ ```
534
+
535
+ ### Parameters
536
+
537
+ |Name | Type | Description | Notes|
538
+ |------------- | ------------- | ------------- | -------------|
539
+ | **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
540
+
541
+
542
+ ### Return type
543
+
544
+ **Array<RecurringCharge>**
545
+
546
+ ### Authorization
547
+
548
+ No authorization required
549
+
550
+ ### HTTP request headers
551
+
552
+ - **Content-Type**: Not defined
553
+ - **Accept**: application/json
554
+
555
+
556
+ ### HTTP response details
557
+ | Status code | Description | Response headers |
558
+ |-------------|-------------|------------------|
559
+ |**200** | Recurring Charge | - |
560
+ |**400** | Bad Request | - |
561
+ |**401** | Unauthorised | - |
562
+ |**403** | Access Denied | - |
563
+
564
+ [[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)
565
+
566
+ # **getAddServiceToServicePlan**
567
+ > Service getAddServiceToServicePlan()
568
+
569
+ Get Service
570
+
571
+ ### Example
572
+
573
+ ```typescript
574
+ import {
575
+ BillingApi,
576
+ Configuration
577
+ } from 'yellowgrid-api-ts';
578
+
579
+ const configuration = new Configuration();
580
+ const apiInstance = new BillingApi(configuration);
581
+
582
+ let id: number; //Service ID (default to undefined)
583
+
584
+ const { status, data } = await apiInstance.getAddServiceToServicePlan(
585
+ id
586
+ );
587
+ ```
588
+
589
+ ### Parameters
590
+
591
+ |Name | Type | Description | Notes|
592
+ |------------- | ------------- | ------------- | -------------|
593
+ | **id** | [**number**] | Service ID | defaults to undefined|
594
+
595
+
596
+ ### Return type
597
+
598
+ **Service**
599
+
600
+ ### Authorization
601
+
602
+ No authorization required
603
+
604
+ ### HTTP request headers
605
+
606
+ - **Content-Type**: Not defined
607
+ - **Accept**: application/json
608
+
609
+
610
+ ### HTTP response details
611
+ | Status code | Description | Response headers |
612
+ |-------------|-------------|------------------|
613
+ |**200** | Service | - |
614
+ |**400** | Bad Request | - |
615
+ |**401** | Unauthorised | - |
616
+ |**403** | Access Denied | - |
617
+
618
+ [[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)
619
+
620
+ # **getAddSipTrunkDDIs**
621
+ > Array<OutboundCli> getAddSipTrunkDDIs()
622
+
623
+ Get SIP Trunk DDIs
624
+
625
+ ### Example
626
+
627
+ ```typescript
628
+ import {
629
+ BillingApi,
630
+ Configuration
631
+ } from 'yellowgrid-api-ts';
632
+
633
+ const configuration = new Configuration();
634
+ const apiInstance = new BillingApi(configuration);
635
+
636
+ let connectionId: number; //Connection ID (optional) (default to undefined)
637
+ let billCustomerId: number; //Customer ID (optional) (default to undefined)
638
+
639
+ const { status, data } = await apiInstance.getAddSipTrunkDDIs(
640
+ connectionId,
641
+ billCustomerId
642
+ );
643
+ ```
644
+
645
+ ### Parameters
646
+
647
+ |Name | Type | Description | Notes|
648
+ |------------- | ------------- | ------------- | -------------|
649
+ | **connectionId** | [**number**] | Connection ID | (optional) defaults to undefined|
650
+ | **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
651
+
652
+
653
+ ### Return type
654
+
655
+ **Array<OutboundCli>**
656
+
657
+ ### Authorization
658
+
659
+ No authorization required
660
+
661
+ ### HTTP request headers
662
+
663
+ - **Content-Type**: Not defined
664
+ - **Accept**: application/json
665
+
666
+
667
+ ### HTTP response details
668
+ | Status code | Description | Response headers |
669
+ |-------------|-------------|------------------|
670
+ |**200** | Connection | - |
671
+ |**400** | Bad Request | - |
672
+ |**401** | Unauthorised | - |
673
+ |**403** | Access Denied | - |
674
+
675
+ [[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)
676
+
677
+ # **getConnectionSearch**
678
+ > Array<OutboundCli> getConnectionSearch()
679
+
680
+ Connection Search
681
+
682
+ ### Example
683
+
684
+ ```typescript
685
+ import {
686
+ BillingApi,
687
+ Configuration
688
+ } from 'yellowgrid-api-ts';
689
+
690
+ const configuration = new Configuration();
691
+ const apiInstance = new BillingApi(configuration);
692
+
693
+ let search: string; //Search (default to undefined)
694
+
695
+ const { status, data } = await apiInstance.getConnectionSearch(
696
+ search
697
+ );
698
+ ```
699
+
700
+ ### Parameters
701
+
702
+ |Name | Type | Description | Notes|
703
+ |------------- | ------------- | ------------- | -------------|
704
+ | **search** | [**string**] | Search | defaults to undefined|
705
+
706
+
707
+ ### Return type
708
+
709
+ **Array<OutboundCli>**
710
+
711
+ ### Authorization
712
+
713
+ No authorization required
714
+
715
+ ### HTTP request headers
716
+
717
+ - **Content-Type**: Not defined
718
+ - **Accept**: application/json
719
+
720
+
721
+ ### HTTP response details
722
+ | Status code | Description | Response headers |
723
+ |-------------|-------------|------------------|
724
+ |**200** | Connection | - |
725
+ |**400** | Bad Request | - |
726
+ |**401** | Unauthorised | - |
727
+ |**403** | Access Denied | - |
728
+
729
+ [[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)
9
730
 
10
731
  # **getGetAllCustomer**
11
732
  > { [key: string]: { [key: string]: string; }; } getGetAllCustomer()
12
733
 
13
- Get Billing Customers
734
+ Get Billing Customers
735
+
736
+ ### Example
737
+
738
+ ```typescript
739
+ import {
740
+ BillingApi,
741
+ Configuration
742
+ } from 'yellowgrid-api-ts';
743
+
744
+ const configuration = new Configuration();
745
+ const apiInstance = new BillingApi(configuration);
746
+
747
+ const { status, data } = await apiInstance.getGetAllCustomer();
748
+ ```
749
+
750
+ ### Parameters
751
+ This endpoint does not have any parameters.
752
+
753
+
754
+ ### Return type
755
+
756
+ **{ [key: string]: { [key: string]: string; }; }**
757
+
758
+ ### Authorization
759
+
760
+ No authorization required
761
+
762
+ ### HTTP request headers
763
+
764
+ - **Content-Type**: Not defined
765
+ - **Accept**: application/json
766
+
767
+
768
+ ### HTTP response details
769
+ | Status code | Description | Response headers |
770
+ |-------------|-------------|------------------|
771
+ |**200** | Billing Customer List | - |
772
+ |**400** | Bad Request | - |
773
+ |**401** | Unauthorised | - |
774
+ |**403** | Access Denied | - |
775
+
776
+ [[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)
777
+
778
+ # **getGetAllMtSipTrunks**
779
+ > Array<Array<string>> getGetAllMtSipTrunks()
780
+
781
+ Get All MT SIP Trunks
782
+
783
+ ### Example
784
+
785
+ ```typescript
786
+ import {
787
+ BillingApi,
788
+ Configuration
789
+ } from 'yellowgrid-api-ts';
790
+
791
+ const configuration = new Configuration();
792
+ const apiInstance = new BillingApi(configuration);
793
+
794
+ let billCustomerId: number; //Customer ID (optional) (default to undefined)
795
+
796
+ const { status, data } = await apiInstance.getGetAllMtSipTrunks(
797
+ billCustomerId
798
+ );
799
+ ```
800
+
801
+ ### Parameters
802
+
803
+ |Name | Type | Description | Notes|
804
+ |------------- | ------------- | ------------- | -------------|
805
+ | **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
806
+
807
+
808
+ ### Return type
809
+
810
+ **Array<Array<string>>**
811
+
812
+ ### Authorization
813
+
814
+ No authorization required
815
+
816
+ ### HTTP request headers
817
+
818
+ - **Content-Type**: Not defined
819
+ - **Accept**: application/json
820
+
821
+
822
+ ### HTTP response details
823
+ | Status code | Description | Response headers |
824
+ |-------------|-------------|------------------|
825
+ |**200** | List Of MT Trunks | - |
826
+ |**400** | Bad Request | - |
827
+ |**401** | Unauthorised | - |
828
+ |**403** | Access Denied | - |
829
+
830
+ [[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)
831
+
832
+ # **getGetAllSipTrunks**
833
+ > Array<Array<string>> getGetAllSipTrunks()
834
+
835
+ Get All SIP Trunks
836
+
837
+ ### Example
838
+
839
+ ```typescript
840
+ import {
841
+ BillingApi,
842
+ Configuration
843
+ } from 'yellowgrid-api-ts';
844
+
845
+ const configuration = new Configuration();
846
+ const apiInstance = new BillingApi(configuration);
847
+
848
+ let billCustomerId: number; //Customer ID (optional) (default to undefined)
849
+
850
+ const { status, data } = await apiInstance.getGetAllSipTrunks(
851
+ billCustomerId
852
+ );
853
+ ```
854
+
855
+ ### Parameters
856
+
857
+ |Name | Type | Description | Notes|
858
+ |------------- | ------------- | ------------- | -------------|
859
+ | **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
860
+
861
+
862
+ ### Return type
863
+
864
+ **Array<Array<string>>**
865
+
866
+ ### Authorization
867
+
868
+ No authorization required
869
+
870
+ ### HTTP request headers
871
+
872
+ - **Content-Type**: Not defined
873
+ - **Accept**: application/json
874
+
875
+
876
+ ### HTTP response details
877
+ | Status code | Description | Response headers |
878
+ |-------------|-------------|------------------|
879
+ |**200** | List Of Trunks | - |
880
+ |**400** | Bad Request | - |
881
+ |**401** | Unauthorised | - |
882
+ |**403** | Access Denied | - |
883
+
884
+ [[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)
885
+
886
+ # **getGetBaseServices**
887
+ > Array<BaseService> getGetBaseServices()
888
+
889
+ Get Base Services
890
+
891
+ ### Example
892
+
893
+ ```typescript
894
+ import {
895
+ BillingApi,
896
+ Configuration
897
+ } from 'yellowgrid-api-ts';
898
+
899
+ const configuration = new Configuration();
900
+ const apiInstance = new BillingApi(configuration);
901
+
902
+ const { status, data } = await apiInstance.getGetBaseServices();
903
+ ```
904
+
905
+ ### Parameters
906
+ This endpoint does not have any parameters.
907
+
908
+
909
+ ### Return type
910
+
911
+ **Array<BaseService>**
912
+
913
+ ### Authorization
914
+
915
+ No authorization required
916
+
917
+ ### HTTP request headers
918
+
919
+ - **Content-Type**: Not defined
920
+ - **Accept**: application/json
921
+
922
+
923
+ ### HTTP response details
924
+ | Status code | Description | Response headers |
925
+ |-------------|-------------|------------------|
926
+ |**200** | Base Service | - |
927
+ |**400** | Bad Request | - |
928
+ |**401** | Unauthorised | - |
929
+ |**403** | Access Denied | - |
930
+
931
+ [[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)
932
+
933
+ # **getGetBillingCustomerDetails**
934
+ > Customer getGetBillingCustomerDetails()
935
+
936
+ Get Customer
937
+
938
+ ### Example
939
+
940
+ ```typescript
941
+ import {
942
+ BillingApi,
943
+ Configuration
944
+ } from 'yellowgrid-api-ts';
945
+
946
+ const configuration = new Configuration();
947
+ const apiInstance = new BillingApi(configuration);
948
+
949
+ let billCustomerId: number; //Customer ID (optional) (default to undefined)
950
+
951
+ const { status, data } = await apiInstance.getGetBillingCustomerDetails(
952
+ billCustomerId
953
+ );
954
+ ```
955
+
956
+ ### Parameters
957
+
958
+ |Name | Type | Description | Notes|
959
+ |------------- | ------------- | ------------- | -------------|
960
+ | **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
961
+
962
+
963
+ ### Return type
964
+
965
+ **Customer**
966
+
967
+ ### Authorization
968
+
969
+ No authorization required
970
+
971
+ ### HTTP request headers
972
+
973
+ - **Content-Type**: Not defined
974
+ - **Accept**: application/json
975
+
976
+
977
+ ### HTTP response details
978
+ | Status code | Description | Response headers |
979
+ |-------------|-------------|------------------|
980
+ |**200** | Customer | - |
981
+ |**400** | Bad Request | - |
982
+ |**401** | Unauthorised | - |
983
+ |**403** | Access Denied | - |
984
+
985
+ [[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)
986
+
987
+ # **getGetBundleCallsWithCost**
988
+ > Array<ProcessedCdr> getGetBundleCallsWithCost()
989
+
990
+ Get Bundle Calls With Cost
991
+
992
+ ### Example
993
+
994
+ ```typescript
995
+ import {
996
+ BillingApi,
997
+ Configuration
998
+ } from 'yellowgrid-api-ts';
999
+
1000
+ const configuration = new Configuration();
1001
+ const apiInstance = new BillingApi(configuration);
1002
+
1003
+ const { status, data } = await apiInstance.getGetBundleCallsWithCost();
1004
+ ```
1005
+
1006
+ ### Parameters
1007
+ This endpoint does not have any parameters.
1008
+
1009
+
1010
+ ### Return type
1011
+
1012
+ **Array<ProcessedCdr>**
1013
+
1014
+ ### Authorization
1015
+
1016
+ No authorization required
1017
+
1018
+ ### HTTP request headers
1019
+
1020
+ - **Content-Type**: Not defined
1021
+ - **Accept**: application/json
1022
+
1023
+
1024
+ ### HTTP response details
1025
+ | Status code | Description | Response headers |
1026
+ |-------------|-------------|------------------|
1027
+ |**200** | Process CDR | - |
1028
+ |**400** | Bad Request | - |
1029
+ |**401** | Unauthorised | - |
1030
+ |**403** | Access Denied | - |
1031
+
1032
+ [[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)
1033
+
1034
+ # **getGetCallTariffPlan**
1035
+ > CallTariffPlan getGetCallTariffPlan()
1036
+
1037
+ Get Call Tariff
1038
+
1039
+ ### Example
1040
+
1041
+ ```typescript
1042
+ import {
1043
+ BillingApi,
1044
+ Configuration
1045
+ } from 'yellowgrid-api-ts';
1046
+
1047
+ const configuration = new Configuration();
1048
+ const apiInstance = new BillingApi(configuration);
1049
+
1050
+ let callTariffPlanId: number; //Call Tariff Plan ID (default to undefined)
1051
+
1052
+ const { status, data } = await apiInstance.getGetCallTariffPlan(
1053
+ callTariffPlanId
1054
+ );
1055
+ ```
1056
+
1057
+ ### Parameters
1058
+
1059
+ |Name | Type | Description | Notes|
1060
+ |------------- | ------------- | ------------- | -------------|
1061
+ | **callTariffPlanId** | [**number**] | Call Tariff Plan ID | defaults to undefined|
1062
+
1063
+
1064
+ ### Return type
1065
+
1066
+ **CallTariffPlan**
1067
+
1068
+ ### Authorization
1069
+
1070
+ No authorization required
1071
+
1072
+ ### HTTP request headers
1073
+
1074
+ - **Content-Type**: Not defined
1075
+ - **Accept**: application/json
1076
+
1077
+
1078
+ ### HTTP response details
1079
+ | Status code | Description | Response headers |
1080
+ |-------------|-------------|------------------|
1081
+ |**200** | Call Tariff Plan | - |
1082
+ |**400** | Bad Request | - |
1083
+ |**401** | Unauthorised | - |
1084
+ |**403** | Access Denied | - |
1085
+
1086
+ [[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)
1087
+
1088
+ # **getGetCallTariffs**
1089
+ > Array<CallTariffPlan> getGetCallTariffs()
1090
+
1091
+ Get Call Tariffs
1092
+
1093
+ ### Example
1094
+
1095
+ ```typescript
1096
+ import {
1097
+ BillingApi,
1098
+ Configuration
1099
+ } from 'yellowgrid-api-ts';
1100
+
1101
+ const configuration = new Configuration();
1102
+ const apiInstance = new BillingApi(configuration);
1103
+
1104
+ const { status, data } = await apiInstance.getGetCallTariffs();
1105
+ ```
1106
+
1107
+ ### Parameters
1108
+ This endpoint does not have any parameters.
1109
+
1110
+
1111
+ ### Return type
1112
+
1113
+ **Array<CallTariffPlan>**
1114
+
1115
+ ### Authorization
1116
+
1117
+ No authorization required
1118
+
1119
+ ### HTTP request headers
1120
+
1121
+ - **Content-Type**: Not defined
1122
+ - **Accept**: application/json
1123
+
1124
+
1125
+ ### HTTP response details
1126
+ | Status code | Description | Response headers |
1127
+ |-------------|-------------|------------------|
1128
+ |**200** | Call Tariff Plan | - |
1129
+ |**400** | Bad Request | - |
1130
+ |**401** | Unauthorised | - |
1131
+ |**403** | Access Denied | - |
1132
+
1133
+ [[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)
1134
+
1135
+ # **getGetCallTariffsDetails**
1136
+ > Array<CallTariffPlan> getGetCallTariffsDetails()
1137
+
1138
+ Get Call Tariffs Detailed
1139
+
1140
+ ### Example
1141
+
1142
+ ```typescript
1143
+ import {
1144
+ BillingApi,
1145
+ Configuration
1146
+ } from 'yellowgrid-api-ts';
1147
+
1148
+ const configuration = new Configuration();
1149
+ const apiInstance = new BillingApi(configuration);
1150
+
1151
+ const { status, data } = await apiInstance.getGetCallTariffsDetails();
1152
+ ```
1153
+
1154
+ ### Parameters
1155
+ This endpoint does not have any parameters.
1156
+
1157
+
1158
+ ### Return type
1159
+
1160
+ **Array<CallTariffPlan>**
1161
+
1162
+ ### Authorization
1163
+
1164
+ No authorization required
1165
+
1166
+ ### HTTP request headers
1167
+
1168
+ - **Content-Type**: Not defined
1169
+ - **Accept**: application/json
1170
+
1171
+
1172
+ ### HTTP response details
1173
+ | Status code | Description | Response headers |
1174
+ |-------------|-------------|------------------|
1175
+ |**200** | Call Tariff Plan | - |
1176
+ |**400** | Bad Request | - |
1177
+ |**401** | Unauthorised | - |
1178
+ |**403** | Access Denied | - |
1179
+
1180
+ [[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)
1181
+
1182
+ # **getGetChildren**
1183
+ > Array<object> getGetChildren()
1184
+
1185
+ Get Children
1186
+
1187
+ ### Example
1188
+
1189
+ ```typescript
1190
+ import {
1191
+ BillingApi,
1192
+ Configuration
1193
+ } from 'yellowgrid-api-ts';
1194
+
1195
+ const configuration = new Configuration();
1196
+ const apiInstance = new BillingApi(configuration);
1197
+
1198
+ let billCustomerId: number; //Customer ID (optional) (default to undefined)
1199
+
1200
+ const { status, data } = await apiInstance.getGetChildren(
1201
+ billCustomerId
1202
+ );
1203
+ ```
1204
+
1205
+ ### Parameters
1206
+
1207
+ |Name | Type | Description | Notes|
1208
+ |------------- | ------------- | ------------- | -------------|
1209
+ | **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
1210
+
1211
+
1212
+ ### Return type
1213
+
1214
+ **Array<object>**
1215
+
1216
+ ### Authorization
1217
+
1218
+ No authorization required
1219
+
1220
+ ### HTTP request headers
1221
+
1222
+ - **Content-Type**: Not defined
1223
+ - **Accept**: application/json
1224
+
1225
+
1226
+ ### HTTP response details
1227
+ | Status code | Description | Response headers |
1228
+ |-------------|-------------|------------------|
1229
+ |**200** | Child Names | - |
1230
+ |**400** | Bad Request | - |
1231
+ |**401** | Unauthorised | - |
1232
+ |**403** | Access Denied | - |
1233
+
1234
+ [[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)
1235
+
1236
+ # **getGetConnection**
1237
+ > OutboundCli getGetConnection()
1238
+
1239
+ Get Connection
1240
+
1241
+ ### Example
1242
+
1243
+ ```typescript
1244
+ import {
1245
+ BillingApi,
1246
+ Configuration
1247
+ } from 'yellowgrid-api-ts';
1248
+
1249
+ const configuration = new Configuration();
1250
+ const apiInstance = new BillingApi(configuration);
1251
+
1252
+ let id: number; //Connection ID (default to undefined)
1253
+ let billCustomerId: number; //Customer ID (optional) (default to undefined)
1254
+
1255
+ const { status, data } = await apiInstance.getGetConnection(
1256
+ id,
1257
+ billCustomerId
1258
+ );
1259
+ ```
1260
+
1261
+ ### Parameters
1262
+
1263
+ |Name | Type | Description | Notes|
1264
+ |------------- | ------------- | ------------- | -------------|
1265
+ | **id** | [**number**] | Connection ID | defaults to undefined|
1266
+ | **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
1267
+
1268
+
1269
+ ### Return type
1270
+
1271
+ **OutboundCli**
1272
+
1273
+ ### Authorization
1274
+
1275
+ No authorization required
1276
+
1277
+ ### HTTP request headers
1278
+
1279
+ - **Content-Type**: Not defined
1280
+ - **Accept**: application/json
1281
+
1282
+
1283
+ ### HTTP response details
1284
+ | Status code | Description | Response headers |
1285
+ |-------------|-------------|------------------|
1286
+ |**200** | Connection | - |
1287
+ |**400** | Bad Request | - |
1288
+ |**401** | Unauthorised | - |
1289
+ |**403** | Access Denied | - |
1290
+
1291
+ [[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)
1292
+
1293
+ # **getGetConnections**
1294
+ > Array<OutboundCli> getGetConnections()
1295
+
1296
+ Get Connections
1297
+
1298
+ ### Example
1299
+
1300
+ ```typescript
1301
+ import {
1302
+ BillingApi,
1303
+ Configuration
1304
+ } from 'yellowgrid-api-ts';
1305
+
1306
+ const configuration = new Configuration();
1307
+ const apiInstance = new BillingApi(configuration);
1308
+
1309
+ let type: 'SIP Trunks' | 'Broadband' | 'Ethernet' | 'Mobile' | 'WLR' | 'Horizon' | 'NTS' | 'Hosting' | 'CRM' | 'Starter Bundle' | 'Other' | 'Recurring Charges'; //Connection Type (optional) (default to undefined)
1310
+ let billCustomerId: number; //Customer ID (optional) (default to undefined)
1311
+
1312
+ const { status, data } = await apiInstance.getGetConnections(
1313
+ type,
1314
+ billCustomerId
1315
+ );
1316
+ ```
1317
+
1318
+ ### Parameters
1319
+
1320
+ |Name | Type | Description | Notes|
1321
+ |------------- | ------------- | ------------- | -------------|
1322
+ | **type** | [**&#39;SIP Trunks&#39; | &#39;Broadband&#39; | &#39;Ethernet&#39; | &#39;Mobile&#39; | &#39;WLR&#39; | &#39;Horizon&#39; | &#39;NTS&#39; | &#39;Hosting&#39; | &#39;CRM&#39; | &#39;Starter Bundle&#39; | &#39;Other&#39; | &#39;Recurring Charges&#39;**]**Array<&#39;SIP Trunks&#39; &#124; &#39;Broadband&#39; &#124; &#39;Ethernet&#39; &#124; &#39;Mobile&#39; &#124; &#39;WLR&#39; &#124; &#39;Horizon&#39; &#124; &#39;NTS&#39; &#124; &#39;Hosting&#39; &#124; &#39;CRM&#39; &#124; &#39;Starter Bundle&#39; &#124; &#39;Other&#39; &#124; &#39;Recurring Charges&#39;>** | Connection Type | (optional) defaults to undefined|
1323
+ | **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
1324
+
1325
+
1326
+ ### Return type
1327
+
1328
+ **Array<OutboundCli>**
1329
+
1330
+ ### Authorization
1331
+
1332
+ No authorization required
1333
+
1334
+ ### HTTP request headers
1335
+
1336
+ - **Content-Type**: Not defined
1337
+ - **Accept**: application/json
1338
+
1339
+
1340
+ ### HTTP response details
1341
+ | Status code | Description | Response headers |
1342
+ |-------------|-------------|------------------|
1343
+ |**200** | Connection | - |
1344
+ |**400** | Bad Request | - |
1345
+ |**401** | Unauthorised | - |
1346
+ |**403** | Access Denied | - |
1347
+
1348
+ [[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)
1349
+
1350
+ # **getGetCustomer**
1351
+ > Customer getGetCustomer()
1352
+
1353
+ Get Customer (Global)
1354
+
1355
+ ### Example
1356
+
1357
+ ```typescript
1358
+ import {
1359
+ BillingApi,
1360
+ Configuration
1361
+ } from 'yellowgrid-api-ts';
1362
+
1363
+ const configuration = new Configuration();
1364
+ const apiInstance = new BillingApi(configuration);
1365
+
1366
+ let accountId: string; //Account ID (optional) (default to undefined)
1367
+ let customerId: number; //Customer ID (optional) (default to undefined)
1368
+ let customerCode: string; //Customer Code (optional) (default to undefined)
1369
+
1370
+ const { status, data } = await apiInstance.getGetCustomer(
1371
+ accountId,
1372
+ customerId,
1373
+ customerCode
1374
+ );
1375
+ ```
1376
+
1377
+ ### Parameters
1378
+
1379
+ |Name | Type | Description | Notes|
1380
+ |------------- | ------------- | ------------- | -------------|
1381
+ | **accountId** | [**string**] | Account ID | (optional) defaults to undefined|
1382
+ | **customerId** | [**number**] | Customer ID | (optional) defaults to undefined|
1383
+ | **customerCode** | [**string**] | Customer Code | (optional) defaults to undefined|
1384
+
1385
+
1386
+ ### Return type
1387
+
1388
+ **Customer**
1389
+
1390
+ ### Authorization
1391
+
1392
+ No authorization required
1393
+
1394
+ ### HTTP request headers
1395
+
1396
+ - **Content-Type**: Not defined
1397
+ - **Accept**: application/json
1398
+
1399
+
1400
+ ### HTTP response details
1401
+ | Status code | Description | Response headers |
1402
+ |-------------|-------------|------------------|
1403
+ |**200** | Customer | - |
1404
+ |**400** | Bad Request | - |
1405
+ |**401** | Unauthorised | - |
1406
+ |**403** | Access Denied | - |
1407
+
1408
+ [[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)
1409
+
1410
+ # **getGetInboundTariffs**
1411
+ > Array<string> getGetInboundTariffs()
1412
+
1413
+ Get Inbound Tariffs
1414
+
1415
+ ### Example
1416
+
1417
+ ```typescript
1418
+ import {
1419
+ BillingApi,
1420
+ Configuration
1421
+ } from 'yellowgrid-api-ts';
1422
+
1423
+ const configuration = new Configuration();
1424
+ const apiInstance = new BillingApi(configuration);
1425
+
1426
+ const { status, data } = await apiInstance.getGetInboundTariffs();
1427
+ ```
1428
+
1429
+ ### Parameters
1430
+ This endpoint does not have any parameters.
1431
+
1432
+
1433
+ ### Return type
1434
+
1435
+ **Array<string>**
1436
+
1437
+ ### Authorization
1438
+
1439
+ No authorization required
1440
+
1441
+ ### HTTP request headers
1442
+
1443
+ - **Content-Type**: Not defined
1444
+ - **Accept**: application/json
1445
+
1446
+
1447
+ ### HTTP response details
1448
+ | Status code | Description | Response headers |
1449
+ |-------------|-------------|------------------|
1450
+ |**200** | Tariff Names | - |
1451
+ |**400** | Bad Request | - |
1452
+ |**401** | Unauthorised | - |
1453
+ |**403** | Access Denied | - |
1454
+
1455
+ [[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)
1456
+
1457
+ # **getGetInboundTariffsDetails**
1458
+ > Array<InboundTariffPlanResponse> getGetInboundTariffsDetails()
1459
+
1460
+ Get Inbound Tariffs Detailed
1461
+
1462
+ ### Example
1463
+
1464
+ ```typescript
1465
+ import {
1466
+ BillingApi,
1467
+ Configuration
1468
+ } from 'yellowgrid-api-ts';
1469
+
1470
+ const configuration = new Configuration();
1471
+ const apiInstance = new BillingApi(configuration);
1472
+
1473
+ const { status, data } = await apiInstance.getGetInboundTariffsDetails();
1474
+ ```
1475
+
1476
+ ### Parameters
1477
+ This endpoint does not have any parameters.
1478
+
1479
+
1480
+ ### Return type
1481
+
1482
+ **Array<InboundTariffPlanResponse>**
1483
+
1484
+ ### Authorization
1485
+
1486
+ No authorization required
1487
+
1488
+ ### HTTP request headers
1489
+
1490
+ - **Content-Type**: Not defined
1491
+ - **Accept**: application/json
1492
+
1493
+
1494
+ ### HTTP response details
1495
+ | Status code | Description | Response headers |
1496
+ |-------------|-------------|------------------|
1497
+ |**200** | Inbound Tariff | - |
1498
+ |**400** | Bad Request | - |
1499
+ |**401** | Unauthorised | - |
1500
+ |**403** | Access Denied | - |
1501
+
1502
+ [[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)
1503
+
1504
+ # **getGetPriceGroups**
1505
+ > Array<PriceGroup> getGetPriceGroups()
1506
+
1507
+ Get Price Groups
1508
+
1509
+ ### Example
1510
+
1511
+ ```typescript
1512
+ import {
1513
+ BillingApi,
1514
+ Configuration
1515
+ } from 'yellowgrid-api-ts';
1516
+
1517
+ const configuration = new Configuration();
1518
+ const apiInstance = new BillingApi(configuration);
1519
+
1520
+ const { status, data } = await apiInstance.getGetPriceGroups();
1521
+ ```
1522
+
1523
+ ### Parameters
1524
+ This endpoint does not have any parameters.
1525
+
1526
+
1527
+ ### Return type
1528
+
1529
+ **Array<PriceGroup>**
1530
+
1531
+ ### Authorization
1532
+
1533
+ No authorization required
1534
+
1535
+ ### HTTP request headers
1536
+
1537
+ - **Content-Type**: Not defined
1538
+ - **Accept**: application/json
1539
+
1540
+
1541
+ ### HTTP response details
1542
+ | Status code | Description | Response headers |
1543
+ |-------------|-------------|------------------|
1544
+ |**200** | Price Group | - |
1545
+ |**400** | Bad Request | - |
1546
+ |**401** | Unauthorised | - |
1547
+ |**403** | Access Denied | - |
1548
+
1549
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
1550
+
1551
+ # **getGetServicePlan**
1552
+ > ServicePlan getGetServicePlan()
1553
+
1554
+ Get Service Plan
1555
+
1556
+ ### Example
1557
+
1558
+ ```typescript
1559
+ import {
1560
+ BillingApi,
1561
+ Configuration
1562
+ } from 'yellowgrid-api-ts';
1563
+
1564
+ const configuration = new Configuration();
1565
+ const apiInstance = new BillingApi(configuration);
1566
+
1567
+ let servicePlanId: number; //Service Plan ID (default to undefined)
1568
+
1569
+ const { status, data } = await apiInstance.getGetServicePlan(
1570
+ servicePlanId
1571
+ );
1572
+ ```
1573
+
1574
+ ### Parameters
1575
+
1576
+ |Name | Type | Description | Notes|
1577
+ |------------- | ------------- | ------------- | -------------|
1578
+ | **servicePlanId** | [**number**] | Service Plan ID | defaults to undefined|
1579
+
1580
+
1581
+ ### Return type
1582
+
1583
+ **ServicePlan**
1584
+
1585
+ ### Authorization
1586
+
1587
+ No authorization required
1588
+
1589
+ ### HTTP request headers
1590
+
1591
+ - **Content-Type**: Not defined
1592
+ - **Accept**: application/json
1593
+
1594
+
1595
+ ### HTTP response details
1596
+ | Status code | Description | Response headers |
1597
+ |-------------|-------------|------------------|
1598
+ |**200** | Service Plan | - |
1599
+ |**400** | Bad Request | - |
1600
+ |**401** | Unauthorised | - |
1601
+ |**403** | Access Denied | - |
1602
+
1603
+ [[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)
1604
+
1605
+ # **getGetServicePlans**
1606
+ > Array<ServicePlan> getGetServicePlans()
1607
+
1608
+ Get Service Plans
1609
+
1610
+ ### Example
1611
+
1612
+ ```typescript
1613
+ import {
1614
+ BillingApi,
1615
+ Configuration
1616
+ } from 'yellowgrid-api-ts';
1617
+
1618
+ const configuration = new Configuration();
1619
+ const apiInstance = new BillingApi(configuration);
1620
+
1621
+ const { status, data } = await apiInstance.getGetServicePlans();
1622
+ ```
1623
+
1624
+ ### Parameters
1625
+ This endpoint does not have any parameters.
1626
+
1627
+
1628
+ ### Return type
1629
+
1630
+ **Array<ServicePlan>**
1631
+
1632
+ ### Authorization
1633
+
1634
+ No authorization required
1635
+
1636
+ ### HTTP request headers
1637
+
1638
+ - **Content-Type**: Not defined
1639
+ - **Accept**: application/json
1640
+
1641
+
1642
+ ### HTTP response details
1643
+ | Status code | Description | Response headers |
1644
+ |-------------|-------------|------------------|
1645
+ |**200** | Service Plan | - |
1646
+ |**400** | Bad Request | - |
1647
+ |**401** | Unauthorised | - |
1648
+ |**403** | Access Denied | - |
1649
+
1650
+ [[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)
1651
+
1652
+ # **getGetServicesPlanDetails**
1653
+ > Array<ServicePlan> getGetServicesPlanDetails()
1654
+
1655
+ Get Service Plans Detailed
1656
+
1657
+ ### Example
1658
+
1659
+ ```typescript
1660
+ import {
1661
+ BillingApi,
1662
+ Configuration
1663
+ } from 'yellowgrid-api-ts';
1664
+
1665
+ const configuration = new Configuration();
1666
+ const apiInstance = new BillingApi(configuration);
1667
+
1668
+ let type: 'SIP Trunks' | 'Broadband' | 'Ethernet' | 'Mobile' | 'WLR' | 'Horizon' | 'NTS' | 'Hosting' | 'CRM' | 'Starter Bundle' | 'Other' | 'Recurring Charges'; //Connection Type (optional) (default to undefined)
1669
+
1670
+ const { status, data } = await apiInstance.getGetServicesPlanDetails(
1671
+ type
1672
+ );
1673
+ ```
1674
+
1675
+ ### Parameters
1676
+
1677
+ |Name | Type | Description | Notes|
1678
+ |------------- | ------------- | ------------- | -------------|
1679
+ | **type** | [**&#39;SIP Trunks&#39; | &#39;Broadband&#39; | &#39;Ethernet&#39; | &#39;Mobile&#39; | &#39;WLR&#39; | &#39;Horizon&#39; | &#39;NTS&#39; | &#39;Hosting&#39; | &#39;CRM&#39; | &#39;Starter Bundle&#39; | &#39;Other&#39; | &#39;Recurring Charges&#39;**]**Array<&#39;SIP Trunks&#39; &#124; &#39;Broadband&#39; &#124; &#39;Ethernet&#39; &#124; &#39;Mobile&#39; &#124; &#39;WLR&#39; &#124; &#39;Horizon&#39; &#124; &#39;NTS&#39; &#124; &#39;Hosting&#39; &#124; &#39;CRM&#39; &#124; &#39;Starter Bundle&#39; &#124; &#39;Other&#39; &#124; &#39;Recurring Charges&#39;>** | Connection Type | (optional) defaults to undefined|
1680
+
1681
+
1682
+ ### Return type
1683
+
1684
+ **Array<ServicePlan>**
1685
+
1686
+ ### Authorization
1687
+
1688
+ No authorization required
1689
+
1690
+ ### HTTP request headers
1691
+
1692
+ - **Content-Type**: Not defined
1693
+ - **Accept**: application/json
1694
+
1695
+
1696
+ ### HTTP response details
1697
+ | Status code | Description | Response headers |
1698
+ |-------------|-------------|------------------|
1699
+ |**200** | Service Plan | - |
1700
+ |**400** | Bad Request | - |
1701
+ |**401** | Unauthorised | - |
1702
+ |**403** | Access Denied | - |
1703
+
1704
+ [[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)
1705
+
1706
+ # **getGetSipTrunkList**
1707
+ > Array<Array<string>> getGetSipTrunkList()
1708
+
1709
+ Get SIP Trunk List
1710
+
1711
+ ### Example
1712
+
1713
+ ```typescript
1714
+ import {
1715
+ BillingApi,
1716
+ Configuration
1717
+ } from 'yellowgrid-api-ts';
1718
+
1719
+ const configuration = new Configuration();
1720
+ const apiInstance = new BillingApi(configuration);
1721
+
1722
+ let billCustomerId: number; //Customer ID (optional) (default to undefined)
1723
+
1724
+ const { status, data } = await apiInstance.getGetSipTrunkList(
1725
+ billCustomerId
1726
+ );
1727
+ ```
1728
+
1729
+ ### Parameters
1730
+
1731
+ |Name | Type | Description | Notes|
1732
+ |------------- | ------------- | ------------- | -------------|
1733
+ | **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
1734
+
1735
+
1736
+ ### Return type
1737
+
1738
+ **Array<Array<string>>**
1739
+
1740
+ ### Authorization
1741
+
1742
+ No authorization required
1743
+
1744
+ ### HTTP request headers
1745
+
1746
+ - **Content-Type**: Not defined
1747
+ - **Accept**: application/json
1748
+
1749
+
1750
+ ### HTTP response details
1751
+ | Status code | Description | Response headers |
1752
+ |-------------|-------------|------------------|
1753
+ |**200** | List Of SIP Trunks | - |
1754
+ |**400** | Bad Request | - |
1755
+ |**401** | Unauthorised | - |
1756
+ |**403** | Access Denied | - |
1757
+
1758
+ [[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)
1759
+
1760
+ # **getGetSipTrunksBilling**
1761
+ > Array<string> getGetSipTrunksBilling()
1762
+
1763
+ Get SIP Trunk Billing
1764
+
1765
+ ### Example
1766
+
1767
+ ```typescript
1768
+ import {
1769
+ BillingApi,
1770
+ Configuration
1771
+ } from 'yellowgrid-api-ts';
1772
+
1773
+ const configuration = new Configuration();
1774
+ const apiInstance = new BillingApi(configuration);
1775
+
1776
+ let billCustomerId: number; //Customer ID (optional) (default to undefined)
1777
+
1778
+ const { status, data } = await apiInstance.getGetSipTrunksBilling(
1779
+ billCustomerId
1780
+ );
1781
+ ```
1782
+
1783
+ ### Parameters
1784
+
1785
+ |Name | Type | Description | Notes|
1786
+ |------------- | ------------- | ------------- | -------------|
1787
+ | **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
1788
+
1789
+
1790
+ ### Return type
1791
+
1792
+ **Array<string>**
1793
+
1794
+ ### Authorization
1795
+
1796
+ No authorization required
1797
+
1798
+ ### HTTP request headers
1799
+
1800
+ - **Content-Type**: Not defined
1801
+ - **Accept**: application/json
1802
+
1803
+
1804
+ ### HTTP response details
1805
+ | Status code | Description | Response headers |
1806
+ |-------------|-------------|------------------|
1807
+ |**200** | Trunk References | - |
1808
+ |**400** | Bad Request | - |
1809
+ |**401** | Unauthorised | - |
1810
+ |**403** | Access Denied | - |
1811
+
1812
+ [[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)
1813
+
1814
+ # **getGetUnconnectedCalls**
1815
+ > Array<ProcessedCdr> getGetUnconnectedCalls()
1816
+
1817
+ Get Unconnected Calls
1818
+
1819
+ ### Example
1820
+
1821
+ ```typescript
1822
+ import {
1823
+ BillingApi,
1824
+ Configuration
1825
+ } from 'yellowgrid-api-ts';
1826
+
1827
+ const configuration = new Configuration();
1828
+ const apiInstance = new BillingApi(configuration);
1829
+
1830
+ const { status, data } = await apiInstance.getGetUnconnectedCalls();
1831
+ ```
1832
+
1833
+ ### Parameters
1834
+ This endpoint does not have any parameters.
1835
+
1836
+
1837
+ ### Return type
1838
+
1839
+ **Array<ProcessedCdr>**
1840
+
1841
+ ### Authorization
1842
+
1843
+ No authorization required
1844
+
1845
+ ### HTTP request headers
1846
+
1847
+ - **Content-Type**: Not defined
1848
+ - **Accept**: application/json
1849
+
1850
+
1851
+ ### HTTP response details
1852
+ | Status code | Description | Response headers |
1853
+ |-------------|-------------|------------------|
1854
+ |**200** | Process CDR | - |
1855
+ |**400** | Bad Request | - |
1856
+ |**401** | Unauthorised | - |
1857
+ |**403** | Access Denied | - |
1858
+
1859
+ [[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)
1860
+
1861
+ # **getGetUnconnectedServices**
1862
+ > Array<UnconnectedSdr> getGetUnconnectedServices()
1863
+
1864
+ Get Unconnected Services
1865
+
1866
+ ### Example
1867
+
1868
+ ```typescript
1869
+ import {
1870
+ BillingApi,
1871
+ Configuration
1872
+ } from 'yellowgrid-api-ts';
1873
+
1874
+ const configuration = new Configuration();
1875
+ const apiInstance = new BillingApi(configuration);
1876
+
1877
+ const { status, data } = await apiInstance.getGetUnconnectedServices();
1878
+ ```
1879
+
1880
+ ### Parameters
1881
+ This endpoint does not have any parameters.
1882
+
1883
+
1884
+ ### Return type
1885
+
1886
+ **Array<UnconnectedSdr>**
1887
+
1888
+ ### Authorization
1889
+
1890
+ No authorization required
1891
+
1892
+ ### HTTP request headers
1893
+
1894
+ - **Content-Type**: Not defined
1895
+ - **Accept**: application/json
1896
+
1897
+
1898
+ ### HTTP response details
1899
+ | Status code | Description | Response headers |
1900
+ |-------------|-------------|------------------|
1901
+ |**200** | Unconnected SDR | - |
1902
+ |**400** | Bad Request | - |
1903
+ |**401** | Unauthorised | - |
1904
+ |**403** | Access Denied | - |
1905
+
1906
+ [[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)
1907
+
1908
+ # **getIsBundleCustomer**
1909
+ > boolean getIsBundleCustomer()
1910
+
1911
+ Is Bundle Customer
1912
+
1913
+ ### Example
1914
+
1915
+ ```typescript
1916
+ import {
1917
+ BillingApi,
1918
+ Configuration
1919
+ } from 'yellowgrid-api-ts';
1920
+
1921
+ const configuration = new Configuration();
1922
+ const apiInstance = new BillingApi(configuration);
1923
+
1924
+ let billCustomerId: number; //Customer ID (optional) (default to undefined)
1925
+
1926
+ const { status, data } = await apiInstance.getIsBundleCustomer(
1927
+ billCustomerId
1928
+ );
1929
+ ```
1930
+
1931
+ ### Parameters
1932
+
1933
+ |Name | Type | Description | Notes|
1934
+ |------------- | ------------- | ------------- | -------------|
1935
+ | **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
1936
+
1937
+
1938
+ ### Return type
1939
+
1940
+ **boolean**
1941
+
1942
+ ### Authorization
1943
+
1944
+ No authorization required
1945
+
1946
+ ### HTTP request headers
1947
+
1948
+ - **Content-Type**: Not defined
1949
+ - **Accept**: application/json
1950
+
1951
+
1952
+ ### HTTP response details
1953
+ | Status code | Description | Response headers |
1954
+ |-------------|-------------|------------------|
1955
+ |**200** | Successful | - |
1956
+ |**400** | Bad Request | - |
1957
+ |**401** | Unauthorised | - |
1958
+ |**403** | Access Denied | - |
1959
+
1960
+ [[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)
1961
+
1962
+ # **postAddBroadband**
1963
+ > OutboundCli postAddBroadband(postAddBroadbandRequest)
1964
+
1965
+ Add Broadband
1966
+
1967
+ ### Example
1968
+
1969
+ ```typescript
1970
+ import {
1971
+ BillingApi,
1972
+ Configuration,
1973
+ PostAddBroadbandRequest
1974
+ } from 'yellowgrid-api-ts';
1975
+
1976
+ const configuration = new Configuration();
1977
+ const apiInstance = new BillingApi(configuration);
1978
+
1979
+ let postAddBroadbandRequest: PostAddBroadbandRequest; //
1980
+ let billCustomerId: number; //Customer ID (optional) (default to undefined)
1981
+
1982
+ const { status, data } = await apiInstance.postAddBroadband(
1983
+ postAddBroadbandRequest,
1984
+ billCustomerId
1985
+ );
1986
+ ```
1987
+
1988
+ ### Parameters
1989
+
1990
+ |Name | Type | Description | Notes|
1991
+ |------------- | ------------- | ------------- | -------------|
1992
+ | **postAddBroadbandRequest** | **PostAddBroadbandRequest**| | |
1993
+ | **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
1994
+
1995
+
1996
+ ### Return type
1997
+
1998
+ **OutboundCli**
1999
+
2000
+ ### Authorization
2001
+
2002
+ No authorization required
2003
+
2004
+ ### HTTP request headers
2005
+
2006
+ - **Content-Type**: application/json
2007
+ - **Accept**: application/json
2008
+
2009
+
2010
+ ### HTTP response details
2011
+ | Status code | Description | Response headers |
2012
+ |-------------|-------------|------------------|
2013
+ |**200** | Connection | - |
2014
+ |**400** | Bad Request | - |
2015
+ |**401** | Unauthorised | - |
2016
+ |**403** | Access Denied | - |
2017
+
2018
+ [[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)
2019
+
2020
+ # **postAddCallTariffToCallTariffPlan**
2021
+ > CallTariffPlan postAddCallTariffToCallTariffPlan(postAddCallTariffToCallTariffPlanRequest)
2022
+
2023
+ Add Call Tariff To Call Tariff Plan
2024
+
2025
+ ### Example
2026
+
2027
+ ```typescript
2028
+ import {
2029
+ BillingApi,
2030
+ Configuration,
2031
+ PostAddCallTariffToCallTariffPlanRequest
2032
+ } from 'yellowgrid-api-ts';
2033
+
2034
+ const configuration = new Configuration();
2035
+ const apiInstance = new BillingApi(configuration);
2036
+
2037
+ let postAddCallTariffToCallTariffPlanRequest: PostAddCallTariffToCallTariffPlanRequest; //
2038
+
2039
+ const { status, data } = await apiInstance.postAddCallTariffToCallTariffPlan(
2040
+ postAddCallTariffToCallTariffPlanRequest
2041
+ );
2042
+ ```
2043
+
2044
+ ### Parameters
2045
+
2046
+ |Name | Type | Description | Notes|
2047
+ |------------- | ------------- | ------------- | -------------|
2048
+ | **postAddCallTariffToCallTariffPlanRequest** | **PostAddCallTariffToCallTariffPlanRequest**| | |
2049
+
2050
+
2051
+ ### Return type
2052
+
2053
+ **CallTariffPlan**
2054
+
2055
+ ### Authorization
2056
+
2057
+ No authorization required
2058
+
2059
+ ### HTTP request headers
2060
+
2061
+ - **Content-Type**: application/json
2062
+ - **Accept**: application/json
2063
+
2064
+
2065
+ ### HTTP response details
2066
+ | Status code | Description | Response headers |
2067
+ |-------------|-------------|------------------|
2068
+ |**200** | Call Tariff Plan | - |
2069
+ |**400** | Bad Request | - |
2070
+ |**401** | Unauthorised | - |
2071
+ |**403** | Access Denied | - |
2072
+
2073
+ [[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)
2074
+
2075
+ # **postAddChildCustomer**
2076
+ > Customer postAddChildCustomer(contactDetail)
2077
+
2078
+ Add Child Customer
2079
+
2080
+ ### Example
2081
+
2082
+ ```typescript
2083
+ import {
2084
+ BillingApi,
2085
+ Configuration,
2086
+ ContactDetail
2087
+ } from 'yellowgrid-api-ts';
2088
+
2089
+ const configuration = new Configuration();
2090
+ const apiInstance = new BillingApi(configuration);
2091
+
2092
+ let contactDetail: ContactDetail; //
2093
+ let billCustomerId: number; //Customer ID (optional) (default to undefined)
2094
+ let customerId: number; //Child Customer ID (optional) (default to undefined)
2095
+
2096
+ const { status, data } = await apiInstance.postAddChildCustomer(
2097
+ contactDetail,
2098
+ billCustomerId,
2099
+ customerId
2100
+ );
2101
+ ```
2102
+
2103
+ ### Parameters
2104
+
2105
+ |Name | Type | Description | Notes|
2106
+ |------------- | ------------- | ------------- | -------------|
2107
+ | **contactDetail** | **ContactDetail**| | |
2108
+ | **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
2109
+ | **customerId** | [**number**] | Child Customer ID | (optional) defaults to undefined|
2110
+
2111
+
2112
+ ### Return type
2113
+
2114
+ **Customer**
2115
+
2116
+ ### Authorization
2117
+
2118
+ No authorization required
2119
+
2120
+ ### HTTP request headers
2121
+
2122
+ - **Content-Type**: application/json
2123
+ - **Accept**: application/json
2124
+
2125
+
2126
+ ### HTTP response details
2127
+ | Status code | Description | Response headers |
2128
+ |-------------|-------------|------------------|
2129
+ |**200** | Customer | - |
2130
+ |**400** | Bad Request | - |
2131
+ |**401** | Unauthorised | - |
2132
+ |**403** | Access Denied | - |
2133
+
2134
+ [[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)
2135
+
2136
+ # **postAddEthernet**
2137
+ > OutboundCli postAddEthernet(postAddEthernetRequest)
2138
+
2139
+ Add Ethernet
2140
+
2141
+ ### Example
2142
+
2143
+ ```typescript
2144
+ import {
2145
+ BillingApi,
2146
+ Configuration,
2147
+ PostAddEthernetRequest
2148
+ } from 'yellowgrid-api-ts';
2149
+
2150
+ const configuration = new Configuration();
2151
+ const apiInstance = new BillingApi(configuration);
2152
+
2153
+ let postAddEthernetRequest: PostAddEthernetRequest; //
2154
+ let billCustomerId: number; //Customer ID (optional) (default to undefined)
2155
+
2156
+ const { status, data } = await apiInstance.postAddEthernet(
2157
+ postAddEthernetRequest,
2158
+ billCustomerId
2159
+ );
2160
+ ```
2161
+
2162
+ ### Parameters
2163
+
2164
+ |Name | Type | Description | Notes|
2165
+ |------------- | ------------- | ------------- | -------------|
2166
+ | **postAddEthernetRequest** | **PostAddEthernetRequest**| | |
2167
+ | **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
2168
+
2169
+
2170
+ ### Return type
2171
+
2172
+ **OutboundCli**
2173
+
2174
+ ### Authorization
2175
+
2176
+ No authorization required
2177
+
2178
+ ### HTTP request headers
2179
+
2180
+ - **Content-Type**: application/json
2181
+ - **Accept**: application/json
2182
+
2183
+
2184
+ ### HTTP response details
2185
+ | Status code | Description | Response headers |
2186
+ |-------------|-------------|------------------|
2187
+ |**200** | Connection | - |
2188
+ |**400** | Bad Request | - |
2189
+ |**401** | Unauthorised | - |
2190
+ |**403** | Access Denied | - |
2191
+
2192
+ [[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)
2193
+
2194
+ # **postAddRecurringCharge**
2195
+ > RecurringCharge postAddRecurringCharge(postAddRecurringChargeRequest)
2196
+
2197
+ Add Recurring Charge
2198
+
2199
+ ### Example
2200
+
2201
+ ```typescript
2202
+ import {
2203
+ BillingApi,
2204
+ Configuration,
2205
+ PostAddRecurringChargeRequest
2206
+ } from 'yellowgrid-api-ts';
2207
+
2208
+ const configuration = new Configuration();
2209
+ const apiInstance = new BillingApi(configuration);
2210
+
2211
+ let postAddRecurringChargeRequest: PostAddRecurringChargeRequest; //
2212
+ let billCustomerId: number; //Customer ID (optional) (default to undefined)
2213
+
2214
+ const { status, data } = await apiInstance.postAddRecurringCharge(
2215
+ postAddRecurringChargeRequest,
2216
+ billCustomerId
2217
+ );
2218
+ ```
2219
+
2220
+ ### Parameters
2221
+
2222
+ |Name | Type | Description | Notes|
2223
+ |------------- | ------------- | ------------- | -------------|
2224
+ | **postAddRecurringChargeRequest** | **PostAddRecurringChargeRequest**| | |
2225
+ | **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
2226
+
2227
+
2228
+ ### Return type
2229
+
2230
+ **RecurringCharge**
2231
+
2232
+ ### Authorization
2233
+
2234
+ No authorization required
2235
+
2236
+ ### HTTP request headers
2237
+
2238
+ - **Content-Type**: application/json
2239
+ - **Accept**: application/json
2240
+
2241
+
2242
+ ### HTTP response details
2243
+ | Status code | Description | Response headers |
2244
+ |-------------|-------------|------------------|
2245
+ |**200** | Recurring Charge | - |
2246
+ |**400** | Bad Request | - |
2247
+ |**401** | Unauthorised | - |
2248
+ |**403** | Access Denied | - |
2249
+
2250
+ [[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)
2251
+
2252
+ # **postAddServiceToServicePlan**
2253
+ > Service postAddServiceToServicePlan(postAddServiceToServicePlanRequest)
2254
+
2255
+ Add Service To Service Plan
2256
+
2257
+ ### Example
2258
+
2259
+ ```typescript
2260
+ import {
2261
+ BillingApi,
2262
+ Configuration,
2263
+ PostAddServiceToServicePlanRequest
2264
+ } from 'yellowgrid-api-ts';
2265
+
2266
+ const configuration = new Configuration();
2267
+ const apiInstance = new BillingApi(configuration);
2268
+
2269
+ let postAddServiceToServicePlanRequest: PostAddServiceToServicePlanRequest; //
2270
+
2271
+ const { status, data } = await apiInstance.postAddServiceToServicePlan(
2272
+ postAddServiceToServicePlanRequest
2273
+ );
2274
+ ```
2275
+
2276
+ ### Parameters
2277
+
2278
+ |Name | Type | Description | Notes|
2279
+ |------------- | ------------- | ------------- | -------------|
2280
+ | **postAddServiceToServicePlanRequest** | **PostAddServiceToServicePlanRequest**| | |
2281
+
2282
+
2283
+ ### Return type
2284
+
2285
+ **Service**
2286
+
2287
+ ### Authorization
2288
+
2289
+ No authorization required
2290
+
2291
+ ### HTTP request headers
2292
+
2293
+ - **Content-Type**: application/json
2294
+ - **Accept**: application/json
2295
+
2296
+
2297
+ ### HTTP response details
2298
+ | Status code | Description | Response headers |
2299
+ |-------------|-------------|------------------|
2300
+ |**200** | Service | - |
2301
+ |**400** | Bad Request | - |
2302
+ |**401** | Unauthorised | - |
2303
+ |**403** | Access Denied | - |
2304
+
2305
+ [[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)
2306
+
2307
+ # **postAddSipTrunkDDIs**
2308
+ > Array<OutboundCli> postAddSipTrunkDDIs(postAddSipTrunkDDIsRequest)
2309
+
2310
+ Add SIP Trunk DDIs
2311
+
2312
+ ### Example
2313
+
2314
+ ```typescript
2315
+ import {
2316
+ BillingApi,
2317
+ Configuration,
2318
+ PostAddSipTrunkDDIsRequest
2319
+ } from 'yellowgrid-api-ts';
2320
+
2321
+ const configuration = new Configuration();
2322
+ const apiInstance = new BillingApi(configuration);
2323
+
2324
+ let postAddSipTrunkDDIsRequest: PostAddSipTrunkDDIsRequest; //
2325
+ let billCustomerId: number; //Customer ID (optional) (default to undefined)
2326
+
2327
+ const { status, data } = await apiInstance.postAddSipTrunkDDIs(
2328
+ postAddSipTrunkDDIsRequest,
2329
+ billCustomerId
2330
+ );
2331
+ ```
2332
+
2333
+ ### Parameters
2334
+
2335
+ |Name | Type | Description | Notes|
2336
+ |------------- | ------------- | ------------- | -------------|
2337
+ | **postAddSipTrunkDDIsRequest** | **PostAddSipTrunkDDIsRequest**| | |
2338
+ | **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
2339
+
2340
+
2341
+ ### Return type
2342
+
2343
+ **Array<OutboundCli>**
2344
+
2345
+ ### Authorization
2346
+
2347
+ No authorization required
2348
+
2349
+ ### HTTP request headers
2350
+
2351
+ - **Content-Type**: application/json
2352
+ - **Accept**: application/json
2353
+
2354
+
2355
+ ### HTTP response details
2356
+ | Status code | Description | Response headers |
2357
+ |-------------|-------------|------------------|
2358
+ |**200** | Connection | - |
2359
+ |**400** | Bad Request | - |
2360
+ |**401** | Unauthorised | - |
2361
+ |**403** | Access Denied | - |
2362
+
2363
+ [[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)
2364
+
2365
+ # **postDisconnectConnection**
2366
+ > number postDisconnectConnection(postDisconnectDDIRequest)
2367
+
2368
+ Disconnect Connection
2369
+
2370
+ ### Example
2371
+
2372
+ ```typescript
2373
+ import {
2374
+ BillingApi,
2375
+ Configuration,
2376
+ PostDisconnectDDIRequest
2377
+ } from 'yellowgrid-api-ts';
2378
+
2379
+ const configuration = new Configuration();
2380
+ const apiInstance = new BillingApi(configuration);
2381
+
2382
+ let postDisconnectDDIRequest: PostDisconnectDDIRequest; //
2383
+ let billCustomerId: number; //Customer ID (optional) (default to undefined)
2384
+
2385
+ const { status, data } = await apiInstance.postDisconnectConnection(
2386
+ postDisconnectDDIRequest,
2387
+ billCustomerId
2388
+ );
2389
+ ```
2390
+
2391
+ ### Parameters
2392
+
2393
+ |Name | Type | Description | Notes|
2394
+ |------------- | ------------- | ------------- | -------------|
2395
+ | **postDisconnectDDIRequest** | **PostDisconnectDDIRequest**| | |
2396
+ | **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
2397
+
2398
+
2399
+ ### Return type
2400
+
2401
+ **number**
2402
+
2403
+ ### Authorization
2404
+
2405
+ No authorization required
2406
+
2407
+ ### HTTP request headers
2408
+
2409
+ - **Content-Type**: application/json
2410
+ - **Accept**: application/json
2411
+
2412
+
2413
+ ### HTTP response details
2414
+ | Status code | Description | Response headers |
2415
+ |-------------|-------------|------------------|
2416
+ |**200** | Connection ID | - |
2417
+ |**400** | Bad Request | - |
2418
+ |**401** | Unauthorised | - |
2419
+ |**403** | Access Denied | - |
2420
+
2421
+ [[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)
2422
+
2423
+ # **postDisconnectDDI**
2424
+ > number postDisconnectDDI(postDisconnectDDIRequest)
2425
+
2426
+ Disconnect DDI
2427
+
2428
+ ### Example
2429
+
2430
+ ```typescript
2431
+ import {
2432
+ BillingApi,
2433
+ Configuration,
2434
+ PostDisconnectDDIRequest
2435
+ } from 'yellowgrid-api-ts';
2436
+
2437
+ const configuration = new Configuration();
2438
+ const apiInstance = new BillingApi(configuration);
2439
+
2440
+ let postDisconnectDDIRequest: PostDisconnectDDIRequest; //
2441
+ let billCustomerId: number; //Customer ID (optional) (default to undefined)
2442
+
2443
+ const { status, data } = await apiInstance.postDisconnectDDI(
2444
+ postDisconnectDDIRequest,
2445
+ billCustomerId
2446
+ );
2447
+ ```
2448
+
2449
+ ### Parameters
2450
+
2451
+ |Name | Type | Description | Notes|
2452
+ |------------- | ------------- | ------------- | -------------|
2453
+ | **postDisconnectDDIRequest** | **PostDisconnectDDIRequest**| | |
2454
+ | **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
2455
+
2456
+
2457
+ ### Return type
2458
+
2459
+ **number**
2460
+
2461
+ ### Authorization
2462
+
2463
+ No authorization required
2464
+
2465
+ ### HTTP request headers
2466
+
2467
+ - **Content-Type**: application/json
2468
+ - **Accept**: application/json
2469
+
2470
+
2471
+ ### HTTP response details
2472
+ | Status code | Description | Response headers |
2473
+ |-------------|-------------|------------------|
2474
+ |**200** | DDI ID | - |
2475
+ |**400** | Bad Request | - |
2476
+ |**401** | Unauthorised | - |
2477
+ |**403** | Access Denied | - |
2478
+
2479
+ [[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)
2480
+
2481
+ # **postGetBaseServices**
2482
+ > Service postGetBaseServices(postGetBaseServicesRequest)
2483
+
2484
+ Add Base Service
2485
+
2486
+ ### Example
2487
+
2488
+ ```typescript
2489
+ import {
2490
+ BillingApi,
2491
+ Configuration,
2492
+ PostGetBaseServicesRequest
2493
+ } from 'yellowgrid-api-ts';
2494
+
2495
+ const configuration = new Configuration();
2496
+ const apiInstance = new BillingApi(configuration);
2497
+
2498
+ let postGetBaseServicesRequest: PostGetBaseServicesRequest; //
2499
+
2500
+ const { status, data } = await apiInstance.postGetBaseServices(
2501
+ postGetBaseServicesRequest
2502
+ );
2503
+ ```
2504
+
2505
+ ### Parameters
2506
+
2507
+ |Name | Type | Description | Notes|
2508
+ |------------- | ------------- | ------------- | -------------|
2509
+ | **postGetBaseServicesRequest** | **PostGetBaseServicesRequest**| | |
2510
+
2511
+
2512
+ ### Return type
2513
+
2514
+ **Service**
2515
+
2516
+ ### Authorization
2517
+
2518
+ No authorization required
2519
+
2520
+ ### HTTP request headers
2521
+
2522
+ - **Content-Type**: application/json
2523
+ - **Accept**: application/json
2524
+
2525
+
2526
+ ### HTTP response details
2527
+ | Status code | Description | Response headers |
2528
+ |-------------|-------------|------------------|
2529
+ |**200** | Service | - |
2530
+ |**400** | Bad Request | - |
2531
+ |**401** | Unauthorised | - |
2532
+ |**403** | Access Denied | - |
2533
+
2534
+ [[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)
2535
+
2536
+ # **postGetCallTariffPlan**
2537
+ > CallTariffPlan postGetCallTariffPlan(putGetCallTariffPlanRequest)
2538
+
2539
+ Add Call Tariff
2540
+
2541
+ ### Example
2542
+
2543
+ ```typescript
2544
+ import {
2545
+ BillingApi,
2546
+ Configuration,
2547
+ PutGetCallTariffPlanRequest
2548
+ } from 'yellowgrid-api-ts';
2549
+
2550
+ const configuration = new Configuration();
2551
+ const apiInstance = new BillingApi(configuration);
2552
+
2553
+ let putGetCallTariffPlanRequest: PutGetCallTariffPlanRequest; //
2554
+
2555
+ const { status, data } = await apiInstance.postGetCallTariffPlan(
2556
+ putGetCallTariffPlanRequest
2557
+ );
2558
+ ```
2559
+
2560
+ ### Parameters
2561
+
2562
+ |Name | Type | Description | Notes|
2563
+ |------------- | ------------- | ------------- | -------------|
2564
+ | **putGetCallTariffPlanRequest** | **PutGetCallTariffPlanRequest**| | |
2565
+
2566
+
2567
+ ### Return type
2568
+
2569
+ **CallTariffPlan**
2570
+
2571
+ ### Authorization
2572
+
2573
+ No authorization required
2574
+
2575
+ ### HTTP request headers
2576
+
2577
+ - **Content-Type**: application/json
2578
+ - **Accept**: application/json
2579
+
2580
+
2581
+ ### HTTP response details
2582
+ | Status code | Description | Response headers |
2583
+ |-------------|-------------|------------------|
2584
+ |**200** | Call Tariff Plan | - |
2585
+ |**400** | Bad Request | - |
2586
+ |**401** | Unauthorised | - |
2587
+ |**403** | Access Denied | - |
2588
+
2589
+ [[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)
2590
+
2591
+ # **postGetConnections**
2592
+ > OutboundCli postGetConnections()
2593
+
2594
+ Add Connection
2595
+
2596
+ ### Example
2597
+
2598
+ ```typescript
2599
+ import {
2600
+ BillingApi,
2601
+ Configuration,
2602
+ ConnectionRequest
2603
+ } from 'yellowgrid-api-ts';
2604
+
2605
+ const configuration = new Configuration();
2606
+ const apiInstance = new BillingApi(configuration);
2607
+
2608
+ let billCustomerId: number; //Customer ID (optional) (default to undefined)
2609
+ let connectionRequest: ConnectionRequest; // (optional)
2610
+
2611
+ const { status, data } = await apiInstance.postGetConnections(
2612
+ billCustomerId,
2613
+ connectionRequest
2614
+ );
2615
+ ```
2616
+
2617
+ ### Parameters
2618
+
2619
+ |Name | Type | Description | Notes|
2620
+ |------------- | ------------- | ------------- | -------------|
2621
+ | **connectionRequest** | **ConnectionRequest**| | |
2622
+ | **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
2623
+
2624
+
2625
+ ### Return type
2626
+
2627
+ **OutboundCli**
2628
+
2629
+ ### Authorization
2630
+
2631
+ No authorization required
2632
+
2633
+ ### HTTP request headers
2634
+
2635
+ - **Content-Type**: application/json
2636
+ - **Accept**: application/json
2637
+
2638
+
2639
+ ### HTTP response details
2640
+ | Status code | Description | Response headers |
2641
+ |-------------|-------------|------------------|
2642
+ |**200** | Connection | - |
2643
+ |**400** | Bad Request | - |
2644
+ |**401** | Unauthorised | - |
2645
+ |**403** | Access Denied | - |
2646
+
2647
+ [[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)
2648
+
2649
+ # **postGetPriceGroups**
2650
+ > PriceGroup postGetPriceGroups(postGetPriceGroupsRequest)
2651
+
2652
+ Add Price Group
2653
+
2654
+ ### Example
2655
+
2656
+ ```typescript
2657
+ import {
2658
+ BillingApi,
2659
+ Configuration,
2660
+ PostGetPriceGroupsRequest
2661
+ } from 'yellowgrid-api-ts';
2662
+
2663
+ const configuration = new Configuration();
2664
+ const apiInstance = new BillingApi(configuration);
2665
+
2666
+ let postGetPriceGroupsRequest: PostGetPriceGroupsRequest; //
2667
+
2668
+ const { status, data } = await apiInstance.postGetPriceGroups(
2669
+ postGetPriceGroupsRequest
2670
+ );
2671
+ ```
2672
+
2673
+ ### Parameters
2674
+
2675
+ |Name | Type | Description | Notes|
2676
+ |------------- | ------------- | ------------- | -------------|
2677
+ | **postGetPriceGroupsRequest** | **PostGetPriceGroupsRequest**| | |
2678
+
2679
+
2680
+ ### Return type
2681
+
2682
+ **PriceGroup**
2683
+
2684
+ ### Authorization
2685
+
2686
+ No authorization required
2687
+
2688
+ ### HTTP request headers
2689
+
2690
+ - **Content-Type**: application/json
2691
+ - **Accept**: application/json
2692
+
2693
+
2694
+ ### HTTP response details
2695
+ | Status code | Description | Response headers |
2696
+ |-------------|-------------|------------------|
2697
+ |**200** | Price Group | - |
2698
+ |**400** | Bad Request | - |
2699
+ |**401** | Unauthorised | - |
2700
+ |**403** | Access Denied | - |
2701
+
2702
+ [[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)
2703
+
2704
+ # **postGetServicePlans**
2705
+ > ServicePlan postGetServicePlans(postGetServicePlansRequest)
2706
+
2707
+ Add Service Plan
2708
+
2709
+ ### Example
2710
+
2711
+ ```typescript
2712
+ import {
2713
+ BillingApi,
2714
+ Configuration,
2715
+ PostGetServicePlansRequest
2716
+ } from 'yellowgrid-api-ts';
2717
+
2718
+ const configuration = new Configuration();
2719
+ const apiInstance = new BillingApi(configuration);
2720
+
2721
+ let postGetServicePlansRequest: PostGetServicePlansRequest; //
2722
+
2723
+ const { status, data } = await apiInstance.postGetServicePlans(
2724
+ postGetServicePlansRequest
2725
+ );
2726
+ ```
2727
+
2728
+ ### Parameters
2729
+
2730
+ |Name | Type | Description | Notes|
2731
+ |------------- | ------------- | ------------- | -------------|
2732
+ | **postGetServicePlansRequest** | **PostGetServicePlansRequest**| | |
2733
+
2734
+
2735
+ ### Return type
2736
+
2737
+ **ServicePlan**
2738
+
2739
+ ### Authorization
2740
+
2741
+ No authorization required
2742
+
2743
+ ### HTTP request headers
2744
+
2745
+ - **Content-Type**: application/json
2746
+ - **Accept**: application/json
2747
+
2748
+
2749
+ ### HTTP response details
2750
+ | Status code | Description | Response headers |
2751
+ |-------------|-------------|------------------|
2752
+ |**200** | Service Plan | - |
2753
+ |**400** | Bad Request | - |
2754
+ |**401** | Unauthorised | - |
2755
+ |**403** | Access Denied | - |
2756
+
2757
+ [[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)
2758
+
2759
+ # **postGetSipTrunksBilling**
2760
+ > OutboundCli postGetSipTrunksBilling(postGetSipTrunksBillingRequest)
2761
+
2762
+ Add SIP Trunk billing
2763
+
2764
+ ### Example
2765
+
2766
+ ```typescript
2767
+ import {
2768
+ BillingApi,
2769
+ Configuration,
2770
+ PostGetSipTrunksBillingRequest
2771
+ } from 'yellowgrid-api-ts';
2772
+
2773
+ const configuration = new Configuration();
2774
+ const apiInstance = new BillingApi(configuration);
2775
+
2776
+ let postGetSipTrunksBillingRequest: PostGetSipTrunksBillingRequest; //
2777
+ let billCustomerId: number; //Customer ID (optional) (default to undefined)
2778
+
2779
+ const { status, data } = await apiInstance.postGetSipTrunksBilling(
2780
+ postGetSipTrunksBillingRequest,
2781
+ billCustomerId
2782
+ );
2783
+ ```
2784
+
2785
+ ### Parameters
2786
+
2787
+ |Name | Type | Description | Notes|
2788
+ |------------- | ------------- | ------------- | -------------|
2789
+ | **postGetSipTrunksBillingRequest** | **PostGetSipTrunksBillingRequest**| | |
2790
+ | **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
2791
+
2792
+
2793
+ ### Return type
2794
+
2795
+ **OutboundCli**
2796
+
2797
+ ### Authorization
2798
+
2799
+ No authorization required
2800
+
2801
+ ### HTTP request headers
2802
+
2803
+ - **Content-Type**: application/json
2804
+ - **Accept**: application/json
2805
+
2806
+
2807
+ ### HTTP response details
2808
+ | Status code | Description | Response headers |
2809
+ |-------------|-------------|------------------|
2810
+ |**200** | Connection | - |
2811
+ |**400** | Bad Request | - |
2812
+ |**401** | Unauthorised | - |
2813
+ |**403** | Access Denied | - |
2814
+
2815
+ [[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)
2816
+
2817
+ # **postSendInvoices**
2818
+ > string postSendInvoices()
2819
+
2820
+ Send Invoices
2821
+
2822
+ ### Example
2823
+
2824
+ ```typescript
2825
+ import {
2826
+ BillingApi,
2827
+ Configuration
2828
+ } from 'yellowgrid-api-ts';
2829
+
2830
+ const configuration = new Configuration();
2831
+ const apiInstance = new BillingApi(configuration);
2832
+
2833
+ const { status, data } = await apiInstance.postSendInvoices();
2834
+ ```
2835
+
2836
+ ### Parameters
2837
+ This endpoint does not have any parameters.
2838
+
2839
+
2840
+ ### Return type
2841
+
2842
+ **string**
2843
+
2844
+ ### Authorization
2845
+
2846
+ No authorization required
2847
+
2848
+ ### HTTP request headers
2849
+
2850
+ - **Content-Type**: Not defined
2851
+ - **Accept**: application/json
2852
+
2853
+
2854
+ ### HTTP response details
2855
+ | Status code | Description | Response headers |
2856
+ |-------------|-------------|------------------|
2857
+ |**200** | Time Started | - |
2858
+ |**400** | Bad Request | - |
2859
+ |**401** | Unauthorised | - |
2860
+ |**403** | Access Denied | - |
2861
+
2862
+ [[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)
2863
+
2864
+ # **postUpdateConnection**
2865
+ > object postUpdateConnection(postUpdateConnectionRequest)
2866
+
2867
+ Update Connection
2868
+
2869
+ ### Example
2870
+
2871
+ ```typescript
2872
+ import {
2873
+ BillingApi,
2874
+ Configuration,
2875
+ PostUpdateConnectionRequest
2876
+ } from 'yellowgrid-api-ts';
2877
+
2878
+ const configuration = new Configuration();
2879
+ const apiInstance = new BillingApi(configuration);
2880
+
2881
+ let postUpdateConnectionRequest: PostUpdateConnectionRequest; //
2882
+ let connectionId: number; //Connection ID (optional) (default to undefined)
2883
+ let billCustomerId: number; //Customer ID (optional) (default to undefined)
2884
+
2885
+ const { status, data } = await apiInstance.postUpdateConnection(
2886
+ postUpdateConnectionRequest,
2887
+ connectionId,
2888
+ billCustomerId
2889
+ );
2890
+ ```
2891
+
2892
+ ### Parameters
2893
+
2894
+ |Name | Type | Description | Notes|
2895
+ |------------- | ------------- | ------------- | -------------|
2896
+ | **postUpdateConnectionRequest** | **PostUpdateConnectionRequest**| | |
2897
+ | **connectionId** | [**number**] | Connection ID | (optional) defaults to undefined|
2898
+ | **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
2899
+
2900
+
2901
+ ### Return type
2902
+
2903
+ **object**
2904
+
2905
+ ### Authorization
2906
+
2907
+ No authorization required
2908
+
2909
+ ### HTTP request headers
2910
+
2911
+ - **Content-Type**: application/json
2912
+ - **Accept**: application/json
2913
+
2914
+
2915
+ ### HTTP response details
2916
+ | Status code | Description | Response headers |
2917
+ |-------------|-------------|------------------|
2918
+ |**200** | Changes | - |
2919
+ |**400** | Bad Request | - |
2920
+ |**401** | Unauthorised | - |
2921
+ |**403** | Access Denied | - |
2922
+
2923
+ [[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)
2924
+
2925
+ # **postUpdateRecurringCharge**
2926
+ > RecurringCharge postUpdateRecurringCharge(postUpdateRecurringChargeRequest)
2927
+
2928
+ Update Recurring Charge
2929
+
2930
+ ### Example
2931
+
2932
+ ```typescript
2933
+ import {
2934
+ BillingApi,
2935
+ Configuration,
2936
+ PostUpdateRecurringChargeRequest
2937
+ } from 'yellowgrid-api-ts';
2938
+
2939
+ const configuration = new Configuration();
2940
+ const apiInstance = new BillingApi(configuration);
2941
+
2942
+ let id: number; //Recurring Charge ID (default to undefined)
2943
+ let postUpdateRecurringChargeRequest: PostUpdateRecurringChargeRequest; //
2944
+ let billCustomerId: number; //Customer ID (optional) (default to undefined)
2945
+
2946
+ const { status, data } = await apiInstance.postUpdateRecurringCharge(
2947
+ id,
2948
+ postUpdateRecurringChargeRequest,
2949
+ billCustomerId
2950
+ );
2951
+ ```
2952
+
2953
+ ### Parameters
2954
+
2955
+ |Name | Type | Description | Notes|
2956
+ |------------- | ------------- | ------------- | -------------|
2957
+ | **postUpdateRecurringChargeRequest** | **PostUpdateRecurringChargeRequest**| | |
2958
+ | **id** | [**number**] | Recurring Charge ID | defaults to undefined|
2959
+ | **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
2960
+
2961
+
2962
+ ### Return type
2963
+
2964
+ **RecurringCharge**
2965
+
2966
+ ### Authorization
2967
+
2968
+ No authorization required
2969
+
2970
+ ### HTTP request headers
2971
+
2972
+ - **Content-Type**: application/json
2973
+ - **Accept**: application/json
2974
+
2975
+
2976
+ ### HTTP response details
2977
+ | Status code | Description | Response headers |
2978
+ |-------------|-------------|------------------|
2979
+ |**200** | Recurring Charge | - |
2980
+ |**400** | Bad Request | - |
2981
+ |**401** | Unauthorised | - |
2982
+ |**403** | Access Denied | - |
2983
+
2984
+ [[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)
2985
+
2986
+ # **putAddCallTariffToCallTariffPlan**
2987
+ > CallTariffPlan putAddCallTariffToCallTariffPlan(putAddCallTariffToCallTariffPlanRequest)
2988
+
2989
+ Update Call Tariff
2990
+
2991
+ ### Example
2992
+
2993
+ ```typescript
2994
+ import {
2995
+ BillingApi,
2996
+ Configuration,
2997
+ PutAddCallTariffToCallTariffPlanRequest
2998
+ } from 'yellowgrid-api-ts';
2999
+
3000
+ const configuration = new Configuration();
3001
+ const apiInstance = new BillingApi(configuration);
3002
+
3003
+ let callTariffPlanId: number; //Call Tariff ID (default to undefined)
3004
+ let putAddCallTariffToCallTariffPlanRequest: PutAddCallTariffToCallTariffPlanRequest; //
3005
+
3006
+ const { status, data } = await apiInstance.putAddCallTariffToCallTariffPlan(
3007
+ callTariffPlanId,
3008
+ putAddCallTariffToCallTariffPlanRequest
3009
+ );
3010
+ ```
3011
+
3012
+ ### Parameters
3013
+
3014
+ |Name | Type | Description | Notes|
3015
+ |------------- | ------------- | ------------- | -------------|
3016
+ | **putAddCallTariffToCallTariffPlanRequest** | **PutAddCallTariffToCallTariffPlanRequest**| | |
3017
+ | **callTariffPlanId** | [**number**] | Call Tariff ID | defaults to undefined|
3018
+
3019
+
3020
+ ### Return type
3021
+
3022
+ **CallTariffPlan**
3023
+
3024
+ ### Authorization
3025
+
3026
+ No authorization required
3027
+
3028
+ ### HTTP request headers
3029
+
3030
+ - **Content-Type**: application/json
3031
+ - **Accept**: application/json
3032
+
3033
+
3034
+ ### HTTP response details
3035
+ | Status code | Description | Response headers |
3036
+ |-------------|-------------|------------------|
3037
+ |**200** | Call Tariff Plan | - |
3038
+ |**400** | Bad Request | - |
3039
+ |**401** | Unauthorised | - |
3040
+ |**403** | Access Denied | - |
3041
+
3042
+ [[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)
3043
+
3044
+ # **putAddServiceToServicePlan**
3045
+ > Service putAddServiceToServicePlan(putAddServiceToServicePlanRequest)
3046
+
3047
+ Update Service
3048
+
3049
+ ### Example
3050
+
3051
+ ```typescript
3052
+ import {
3053
+ BillingApi,
3054
+ Configuration,
3055
+ PutAddServiceToServicePlanRequest
3056
+ } from 'yellowgrid-api-ts';
3057
+
3058
+ const configuration = new Configuration();
3059
+ const apiInstance = new BillingApi(configuration);
3060
+
3061
+ let id: number; //Service ID (default to undefined)
3062
+ let putAddServiceToServicePlanRequest: PutAddServiceToServicePlanRequest; //
3063
+
3064
+ const { status, data } = await apiInstance.putAddServiceToServicePlan(
3065
+ id,
3066
+ putAddServiceToServicePlanRequest
3067
+ );
3068
+ ```
3069
+
3070
+ ### Parameters
3071
+
3072
+ |Name | Type | Description | Notes|
3073
+ |------------- | ------------- | ------------- | -------------|
3074
+ | **putAddServiceToServicePlanRequest** | **PutAddServiceToServicePlanRequest**| | |
3075
+ | **id** | [**number**] | Service ID | defaults to undefined|
3076
+
3077
+
3078
+ ### Return type
3079
+
3080
+ **Service**
3081
+
3082
+ ### Authorization
3083
+
3084
+ No authorization required
3085
+
3086
+ ### HTTP request headers
3087
+
3088
+ - **Content-Type**: application/json
3089
+ - **Accept**: application/json
3090
+
3091
+
3092
+ ### HTTP response details
3093
+ | Status code | Description | Response headers |
3094
+ |-------------|-------------|------------------|
3095
+ |**200** | Service | - |
3096
+ |**400** | Bad Request | - |
3097
+ |**401** | Unauthorised | - |
3098
+ |**403** | Access Denied | - |
3099
+
3100
+ [[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)
3101
+
3102
+ # **putConnectionSearch**
3103
+ > OutboundCli putConnectionSearch(putConnectionSearchRequest)
3104
+
3105
+ Transfer Billing Connection
3106
+
3107
+ ### Example
3108
+
3109
+ ```typescript
3110
+ import {
3111
+ BillingApi,
3112
+ Configuration,
3113
+ PutConnectionSearchRequest
3114
+ } from 'yellowgrid-api-ts';
3115
+
3116
+ const configuration = new Configuration();
3117
+ const apiInstance = new BillingApi(configuration);
3118
+
3119
+ let putConnectionSearchRequest: PutConnectionSearchRequest; //Transfer Request
3120
+ let id: number; //Connection ID (optional) (default to undefined)
3121
+ let cli: string; //CLI (optional) (default to undefined)
3122
+ let skipDDis: boolean; //Skip DDIs (optional) (default to undefined)
3123
+
3124
+ const { status, data } = await apiInstance.putConnectionSearch(
3125
+ putConnectionSearchRequest,
3126
+ id,
3127
+ cli,
3128
+ skipDDis
3129
+ );
3130
+ ```
3131
+
3132
+ ### Parameters
3133
+
3134
+ |Name | Type | Description | Notes|
3135
+ |------------- | ------------- | ------------- | -------------|
3136
+ | **putConnectionSearchRequest** | **PutConnectionSearchRequest**| Transfer Request | |
3137
+ | **id** | [**number**] | Connection ID | (optional) defaults to undefined|
3138
+ | **cli** | [**string**] | CLI | (optional) defaults to undefined|
3139
+ | **skipDDis** | [**boolean**] | Skip DDIs | (optional) defaults to undefined|
3140
+
3141
+
3142
+ ### Return type
3143
+
3144
+ **OutboundCli**
3145
+
3146
+ ### Authorization
3147
+
3148
+ No authorization required
3149
+
3150
+ ### HTTP request headers
3151
+
3152
+ - **Content-Type**: application/json
3153
+ - **Accept**: application/json
3154
+
3155
+
3156
+ ### HTTP response details
3157
+ | Status code | Description | Response headers |
3158
+ |-------------|-------------|------------------|
3159
+ |**200** | Connection | - |
3160
+ |**400** | Bad Request | - |
3161
+ |**401** | Unauthorised | - |
3162
+ |**403** | Access Denied | - |
3163
+
3164
+ [[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)
3165
+
3166
+ # **putConvertChildToParent**
3167
+ > Customer putConvertChildToParent()
3168
+
3169
+ Convert Child To Parent
3170
+
3171
+ ### Example
3172
+
3173
+ ```typescript
3174
+ import {
3175
+ BillingApi,
3176
+ Configuration
3177
+ } from 'yellowgrid-api-ts';
3178
+
3179
+ const configuration = new Configuration();
3180
+ const apiInstance = new BillingApi(configuration);
3181
+
3182
+ let billCustomerId: number; //Customer ID (optional) (default to undefined)
3183
+
3184
+ const { status, data } = await apiInstance.putConvertChildToParent(
3185
+ billCustomerId
3186
+ );
3187
+ ```
3188
+
3189
+ ### Parameters
3190
+
3191
+ |Name | Type | Description | Notes|
3192
+ |------------- | ------------- | ------------- | -------------|
3193
+ | **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
3194
+
3195
+
3196
+ ### Return type
3197
+
3198
+ **Customer**
3199
+
3200
+ ### Authorization
3201
+
3202
+ No authorization required
3203
+
3204
+ ### HTTP request headers
3205
+
3206
+ - **Content-Type**: Not defined
3207
+ - **Accept**: application/json
3208
+
3209
+
3210
+ ### HTTP response details
3211
+ | Status code | Description | Response headers |
3212
+ |-------------|-------------|------------------|
3213
+ |**200** | Customer | - |
3214
+ |**400** | Bad Request | - |
3215
+ |**401** | Unauthorised | - |
3216
+ |**403** | Access Denied | - |
3217
+
3218
+ [[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)
3219
+
3220
+ # **putDisableBundles**
3221
+ > boolean putDisableBundles()
3222
+
3223
+ Disable Bundles
3224
+
3225
+ ### Example
3226
+
3227
+ ```typescript
3228
+ import {
3229
+ BillingApi,
3230
+ Configuration
3231
+ } from 'yellowgrid-api-ts';
3232
+
3233
+ const configuration = new Configuration();
3234
+ const apiInstance = new BillingApi(configuration);
3235
+
3236
+ let billCustomerId: number; //Customer ID (optional) (default to undefined)
3237
+
3238
+ const { status, data } = await apiInstance.putDisableBundles(
3239
+ billCustomerId
3240
+ );
3241
+ ```
3242
+
3243
+ ### Parameters
3244
+
3245
+ |Name | Type | Description | Notes|
3246
+ |------------- | ------------- | ------------- | -------------|
3247
+ | **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
3248
+
3249
+
3250
+ ### Return type
3251
+
3252
+ **boolean**
3253
+
3254
+ ### Authorization
3255
+
3256
+ No authorization required
3257
+
3258
+ ### HTTP request headers
3259
+
3260
+ - **Content-Type**: Not defined
3261
+ - **Accept**: application/json
3262
+
3263
+
3264
+ ### HTTP response details
3265
+ | Status code | Description | Response headers |
3266
+ |-------------|-------------|------------------|
3267
+ |**200** | Successful | - |
3268
+ |**400** | Bad Request | - |
3269
+ |**401** | Unauthorised | - |
3270
+ |**403** | Access Denied | - |
3271
+
3272
+ [[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)
3273
+
3274
+ # **putDisableDdiBilling**
3275
+ > boolean putDisableDdiBilling()
3276
+
3277
+ Disable DDI Billing
14
3278
 
15
3279
  ### Example
16
3280
 
@@ -23,16 +3287,23 @@ import {
23
3287
  const configuration = new Configuration();
24
3288
  const apiInstance = new BillingApi(configuration);
25
3289
 
26
- const { status, data } = await apiInstance.getGetAllCustomer();
3290
+ let billCustomerId: number; //Customer ID (optional) (default to undefined)
3291
+
3292
+ const { status, data } = await apiInstance.putDisableDdiBilling(
3293
+ billCustomerId
3294
+ );
27
3295
  ```
28
3296
 
29
3297
  ### Parameters
30
- This endpoint does not have any parameters.
3298
+
3299
+ |Name | Type | Description | Notes|
3300
+ |------------- | ------------- | ------------- | -------------|
3301
+ | **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
31
3302
 
32
3303
 
33
3304
  ### Return type
34
3305
 
35
- **{ [key: string]: { [key: string]: string; }; }**
3306
+ **boolean**
36
3307
 
37
3308
  ### Authorization
38
3309
 
@@ -47,17 +3318,125 @@ No authorization required
47
3318
  ### HTTP response details
48
3319
  | Status code | Description | Response headers |
49
3320
  |-------------|-------------|------------------|
50
- |**200** | Billing Customer List | - |
3321
+ |**200** | Successful | - |
51
3322
  |**400** | Bad Request | - |
52
3323
  |**401** | Unauthorised | - |
53
3324
  |**403** | Access Denied | - |
54
3325
 
55
3326
  [[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)
56
3327
 
57
- # **putTransferConnection**
58
- > object putTransferConnection(putTransferConnectionRequest)
3328
+ # **putEnableBundles**
3329
+ > boolean putEnableBundles()
59
3330
 
60
- Transfer Billing Connection
3331
+ Enable Bundles
3332
+
3333
+ ### Example
3334
+
3335
+ ```typescript
3336
+ import {
3337
+ BillingApi,
3338
+ Configuration
3339
+ } from 'yellowgrid-api-ts';
3340
+
3341
+ const configuration = new Configuration();
3342
+ const apiInstance = new BillingApi(configuration);
3343
+
3344
+ let billCustomerId: number; //Customer ID (optional) (default to undefined)
3345
+
3346
+ const { status, data } = await apiInstance.putEnableBundles(
3347
+ billCustomerId
3348
+ );
3349
+ ```
3350
+
3351
+ ### Parameters
3352
+
3353
+ |Name | Type | Description | Notes|
3354
+ |------------- | ------------- | ------------- | -------------|
3355
+ | **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
3356
+
3357
+
3358
+ ### Return type
3359
+
3360
+ **boolean**
3361
+
3362
+ ### Authorization
3363
+
3364
+ No authorization required
3365
+
3366
+ ### HTTP request headers
3367
+
3368
+ - **Content-Type**: Not defined
3369
+ - **Accept**: application/json
3370
+
3371
+
3372
+ ### HTTP response details
3373
+ | Status code | Description | Response headers |
3374
+ |-------------|-------------|------------------|
3375
+ |**200** | Successful | - |
3376
+ |**400** | Bad Request | - |
3377
+ |**401** | Unauthorised | - |
3378
+ |**403** | Access Denied | - |
3379
+
3380
+ [[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)
3381
+
3382
+ # **putEnableDdiBilling**
3383
+ > boolean putEnableDdiBilling()
3384
+
3385
+ Enable DDI Billing
3386
+
3387
+ ### Example
3388
+
3389
+ ```typescript
3390
+ import {
3391
+ BillingApi,
3392
+ Configuration
3393
+ } from 'yellowgrid-api-ts';
3394
+
3395
+ const configuration = new Configuration();
3396
+ const apiInstance = new BillingApi(configuration);
3397
+
3398
+ let billCustomerId: number; //Customer ID (optional) (default to undefined)
3399
+
3400
+ const { status, data } = await apiInstance.putEnableDdiBilling(
3401
+ billCustomerId
3402
+ );
3403
+ ```
3404
+
3405
+ ### Parameters
3406
+
3407
+ |Name | Type | Description | Notes|
3408
+ |------------- | ------------- | ------------- | -------------|
3409
+ | **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
3410
+
3411
+
3412
+ ### Return type
3413
+
3414
+ **boolean**
3415
+
3416
+ ### Authorization
3417
+
3418
+ No authorization required
3419
+
3420
+ ### HTTP request headers
3421
+
3422
+ - **Content-Type**: Not defined
3423
+ - **Accept**: application/json
3424
+
3425
+
3426
+ ### HTTP response details
3427
+ | Status code | Description | Response headers |
3428
+ |-------------|-------------|------------------|
3429
+ |**200** | Successful | - |
3430
+ |**400** | Bad Request | - |
3431
+ |**401** | Unauthorised | - |
3432
+ |**403** | Access Denied | - |
3433
+
3434
+ [[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)
3435
+
3436
+ # **putGetBaseServices**
3437
+ > BaseService putGetBaseServices(putGetBaseServicesRequest)
3438
+
3439
+ Update Base Service
61
3440
 
62
3441
  ### Example
63
3442
 
@@ -65,22 +3444,18 @@ Transfer Billing Connection
65
3444
  import {
66
3445
  BillingApi,
67
3446
  Configuration,
68
- PutTransferConnectionRequest
3447
+ PutGetBaseServicesRequest
69
3448
  } from 'yellowgrid-api-ts';
70
3449
 
71
3450
  const configuration = new Configuration();
72
3451
  const apiInstance = new BillingApi(configuration);
73
3452
 
74
- let putTransferConnectionRequest: PutTransferConnectionRequest; //Transfer Request
75
- let id: number; //Connection ID (optional) (default to undefined)
76
- let cli: string; //CLI (optional) (default to undefined)
77
- let skipDDis: boolean; //Skip DDIs (optional) (default to undefined)
3453
+ let baseServiceId: number; //Base Service Plan ID (default to undefined)
3454
+ let putGetBaseServicesRequest: PutGetBaseServicesRequest; //
78
3455
 
79
- const { status, data } = await apiInstance.putTransferConnection(
80
- putTransferConnectionRequest,
81
- id,
82
- cli,
83
- skipDDis
3456
+ const { status, data } = await apiInstance.putGetBaseServices(
3457
+ baseServiceId,
3458
+ putGetBaseServicesRequest
84
3459
  );
85
3460
  ```
86
3461
 
@@ -88,15 +3463,190 @@ const { status, data } = await apiInstance.putTransferConnection(
88
3463
 
89
3464
  |Name | Type | Description | Notes|
90
3465
  |------------- | ------------- | ------------- | -------------|
91
- | **putTransferConnectionRequest** | **PutTransferConnectionRequest**| Transfer Request | |
92
- | **id** | [**number**] | Connection ID | (optional) defaults to undefined|
93
- | **cli** | [**string**] | CLI | (optional) defaults to undefined|
94
- | **skipDDis** | [**boolean**] | Skip DDIs | (optional) defaults to undefined|
3466
+ | **putGetBaseServicesRequest** | **PutGetBaseServicesRequest**| | |
3467
+ | **baseServiceId** | [**number**] | Base Service Plan ID | defaults to undefined|
95
3468
 
96
3469
 
97
3470
  ### Return type
98
3471
 
99
- **object**
3472
+ **BaseService**
3473
+
3474
+ ### Authorization
3475
+
3476
+ No authorization required
3477
+
3478
+ ### HTTP request headers
3479
+
3480
+ - **Content-Type**: application/json
3481
+ - **Accept**: application/json
3482
+
3483
+
3484
+ ### HTTP response details
3485
+ | Status code | Description | Response headers |
3486
+ |-------------|-------------|------------------|
3487
+ |**200** | Base Service | - |
3488
+ |**400** | Bad Request | - |
3489
+ |**401** | Unauthorised | - |
3490
+ |**403** | Access Denied | - |
3491
+
3492
+ [[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)
3493
+
3494
+ # **putGetCallTariffPlan**
3495
+ > CallTariffPlan putGetCallTariffPlan(putGetCallTariffPlanRequest)
3496
+
3497
+ Update Call Tariff
3498
+
3499
+ ### Example
3500
+
3501
+ ```typescript
3502
+ import {
3503
+ BillingApi,
3504
+ Configuration,
3505
+ PutGetCallTariffPlanRequest
3506
+ } from 'yellowgrid-api-ts';
3507
+
3508
+ const configuration = new Configuration();
3509
+ const apiInstance = new BillingApi(configuration);
3510
+
3511
+ let callTariffPlanId: number; //Call Tariff Plan ID (default to undefined)
3512
+ let putGetCallTariffPlanRequest: PutGetCallTariffPlanRequest; //
3513
+
3514
+ const { status, data } = await apiInstance.putGetCallTariffPlan(
3515
+ callTariffPlanId,
3516
+ putGetCallTariffPlanRequest
3517
+ );
3518
+ ```
3519
+
3520
+ ### Parameters
3521
+
3522
+ |Name | Type | Description | Notes|
3523
+ |------------- | ------------- | ------------- | -------------|
3524
+ | **putGetCallTariffPlanRequest** | **PutGetCallTariffPlanRequest**| | |
3525
+ | **callTariffPlanId** | [**number**] | Call Tariff Plan ID | defaults to undefined|
3526
+
3527
+
3528
+ ### Return type
3529
+
3530
+ **CallTariffPlan**
3531
+
3532
+ ### Authorization
3533
+
3534
+ No authorization required
3535
+
3536
+ ### HTTP request headers
3537
+
3538
+ - **Content-Type**: application/json
3539
+ - **Accept**: application/json
3540
+
3541
+
3542
+ ### HTTP response details
3543
+ | Status code | Description | Response headers |
3544
+ |-------------|-------------|------------------|
3545
+ |**200** | Call Tariff Plan | - |
3546
+ |**400** | Bad Request | - |
3547
+ |**401** | Unauthorised | - |
3548
+ |**403** | Access Denied | - |
3549
+
3550
+ [[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)
3551
+
3552
+ # **putGetConnections**
3553
+ > OutboundCli putGetConnections()
3554
+
3555
+ Update Connection
3556
+
3557
+ ### Example
3558
+
3559
+ ```typescript
3560
+ import {
3561
+ BillingApi,
3562
+ Configuration,
3563
+ ConnectionRequest
3564
+ } from 'yellowgrid-api-ts';
3565
+
3566
+ const configuration = new Configuration();
3567
+ const apiInstance = new BillingApi(configuration);
3568
+
3569
+ let connectionId: number; //Connection ID (default to undefined)
3570
+ let billCustomerId: number; //Customer ID (optional) (default to undefined)
3571
+ let connectionRequest: ConnectionRequest; // (optional)
3572
+
3573
+ const { status, data } = await apiInstance.putGetConnections(
3574
+ connectionId,
3575
+ billCustomerId,
3576
+ connectionRequest
3577
+ );
3578
+ ```
3579
+
3580
+ ### Parameters
3581
+
3582
+ |Name | Type | Description | Notes|
3583
+ |------------- | ------------- | ------------- | -------------|
3584
+ | **connectionRequest** | **ConnectionRequest**| | |
3585
+ | **connectionId** | [**number**] | Connection ID | defaults to undefined|
3586
+ | **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
3587
+
3588
+
3589
+ ### Return type
3590
+
3591
+ **OutboundCli**
3592
+
3593
+ ### Authorization
3594
+
3595
+ No authorization required
3596
+
3597
+ ### HTTP request headers
3598
+
3599
+ - **Content-Type**: application/json
3600
+ - **Accept**: application/json
3601
+
3602
+
3603
+ ### HTTP response details
3604
+ | Status code | Description | Response headers |
3605
+ |-------------|-------------|------------------|
3606
+ |**200** | Connection | - |
3607
+ |**400** | Bad Request | - |
3608
+ |**401** | Unauthorised | - |
3609
+ |**403** | Access Denied | - |
3610
+
3611
+ [[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)
3612
+
3613
+ # **putGetPriceGroups**
3614
+ > PriceGroup putGetPriceGroups(putGetPriceGroupsRequest)
3615
+
3616
+ Update Price Group
3617
+
3618
+ ### Example
3619
+
3620
+ ```typescript
3621
+ import {
3622
+ BillingApi,
3623
+ Configuration,
3624
+ PutGetPriceGroupsRequest
3625
+ } from 'yellowgrid-api-ts';
3626
+
3627
+ const configuration = new Configuration();
3628
+ const apiInstance = new BillingApi(configuration);
3629
+
3630
+ let priceGroupId: number; //Price Group ID (default to undefined)
3631
+ let putGetPriceGroupsRequest: PutGetPriceGroupsRequest; //
3632
+
3633
+ const { status, data } = await apiInstance.putGetPriceGroups(
3634
+ priceGroupId,
3635
+ putGetPriceGroupsRequest
3636
+ );
3637
+ ```
3638
+
3639
+ ### Parameters
3640
+
3641
+ |Name | Type | Description | Notes|
3642
+ |------------- | ------------- | ------------- | -------------|
3643
+ | **putGetPriceGroupsRequest** | **PutGetPriceGroupsRequest**| | |
3644
+ | **priceGroupId** | [**number**] | Price Group ID | defaults to undefined|
3645
+
3646
+
3647
+ ### Return type
3648
+
3649
+ **PriceGroup**
100
3650
 
101
3651
  ### Authorization
102
3652
 
@@ -111,7 +3661,7 @@ No authorization required
111
3661
  ### HTTP response details
112
3662
  | Status code | Description | Response headers |
113
3663
  |-------------|-------------|------------------|
114
- |**200** | Billing Connection | - |
3664
+ |**200** | Price Group | - |
115
3665
  |**400** | Bad Request | - |
116
3666
  |**401** | Unauthorised | - |
117
3667
  |**403** | Access Denied | - |