yellowgrid-api-ts 3.2.251 → 3.2.252-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 (859) hide show
  1. package/.openapi-generator/FILES +412 -318
  2. package/README.md +218 -3
  3. package/api.ts +21252 -10862
  4. package/base.ts +2 -2
  5. package/common.ts +1 -1
  6. package/config.json +4 -4
  7. package/configuration.ts +1 -1
  8. package/dist/api.d.ts +12832 -7167
  9. package/dist/api.js +18888 -8795
  10. package/dist/base.d.ts +1 -1
  11. package/dist/base.js +2 -2
  12. package/dist/common.d.ts +1 -1
  13. package/dist/common.js +1 -1
  14. package/dist/configuration.d.ts +1 -1
  15. package/dist/configuration.js +1 -1
  16. package/dist/index.d.ts +1 -1
  17. package/dist/index.js +1 -1
  18. package/dist/models/ConnectionTypeEnum.d.ts +73 -0
  19. package/dist/models/ConnectionTypeEnum.js +75 -0
  20. package/dist/models/ReasonEnum.d.ts +18 -0
  21. package/dist/models/ReasonEnum.js +20 -0
  22. package/dist/models/ReportEnum.d.ts +15 -0
  23. package/dist/models/ReportEnum.js +15 -0
  24. package/dist/models/ResolutionEnum.d.ts +18 -0
  25. package/dist/models/ResolutionEnum.js +20 -0
  26. package/dist/models/RmaItemCreditTypeEnum.d.ts +13 -0
  27. package/dist/models/RmaItemCreditTypeEnum.js +15 -0
  28. package/dist/models/RmaItemResolutionEnum.d.ts +28 -0
  29. package/dist/models/RmaItemResolutionEnum.js +30 -0
  30. package/dist/models/RmaItemStatusEnum.d.ts +18 -0
  31. package/dist/models/RmaItemStatusEnum.js +20 -0
  32. package/dist/models/RmaStatusEnum.d.ts +33 -0
  33. package/dist/models/RmaStatusEnum.js +35 -0
  34. package/dist/models/StatusEnum.d.ts +18 -0
  35. package/dist/models/StatusEnum.js +20 -0
  36. package/dist/src/apis/AccountsApi.d.ts +258 -0
  37. package/dist/src/apis/AccountsApi.js +975 -0
  38. package/dist/src/apis/CRMApi.d.ts +26 -0
  39. package/dist/src/apis/CRMApi.js +122 -0
  40. package/dist/src/apis/Class3CXApi.d.ts +44 -0
  41. package/dist/src/apis/Class3CXApi.js +177 -0
  42. package/dist/src/apis/Class3CXInstallationWizardApi.d.ts +446 -0
  43. package/dist/src/apis/Class3CXInstallationWizardApi.js +1740 -0
  44. package/dist/src/apis/Class3CXInstallationsApi.d.ts +253 -0
  45. package/dist/src/apis/Class3CXInstallationsApi.js +806 -0
  46. package/dist/src/apis/Class3CXIntegrationsApi.d.ts +102 -0
  47. package/dist/src/apis/Class3CXIntegrationsApi.js +386 -0
  48. package/dist/src/apis/Class3CXMultiTenantApi.d.ts +122 -0
  49. package/dist/src/apis/Class3CXMultiTenantApi.js +431 -0
  50. package/dist/src/apis/MyPBXToolsApi.d.ts +32 -0
  51. package/dist/src/apis/MyPBXToolsApi.js +136 -0
  52. package/dist/src/apis/OAuth20Api.d.ts +185 -0
  53. package/dist/src/apis/OAuth20Api.js +507 -0
  54. package/dist/src/apis/OrdersApi.d.ts +154 -0
  55. package/dist/src/apis/OrdersApi.js +512 -0
  56. package/dist/src/apis/PricingApi.d.ts +154 -0
  57. package/dist/src/apis/PricingApi.js +308 -0
  58. package/dist/src/apis/ProductsApi.d.ts +135 -0
  59. package/dist/src/apis/ProductsApi.js +531 -0
  60. package/dist/src/apis/ProvisioningApi.d.ts +112 -0
  61. package/dist/src/apis/ProvisioningApi.js +427 -0
  62. package/dist/src/apis/SIPTrunksApi.d.ts +315 -0
  63. package/dist/src/apis/SIPTrunksApi.js +1197 -0
  64. package/dist/src/apis/SMSApi.d.ts +30 -0
  65. package/dist/src/apis/SMSApi.js +130 -0
  66. package/dist/src/apis/ServicesApi.d.ts +81 -0
  67. package/dist/src/apis/ServicesApi.js +386 -0
  68. package/dist/src/apis/ShippingApi.d.ts +45 -0
  69. package/dist/src/apis/ShippingApi.js +179 -0
  70. package/dist/src/apis/StockManagementApi.d.ts +345 -0
  71. package/dist/src/apis/StockManagementApi.js +1293 -0
  72. package/dist/src/apis/SystemApi.d.ts +37 -0
  73. package/dist/src/apis/SystemApi.js +146 -0
  74. package/dist/src/apis/TicketsApi.d.ts +79 -0
  75. package/dist/src/apis/TicketsApi.js +360 -0
  76. package/dist/src/apis/WebhooksApi.d.ts +56 -0
  77. package/dist/src/apis/WebhooksApi.js +189 -0
  78. package/dist/src/apis/index.d.ts +21 -0
  79. package/dist/src/apis/index.js +39 -0
  80. package/dist/src/index.d.ts +3 -0
  81. package/dist/src/index.js +21 -0
  82. package/dist/src/models/AbstractOrderRequestDTO.d.ts +71 -0
  83. package/dist/src/models/AbstractOrderRequestDTO.js +64 -0
  84. package/dist/src/models/AccountContactEntity.d.ts +104 -0
  85. package/dist/src/models/AccountContactEntity.js +73 -0
  86. package/dist/src/models/AccountContactModel.d.ts +104 -0
  87. package/dist/src/models/AccountContactModel.js +73 -0
  88. package/dist/src/models/AccountContactRequestModel.d.ts +80 -0
  89. package/dist/src/models/AccountContactRequestModel.js +65 -0
  90. package/dist/src/models/AccountDetailedSummaryDTO.d.ts +89 -0
  91. package/dist/src/models/AccountDetailedSummaryDTO.js +70 -0
  92. package/dist/src/models/AccountRequestModel.d.ts +128 -0
  93. package/dist/src/models/AccountRequestModel.js +81 -0
  94. package/dist/src/models/AccountSummaryDTO.d.ts +44 -0
  95. package/dist/src/models/AccountSummaryDTO.js +53 -0
  96. package/dist/src/models/AccountsResponseModel.d.ts +51 -0
  97. package/dist/src/models/AccountsResponseModel.js +56 -0
  98. package/dist/src/models/AddressModel.d.ts +110 -0
  99. package/dist/src/models/AddressModel.js +75 -0
  100. package/dist/src/models/AddressRequestModel.d.ts +50 -0
  101. package/dist/src/models/AddressRequestModel.js +55 -0
  102. package/dist/src/models/AdminOrderRequestDTO.d.ts +113 -0
  103. package/dist/src/models/AdminOrderRequestDTO.js +78 -0
  104. package/dist/src/models/AdminUserModel.d.ts +79 -0
  105. package/dist/src/models/AdminUserModel.js +72 -0
  106. package/dist/src/models/AgentHoursGraphModel.d.ts +51 -0
  107. package/dist/src/models/AgentHoursGraphModel.js +56 -0
  108. package/dist/src/models/AgentHoursGraphMonthModel.d.ts +38 -0
  109. package/dist/src/models/AgentHoursGraphMonthModel.js +51 -0
  110. package/dist/src/models/ApiLogEntity.d.ts +98 -0
  111. package/dist/src/models/ApiLogEntity.js +71 -0
  112. package/dist/src/models/AreaCodeModel.d.ts +38 -0
  113. package/dist/src/models/AreaCodeModel.js +51 -0
  114. package/dist/src/models/AttachmentModel.d.ts +56 -0
  115. package/dist/src/models/AttachmentModel.js +57 -0
  116. package/dist/src/models/AttributeSetEnum.d.ts +38 -0
  117. package/dist/src/models/AttributeSetEnum.js +51 -0
  118. package/dist/src/models/AuditLogEntity.d.ts +80 -0
  119. package/dist/src/models/AuditLogEntity.js +65 -0
  120. package/dist/src/models/AuthCodeResponseModel.d.ts +44 -0
  121. package/dist/src/models/AuthCodeResponseModel.js +53 -0
  122. package/dist/src/models/BasicItemDTO.d.ts +38 -0
  123. package/dist/src/models/BasicItemDTO.js +51 -0
  124. package/dist/src/models/BasicProductDTO.d.ts +38 -0
  125. package/dist/src/models/BasicProductDTO.js +51 -0
  126. package/dist/src/models/BatchEntity.d.ts +128 -0
  127. package/dist/src/models/BatchEntity.js +81 -0
  128. package/dist/src/models/CallBarringModel.d.ts +56 -0
  129. package/dist/src/models/CallBarringModel.js +57 -0
  130. package/dist/src/models/ClientDetailsModel.d.ts +68 -0
  131. package/dist/src/models/ClientDetailsModel.js +61 -0
  132. package/dist/src/models/ClientModel.d.ts +50 -0
  133. package/dist/src/models/ClientModel.js +55 -0
  134. package/dist/src/models/CompanyContractModel.d.ts +56 -0
  135. package/dist/src/models/CompanyContractModel.js +57 -0
  136. package/dist/src/models/ContactInfoModel.d.ts +56 -0
  137. package/dist/src/models/ContactInfoModel.js +57 -0
  138. package/dist/src/models/ConversationModel.d.ts +75 -0
  139. package/dist/src/models/ConversationModel.js +64 -0
  140. package/dist/src/models/CourierPriceEntity.d.ts +86 -0
  141. package/dist/src/models/CourierPriceEntity.js +67 -0
  142. package/dist/src/models/CreditAccountEntity.d.ts +152 -0
  143. package/dist/src/models/CreditAccountEntity.js +89 -0
  144. package/dist/src/models/CrmContactDTO.d.ts +68 -0
  145. package/dist/src/models/CrmContactDTO.js +61 -0
  146. package/dist/src/models/CustomerInformationModel.d.ts +68 -0
  147. package/dist/src/models/CustomerInformationModel.js +61 -0
  148. package/dist/src/models/CustomerItemRequestDTO.d.ts +81 -0
  149. package/dist/src/models/CustomerItemRequestDTO.js +66 -0
  150. package/dist/src/models/CustomerOrderRequestDTO.d.ts +71 -0
  151. package/dist/src/models/CustomerOrderRequestDTO.js +64 -0
  152. package/dist/src/models/CustomerPriceListEnum.d.ts +38 -0
  153. package/dist/src/models/CustomerPriceListEnum.js +51 -0
  154. package/dist/src/models/CustomerSummaryReportDTO.d.ts +65 -0
  155. package/dist/src/models/CustomerSummaryReportDTO.js +62 -0
  156. package/dist/src/models/DdiRangeRequestModel.d.ts +44 -0
  157. package/dist/src/models/DdiRangeRequestModel.js +53 -0
  158. package/dist/src/models/DdiRangesRequestModel.d.ts +33 -0
  159. package/dist/src/models/DdiRangesRequestModel.js +50 -0
  160. package/dist/src/models/DetailedItemRequestDTO.d.ts +99 -0
  161. package/dist/src/models/DetailedItemRequestDTO.js +72 -0
  162. package/dist/src/models/DetailedOrderRequestDTO.d.ts +71 -0
  163. package/dist/src/models/DetailedOrderRequestDTO.js +64 -0
  164. package/dist/src/models/DivertRequestModel.d.ts +38 -0
  165. package/dist/src/models/DivertRequestModel.js +51 -0
  166. package/dist/src/models/DivertResponseModel.d.ts +52 -0
  167. package/dist/src/models/DivertResponseModel.js +61 -0
  168. package/dist/src/models/EdTechProClientEntity.d.ts +56 -0
  169. package/dist/src/models/EdTechProClientEntity.js +57 -0
  170. package/dist/src/models/EdTechProSchoolModel.d.ts +104 -0
  171. package/dist/src/models/EdTechProSchoolModel.js +73 -0
  172. package/dist/src/models/EdTechProSchoolsModel.d.ts +51 -0
  173. package/dist/src/models/EdTechProSchoolsModel.js +56 -0
  174. package/dist/src/models/EdTechProSetupModel.d.ts +56 -0
  175. package/dist/src/models/EdTechProSetupModel.js +57 -0
  176. package/dist/src/models/EventDTO.d.ts +84 -0
  177. package/dist/src/models/EventDTO.js +73 -0
  178. package/dist/src/models/EventRequestDTO.d.ts +44 -0
  179. package/dist/src/models/EventRequestDTO.js +53 -0
  180. package/dist/src/models/EventSubscriptionModel.d.ts +38 -0
  181. package/dist/src/models/EventSubscriptionModel.js +51 -0
  182. package/dist/src/models/EventTypeEnum.d.ts +19 -0
  183. package/dist/src/models/EventTypeEnum.js +24 -0
  184. package/dist/src/models/EventUpdateDTO.d.ts +50 -0
  185. package/dist/src/models/EventUpdateDTO.js +55 -0
  186. package/dist/src/models/EventUpdateEntity.d.ts +56 -0
  187. package/dist/src/models/EventUpdateEntity.js +57 -0
  188. package/dist/src/models/EventUpdateRequestDTO.d.ts +44 -0
  189. package/dist/src/models/EventUpdateRequestDTO.js +53 -0
  190. package/dist/src/models/FraudManagementModel.d.ts +38 -0
  191. package/dist/src/models/FraudManagementModel.js +51 -0
  192. package/dist/src/models/FreshdeskCompanyTicketsModel.d.ts +51 -0
  193. package/dist/src/models/FreshdeskCompanyTicketsModel.js +56 -0
  194. package/dist/src/models/FreshdeskTicketEntity.d.ts +68 -0
  195. package/dist/src/models/FreshdeskTicketEntity.js +61 -0
  196. package/dist/src/models/FtpAccountsEntity.d.ts +56 -0
  197. package/dist/src/models/FtpAccountsEntity.js +57 -0
  198. package/dist/src/models/GenericFileModel.d.ts +44 -0
  199. package/dist/src/models/GenericFileModel.js +53 -0
  200. package/dist/src/models/GetGetPrice200Response.d.ts +32 -0
  201. package/dist/src/models/GetGetPrice200Response.js +49 -0
  202. package/dist/src/models/GetGetRecording200Response.d.ts +32 -0
  203. package/dist/src/models/GetGetRecording200Response.js +49 -0
  204. package/dist/src/models/HostingChangeResponseModel.d.ts +64 -0
  205. package/dist/src/models/HostingChangeResponseModel.js +65 -0
  206. package/dist/src/models/HostingRegionDTO.d.ts +59 -0
  207. package/dist/src/models/HostingRegionDTO.js +68 -0
  208. package/dist/src/models/InstanceAutoFailoverEntity.d.ts +56 -0
  209. package/dist/src/models/InstanceAutoFailoverEntity.js +57 -0
  210. package/dist/src/models/InstanceDeletionScheduleEntity.d.ts +50 -0
  211. package/dist/src/models/InstanceDeletionScheduleEntity.js +55 -0
  212. package/dist/src/models/InstanceEntity.d.ts +152 -0
  213. package/dist/src/models/InstanceEntity.js +89 -0
  214. package/dist/src/models/InstanceFailoverEntity.d.ts +92 -0
  215. package/dist/src/models/InstanceFailoverEntity.js +69 -0
  216. package/dist/src/models/InstanceMonitoringEntity.d.ts +44 -0
  217. package/dist/src/models/InstanceMonitoringEntity.js +53 -0
  218. package/dist/src/models/InstanceMonitoringLogEntity.d.ts +62 -0
  219. package/dist/src/models/InstanceMonitoringLogEntity.js +59 -0
  220. package/dist/src/models/InstanceScheduledTasksEntity.d.ts +62 -0
  221. package/dist/src/models/InstanceScheduledTasksEntity.js +59 -0
  222. package/dist/src/models/InstanceTcxDetailsEntity.d.ts +86 -0
  223. package/dist/src/models/InstanceTcxDetailsEntity.js +67 -0
  224. package/dist/src/models/InstanceUserCredentialsEntity.d.ts +56 -0
  225. package/dist/src/models/InstanceUserCredentialsEntity.js +57 -0
  226. package/dist/src/models/ItemDTO.d.ts +117 -0
  227. package/dist/src/models/ItemDTO.js +78 -0
  228. package/dist/src/models/ItemDiscountEntity.d.ts +77 -0
  229. package/dist/src/models/ItemDiscountEntity.js +70 -0
  230. package/dist/src/models/ItemEntity.d.ts +158 -0
  231. package/dist/src/models/ItemEntity.js +91 -0
  232. package/dist/src/models/LinkedOrderEntity.d.ts +38 -0
  233. package/dist/src/models/LinkedOrderEntity.js +51 -0
  234. package/dist/src/models/MFARequiredModel.d.ts +38 -0
  235. package/dist/src/models/MFARequiredModel.js +51 -0
  236. package/dist/src/models/MonthlyUsageModel.d.ts +38 -0
  237. package/dist/src/models/MonthlyUsageModel.js +51 -0
  238. package/dist/src/models/MultiTenantChangeResponseModel.d.ts +70 -0
  239. package/dist/src/models/MultiTenantChangeResponseModel.js +75 -0
  240. package/dist/src/models/NavigationModel.d.ts +50 -0
  241. package/dist/src/models/NavigationModel.js +55 -0
  242. package/dist/src/models/OfflineInstancesEntity.d.ts +56 -0
  243. package/dist/src/models/OfflineInstancesEntity.js +57 -0
  244. package/dist/src/models/OrderEntity.d.ts +374 -0
  245. package/dist/src/models/OrderEntity.js +163 -0
  246. package/dist/src/models/OrderRequestModel.d.ts +120 -0
  247. package/dist/src/models/OrderRequestModel.js +88 -0
  248. package/dist/src/models/OrderSummariesModel.d.ts +51 -0
  249. package/dist/src/models/OrderSummariesModel.js +56 -0
  250. package/dist/src/models/OrderSummaryDTO.d.ts +126 -0
  251. package/dist/src/models/OrderSummaryDTO.js +83 -0
  252. package/dist/src/models/OrderTotalModel.d.ts +111 -0
  253. package/dist/src/models/OrderTotalModel.js +100 -0
  254. package/dist/src/models/OrderedItemEntity.d.ts +110 -0
  255. package/dist/src/models/OrderedItemEntity.js +75 -0
  256. package/dist/src/models/PatchSetTcxWizardCnameRequest.d.ts +32 -0
  257. package/dist/src/models/PatchSetTcxWizardCnameRequest.js +49 -0
  258. package/dist/src/models/PatchUpdateAccountContactPasswordRequest.d.ts +32 -0
  259. package/dist/src/models/PatchUpdateAccountContactPasswordRequest.js +49 -0
  260. package/dist/src/models/PortalAccountModel.d.ts +171 -0
  261. package/dist/src/models/PortalAccountModel.js +96 -0
  262. package/dist/src/models/PortalLoginModel.d.ts +68 -0
  263. package/dist/src/models/PortalLoginModel.js +61 -0
  264. package/dist/src/models/PostAddWebhook200Response.d.ts +32 -0
  265. package/dist/src/models/PostAddWebhook200Response.js +49 -0
  266. package/dist/src/models/PostGetClientCredentialsRequest.d.ts +32 -0
  267. package/dist/src/models/PostGetClientCredentialsRequest.js +49 -0
  268. package/dist/src/models/PostGetProductForCustomerRequest.d.ts +50 -0
  269. package/dist/src/models/PostGetProductForCustomerRequest.js +55 -0
  270. package/dist/src/models/PostGetProductRequest.d.ts +44 -0
  271. package/dist/src/models/PostGetProductRequest.js +53 -0
  272. package/dist/src/models/PriceListItemModel.d.ts +56 -0
  273. package/dist/src/models/PriceListItemModel.js +57 -0
  274. package/dist/src/models/PrizesEntity.d.ts +62 -0
  275. package/dist/src/models/PrizesEntity.js +59 -0
  276. package/dist/src/models/ProductPriceListItemModel.d.ts +62 -0
  277. package/dist/src/models/ProductPriceListItemModel.js +59 -0
  278. package/dist/src/models/ProductSearchResultsModel.d.ts +33 -0
  279. package/dist/src/models/ProductSearchResultsModel.js +50 -0
  280. package/dist/src/models/ProductSerialInfoModel.d.ts +50 -0
  281. package/dist/src/models/ProductSerialInfoModel.js +55 -0
  282. package/dist/src/models/ProductSummaryDTO.d.ts +81 -0
  283. package/dist/src/models/ProductSummaryDTO.js +66 -0
  284. package/dist/src/models/PromoCodesEntity.d.ts +98 -0
  285. package/dist/src/models/PromoCodesEntity.js +71 -0
  286. package/dist/src/models/PromoItemsEntity.d.ts +74 -0
  287. package/dist/src/models/PromoItemsEntity.js +63 -0
  288. package/dist/src/models/ProvisioningModel.d.ts +56 -0
  289. package/dist/src/models/ProvisioningModel.js +57 -0
  290. package/dist/src/models/ProvisioningRequestEntity.d.ts +44 -0
  291. package/dist/src/models/ProvisioningRequestEntity.js +53 -0
  292. package/dist/src/models/RecordingBackupAzureModel.d.ts +50 -0
  293. package/dist/src/models/RecordingBackupAzureModel.js +55 -0
  294. package/dist/src/models/RecordingsBackupInfoDTO.d.ts +40 -0
  295. package/dist/src/models/RecordingsBackupInfoDTO.js +53 -0
  296. package/dist/src/models/ResourceNotReadyException.d.ts +44 -0
  297. package/dist/src/models/ResourceNotReadyException.js +53 -0
  298. package/dist/src/models/RootAccessModel.d.ts +44 -0
  299. package/dist/src/models/RootAccessModel.js +53 -0
  300. package/dist/src/models/S3BucketEntity.d.ts +50 -0
  301. package/dist/src/models/S3BucketEntity.js +55 -0
  302. package/dist/src/models/ScannedItemModel.d.ts +56 -0
  303. package/dist/src/models/ScannedItemModel.js +57 -0
  304. package/dist/src/models/ScopeModel.d.ts +38 -0
  305. package/dist/src/models/ScopeModel.js +51 -0
  306. package/dist/src/models/ServiceEnum.d.ts +14 -0
  307. package/dist/src/models/ServiceEnum.js +19 -0
  308. package/dist/src/models/ServiceHealthDTO.d.ts +48 -0
  309. package/dist/src/models/ServiceHealthDTO.js +61 -0
  310. package/dist/src/models/ServiceHealthEnum.d.ts +19 -0
  311. package/dist/src/models/ServiceHealthEnum.js +24 -0
  312. package/dist/src/models/ServiceStatusDTO.d.ts +60 -0
  313. package/dist/src/models/ServiceStatusDTO.js +65 -0
  314. package/dist/src/models/ServiceStatusEnum.d.ts +19 -0
  315. package/dist/src/models/ServiceStatusEnum.js +24 -0
  316. package/dist/src/models/ShipmentAddressEntity.d.ts +92 -0
  317. package/dist/src/models/ShipmentAddressEntity.js +69 -0
  318. package/dist/src/models/ShipmentEntity.d.ts +98 -0
  319. package/dist/src/models/ShipmentEntity.js +71 -0
  320. package/dist/src/models/ShipmentItemEntity.d.ts +56 -0
  321. package/dist/src/models/ShipmentItemEntity.js +57 -0
  322. package/dist/src/models/ShippingConsignmentModel.d.ts +51 -0
  323. package/dist/src/models/ShippingConsignmentModel.js +56 -0
  324. package/dist/src/models/ShippingInformationDTO.d.ts +45 -0
  325. package/dist/src/models/ShippingInformationDTO.js +54 -0
  326. package/dist/src/models/ShippingServiceDTO.d.ts +47 -0
  327. package/dist/src/models/ShippingServiceDTO.js +60 -0
  328. package/dist/src/models/ShippingServiceModel.d.ts +71 -0
  329. package/dist/src/models/ShippingServiceModel.js +68 -0
  330. package/dist/src/models/ShippingServicesModel.d.ts +33 -0
  331. package/dist/src/models/ShippingServicesModel.js +50 -0
  332. package/dist/src/models/SipTrunkChangeResponseModel.d.ts +77 -0
  333. package/dist/src/models/SipTrunkChangeResponseModel.js +78 -0
  334. package/dist/src/models/SipTrunkCreationRequestModel.d.ts +66 -0
  335. package/dist/src/models/SipTrunkCreationRequestModel.js +63 -0
  336. package/dist/src/models/SipTrunkEntity.d.ts +98 -0
  337. package/dist/src/models/SipTrunkEntity.js +71 -0
  338. package/dist/src/models/SipTrunksResponseModel.d.ts +51 -0
  339. package/dist/src/models/SipTrunksResponseModel.js +56 -0
  340. package/dist/src/models/SmsAccountEntity.d.ts +68 -0
  341. package/dist/src/models/SmsAccountEntity.js +61 -0
  342. package/dist/src/models/SmsDataModel.d.ts +33 -0
  343. package/dist/src/models/SmsDataModel.js +50 -0
  344. package/dist/src/models/SmsMessageModel.d.ts +44 -0
  345. package/dist/src/models/SmsMessageModel.js +53 -0
  346. package/dist/src/models/SmsNumbersEntity.d.ts +38 -0
  347. package/dist/src/models/SmsNumbersEntity.js +51 -0
  348. package/dist/src/models/SmsPayloadModel.d.ts +45 -0
  349. package/dist/src/models/SmsPayloadModel.js +54 -0
  350. package/dist/src/models/SmsPhoneNumberModel.d.ts +53 -0
  351. package/dist/src/models/SmsPhoneNumberModel.js +66 -0
  352. package/dist/src/models/SmsResponseModel.d.ts +67 -0
  353. package/dist/src/models/SmsResponseModel.js +68 -0
  354. package/dist/src/models/SmsWhitelistEntity.d.ts +38 -0
  355. package/dist/src/models/SmsWhitelistEntity.js +51 -0
  356. package/dist/src/models/StockOrderCourierEntity.d.ts +50 -0
  357. package/dist/src/models/StockOrderCourierEntity.js +55 -0
  358. package/dist/src/models/StockOrderDeductionModel.d.ts +50 -0
  359. package/dist/src/models/StockOrderDeductionModel.js +55 -0
  360. package/dist/src/models/StockOrderDeductionRequestModel.d.ts +38 -0
  361. package/dist/src/models/StockOrderDeductionRequestModel.js +51 -0
  362. package/dist/src/models/StockOrderDeductionsEntity.d.ts +50 -0
  363. package/dist/src/models/StockOrderDeductionsEntity.js +55 -0
  364. package/dist/src/models/StockOrderEntity.d.ts +158 -0
  365. package/dist/src/models/StockOrderEntity.js +91 -0
  366. package/dist/src/models/StockOrderItemEntity.d.ts +68 -0
  367. package/dist/src/models/StockOrderItemEntity.js +61 -0
  368. package/dist/src/models/StockOrderItemModel.d.ts +80 -0
  369. package/dist/src/models/StockOrderItemModel.js +65 -0
  370. package/dist/src/models/StockOrderItemRequestModel.d.ts +50 -0
  371. package/dist/src/models/StockOrderItemRequestModel.js +55 -0
  372. package/dist/src/models/StockOrderModel.d.ts +137 -0
  373. package/dist/src/models/StockOrderModel.js +97 -0
  374. package/dist/src/models/StockOrderProductEntity.d.ts +62 -0
  375. package/dist/src/models/StockOrderProductEntity.js +59 -0
  376. package/dist/src/models/StockOrderRequestModel.d.ts +46 -0
  377. package/dist/src/models/StockOrderRequestModel.js +55 -0
  378. package/dist/src/models/StockOrderSupplierEntity.d.ts +80 -0
  379. package/dist/src/models/StockOrderSupplierEntity.js +65 -0
  380. package/dist/src/models/StockOrderSupplierModel.d.ts +80 -0
  381. package/dist/src/models/StockOrderSupplierModel.js +65 -0
  382. package/dist/src/models/StockOrdersModel.d.ts +51 -0
  383. package/dist/src/models/StockOrdersModel.js +56 -0
  384. package/dist/src/models/StockProductModel.d.ts +120 -0
  385. package/dist/src/models/StockProductModel.js +81 -0
  386. package/dist/src/models/StockProductPriceModel.d.ts +39 -0
  387. package/dist/src/models/StockProductPriceModel.js +52 -0
  388. package/dist/src/models/StockProductSummariesModel.d.ts +51 -0
  389. package/dist/src/models/StockProductSummariesModel.js +56 -0
  390. package/dist/src/models/StockProductSummaryModel.d.ts +69 -0
  391. package/dist/src/models/StockProductSummaryModel.js +62 -0
  392. package/dist/src/models/StockTransactionsEntity.d.ts +74 -0
  393. package/dist/src/models/StockTransactionsEntity.js +63 -0
  394. package/dist/src/models/SupplierEntity.d.ts +80 -0
  395. package/dist/src/models/SupplierEntity.js +65 -0
  396. package/dist/src/models/SupplierItemEntity.d.ts +74 -0
  397. package/dist/src/models/SupplierItemEntity.js +63 -0
  398. package/dist/src/models/TcxBackupEntity.d.ts +80 -0
  399. package/dist/src/models/TcxBackupEntity.js +65 -0
  400. package/dist/src/models/TcxBackupModel.d.ts +140 -0
  401. package/dist/src/models/TcxBackupModel.js +85 -0
  402. package/dist/src/models/TcxBillingEntity.d.ts +86 -0
  403. package/dist/src/models/TcxBillingEntity.js +67 -0
  404. package/dist/src/models/TcxBulkLicenceDetailsModel.d.ts +40 -0
  405. package/dist/src/models/TcxBulkLicenceDetailsModel.js +53 -0
  406. package/dist/src/models/TcxDeadLicenceEntity.d.ts +44 -0
  407. package/dist/src/models/TcxDeadLicenceEntity.js +53 -0
  408. package/dist/src/models/TcxExtsEntity.d.ts +74 -0
  409. package/dist/src/models/TcxExtsEntity.js +63 -0
  410. package/dist/src/models/TcxHostingPricingEntity.d.ts +74 -0
  411. package/dist/src/models/TcxHostingPricingEntity.js +63 -0
  412. package/dist/src/models/TcxInstallationDetailsModel.d.ts +106 -0
  413. package/dist/src/models/TcxInstallationDetailsModel.js +75 -0
  414. package/dist/src/models/TcxInstallationModel.d.ts +200 -0
  415. package/dist/src/models/TcxInstallationModel.js +105 -0
  416. package/dist/src/models/TcxInstallationsModel.d.ts +51 -0
  417. package/dist/src/models/TcxInstallationsModel.js +56 -0
  418. package/dist/src/models/TcxKeySummaryDTO.d.ts +56 -0
  419. package/dist/src/models/TcxKeySummaryDTO.js +57 -0
  420. package/dist/src/models/TcxKeysEntity.d.ts +62 -0
  421. package/dist/src/models/TcxKeysEntity.js +59 -0
  422. package/dist/src/models/TcxLicenceDetailsErrorModel.d.ts +50 -0
  423. package/dist/src/models/TcxLicenceDetailsErrorModel.js +55 -0
  424. package/dist/src/models/TcxLicenceDetailsModel.d.ts +92 -0
  425. package/dist/src/models/TcxLicenceDetailsModel.js +69 -0
  426. package/dist/src/models/TcxMacsEntity.d.ts +44 -0
  427. package/dist/src/models/TcxMacsEntity.js +53 -0
  428. package/dist/src/models/TcxMultiTenantModel.d.ts +118 -0
  429. package/dist/src/models/TcxMultiTenantModel.js +83 -0
  430. package/dist/src/models/TcxMultiTenantUserModel.d.ts +44 -0
  431. package/dist/src/models/TcxMultiTenantUserModel.js +53 -0
  432. package/dist/src/models/TcxMultiTenantsModel.d.ts +51 -0
  433. package/dist/src/models/TcxMultiTenantsModel.js +56 -0
  434. package/dist/src/models/TcxNumbersEntity.d.ts +44 -0
  435. package/dist/src/models/TcxNumbersEntity.js +53 -0
  436. package/dist/src/models/TcxOfficeHoursEntity.d.ts +116 -0
  437. package/dist/src/models/TcxOfficeHoursEntity.js +77 -0
  438. package/dist/src/models/TcxPhoneModel.d.ts +68 -0
  439. package/dist/src/models/TcxPhoneModel.js +61 -0
  440. package/dist/src/models/TcxPhonesEntity.d.ts +62 -0
  441. package/dist/src/models/TcxPhonesEntity.js +59 -0
  442. package/dist/src/models/TcxRemoteStorageModel.d.ts +50 -0
  443. package/dist/src/models/TcxRemoteStorageModel.js +55 -0
  444. package/dist/src/models/TcxSbcDTO.d.ts +62 -0
  445. package/dist/src/models/TcxSbcDTO.js +59 -0
  446. package/dist/src/models/TcxSbcEntity.d.ts +122 -0
  447. package/dist/src/models/TcxSbcEntity.js +79 -0
  448. package/dist/src/models/TcxSbcModel.d.ts +122 -0
  449. package/dist/src/models/TcxSbcModel.js +79 -0
  450. package/dist/src/models/TcxSetupEntity.d.ts +207 -0
  451. package/dist/src/models/TcxSetupEntity.js +123 -0
  452. package/dist/src/models/TcxSetupsModel.d.ts +51 -0
  453. package/dist/src/models/TcxSetupsModel.js +56 -0
  454. package/dist/src/models/TcxSipTrunksEntity.d.ts +104 -0
  455. package/dist/src/models/TcxSipTrunksEntity.js +73 -0
  456. package/dist/src/models/TcxTemplateXmlEnum.d.ts +38 -0
  457. package/dist/src/models/TcxTemplateXmlEnum.js +51 -0
  458. package/dist/src/models/TcxUsersEntity.d.ts +62 -0
  459. package/dist/src/models/TcxUsersEntity.js +59 -0
  460. package/dist/src/models/TcxWizardConfigModel.d.ts +39 -0
  461. package/dist/src/models/TcxWizardConfigModel.js +52 -0
  462. package/dist/src/models/TcxWizardModel.d.ts +150 -0
  463. package/dist/src/models/TcxWizardModel.js +114 -0
  464. package/dist/src/models/TechSupportCompanySummaryDTO.d.ts +57 -0
  465. package/dist/src/models/TechSupportCompanySummaryDTO.js +58 -0
  466. package/dist/src/models/TelephonySupportTicketModel.d.ts +94 -0
  467. package/dist/src/models/TelephonySupportTicketModel.js +71 -0
  468. package/dist/src/models/TicketSummaryModel.d.ts +74 -0
  469. package/dist/src/models/TicketSummaryModel.js +63 -0
  470. package/dist/src/models/TicketTimeDTO.d.ts +80 -0
  471. package/dist/src/models/TicketTimeDTO.js +65 -0
  472. package/dist/src/models/TokenResponseModel.d.ts +44 -0
  473. package/dist/src/models/TokenResponseModel.js +53 -0
  474. package/dist/src/models/UpdateTypeEnum.d.ts +19 -0
  475. package/dist/src/models/UpdateTypeEnum.js +24 -0
  476. package/dist/src/models/UpgradeOrderResponseModel.d.ts +38 -0
  477. package/dist/src/models/UpgradeOrderResponseModel.js +51 -0
  478. package/dist/src/models/UpgradeRequestModel.d.ts +66 -0
  479. package/dist/src/models/UpgradeRequestModel.js +70 -0
  480. package/dist/src/models/UserEntity.d.ts +98 -0
  481. package/dist/src/models/UserEntity.js +71 -0
  482. package/dist/src/models/XeroLogEntity.d.ts +86 -0
  483. package/dist/src/models/XeroLogEntity.js +67 -0
  484. package/dist/src/models/index.d.ts +196 -0
  485. package/dist/src/models/index.js +214 -0
  486. package/dist/src/runtime.d.ts +184 -0
  487. package/dist/src/runtime.js +564 -0
  488. package/docs/AbstractOrderRequestDTO.md +4 -4
  489. package/docs/AccountAddressesDTO.md +3 -3
  490. package/docs/AccountContactEntity.md +13 -13
  491. package/docs/AccountContactModel.md +13 -13
  492. package/docs/AccountContactRequestModel.md +9 -9
  493. package/docs/AccountDetailedSummaryDTO.md +11 -9
  494. package/docs/AccountFinanceDTO.md +10 -10
  495. package/docs/AccountRequestModel.md +11 -11
  496. package/docs/AccountSummaryDTO.md +3 -3
  497. package/docs/AccountsApi.md +104 -1
  498. package/docs/AccountsResponseModel.md +4 -4
  499. package/docs/AddressDTO.md +12 -6
  500. package/docs/AddressModel.md +5 -5
  501. package/docs/AddressRequestModel.md +4 -4
  502. package/docs/AdminCustomerRmasModel.md +27 -0
  503. package/docs/AdminNumberPortDTO.md +7 -7
  504. package/docs/AdminOrderRequestDTO.md +4 -4
  505. package/docs/AdminRmaDTO.md +67 -0
  506. package/docs/AdminRmaItemDTO.md +51 -0
  507. package/docs/AdminRmaNoteDTO.md +27 -0
  508. package/docs/AdminRmaSummaryDTO.md +39 -0
  509. package/docs/AdminUserModel.md +5 -5
  510. package/docs/AgentHoursGraphModel.md +4 -4
  511. package/docs/AgentHoursGraphMonthModel.md +2 -2
  512. package/docs/ApiLogEntity.md +12 -12
  513. package/docs/AreaCodeModel.md +2 -2
  514. package/docs/AttachmentModel.md +5 -5
  515. package/docs/AttributeSetEnum.md +2 -2
  516. package/docs/AuditLogEntity.md +9 -9
  517. package/docs/AuthCodeResponseModel.md +1 -1
  518. package/docs/AxisDataDTO.md +1 -1
  519. package/docs/BaseService.md +36 -0
  520. package/docs/BasicItemDTO.md +2 -2
  521. package/docs/BasicProductDTO.md +2 -2
  522. package/docs/BatchDTO.md +17 -17
  523. package/docs/BatchEntity.md +17 -17
  524. package/docs/BillingApi.md +3631 -26
  525. package/docs/BrandedVideoSummaryDTO.md +47 -0
  526. package/docs/BrandedVideosApi.md +424 -0
  527. package/docs/BrandedVideosSummariesModel.md +27 -0
  528. package/docs/Bundle.md +34 -0
  529. package/docs/BundleCustomer.md +34 -0
  530. package/docs/CRMApi.md +1 -1
  531. package/docs/CallBarringModel.md +5 -5
  532. package/docs/CallTariff.md +34 -0
  533. package/docs/CallTariffPlan.md +36 -0
  534. package/docs/CallTariffResponse.md +26 -0
  535. package/docs/Cdr.md +112 -0
  536. package/docs/Class3CXApi.md +1 -1
  537. package/docs/Class3CXInstallationWizardApi.md +385 -1
  538. package/docs/Class3CXInstallationsApi.md +1 -1
  539. package/docs/Class3CXIntegrationsApi.md +53 -1
  540. package/docs/Class3CXMultiTenantApi.md +1 -1
  541. package/docs/ClientDetailsModel.md +7 -7
  542. package/docs/ClientModel.md +4 -4
  543. package/docs/CollectionDateDTO.md +27 -0
  544. package/docs/CollectionDatesRequestDTO.md +23 -0
  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 +5 -1
  554. package/docs/CreditNoteEntity.md +5 -5
  555. package/docs/CreditNoteItemDTO.md +3 -1
  556. package/docs/CreditNoteItemEntity.md +7 -5
  557. package/docs/CreditNoteItemModel.md +7 -5
  558. package/docs/CreditNoteModel.md +5 -5
  559. package/docs/CrmActivitiesResponseDTO.md +2 -2
  560. package/docs/CrmActivityDTO.md +3 -3
  561. package/docs/CrmContactDTO.md +7 -7
  562. package/docs/CrmDateActivitiesDTO.md +1 -1
  563. package/docs/CrmNoteEntity.md +10 -10
  564. package/docs/CrmNoteModel.md +10 -10
  565. package/docs/Customer.md +98 -0
  566. package/docs/CustomerCoordinatesDTO.md +5 -5
  567. package/docs/CustomerInformationModel.md +4 -4
  568. package/docs/CustomerItemRequestDTO.md +2 -2
  569. package/docs/CustomerListAccountDTO.md +13 -13
  570. package/docs/CustomerOrderRequestDTO.md +4 -4
  571. package/docs/CustomerPriceListEnum.md +2 -2
  572. package/docs/CustomerRate.md +22 -0
  573. package/docs/CustomerRateType.md +12 -0
  574. package/docs/CustomerRmasModel.md +27 -0
  575. package/docs/CustomerSummaryReportDTO.md +6 -6
  576. package/docs/DdiRangeRequestModel.md +3 -3
  577. package/docs/DdiRangesRequestModel.md +1 -1
  578. package/docs/DetailedItemRequestDTO.md +2 -2
  579. package/docs/DetailedOrderRequestDTO.md +4 -4
  580. package/docs/DivertRequestModel.md +1 -1
  581. package/docs/DivertResponseModel.md +2 -2
  582. package/docs/EdTechProClientEntity.md +4 -4
  583. package/docs/EdTechProSchoolModel.md +11 -11
  584. package/docs/EdTechProSchoolsModel.md +4 -4
  585. package/docs/EdTechProSetupModel.md +5 -5
  586. package/docs/EmailRequestModel.md +21 -0
  587. package/docs/EngineeredWizardRequestModel.md +23 -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 +6 -6
  598. package/docs/FtpAccountsEntity.md +5 -5
  599. package/docs/GenericFileModel.md +3 -3
  600. package/docs/GetGetTcxHostingPriceList200Response.md +20 -0
  601. package/docs/GraphDTO.md +6 -6
  602. package/docs/HostingChangeResponseModel.md +5 -5
  603. package/docs/HostingRegionDTO.md +3 -3
  604. package/docs/InboundCli.md +50 -0
  605. package/docs/InboundTariffPlan.md +32 -0
  606. package/docs/InboundTariffPlanResponse.md +28 -0
  607. package/docs/InstallationDetailsDTO.md +3 -3
  608. package/docs/InstanceAutoFailoverEntity.md +5 -5
  609. package/docs/InstanceDeletionScheduleEntity.md +4 -4
  610. package/docs/InstanceEntity.md +21 -21
  611. package/docs/InstanceFailoverEntity.md +11 -11
  612. package/docs/InstanceMonitoringEntity.md +3 -3
  613. package/docs/InstanceMonitoringLogEntity.md +6 -6
  614. package/docs/InstanceScheduledTasksEntity.md +6 -6
  615. package/docs/InstanceTcxDetailsEntity.md +10 -10
  616. package/docs/InstanceUserCredentialsEntity.md +5 -5
  617. package/docs/ItemDTO.md +2 -2
  618. package/docs/ItemDiscountEntity.md +6 -6
  619. package/docs/ItemEntity.md +21 -21
  620. package/docs/ItemResolutionRequestModel.md +21 -0
  621. package/docs/LinkedOrderEntity.md +2 -2
  622. package/docs/MFARequiredModel.md +2 -2
  623. package/docs/MacAddressDTO.md +2 -2
  624. package/docs/MacAddressRequestModel.md +21 -0
  625. package/docs/MiscApi.md +1 -1
  626. package/docs/MonthlyUsageModel.md +2 -2
  627. package/docs/MultiTenantChangeResponseModel.md +4 -4
  628. package/docs/MultiTenantSipTrunkRequest.md +22 -0
  629. package/docs/MyPBXToolsApi.md +1 -1
  630. package/docs/NameRequestModel.md +21 -0
  631. package/docs/NavigationModel.md +4 -4
  632. package/docs/NoteRequestModel.md +21 -0
  633. package/docs/NumberPortDTO.md +7 -7
  634. package/docs/NumberPortNoteDTO.md +5 -5
  635. package/docs/NumberPortRangeDTO.md +2 -2
  636. package/docs/NumberPortingApi.md +22 -22
  637. package/docs/NumberPortsModel.md +4 -4
  638. package/docs/OAuth20Api.md +5 -5
  639. package/docs/OfflineInstancesEntity.md +5 -5
  640. package/docs/OrderDTO.md +3 -3
  641. package/docs/OrderDetailsDTO.md +10 -10
  642. package/docs/OrderEntity.md +56 -56
  643. package/docs/OrderItemDTO.md +2 -2
  644. package/docs/OrderRequestModel.md +6 -6
  645. package/docs/OrderSummariesModel.md +4 -4
  646. package/docs/OrderSummaryDTO.md +10 -10
  647. package/docs/OrderTotalModel.md +7 -7
  648. package/docs/OrderedItemEntity.md +14 -14
  649. package/docs/OrderedItemModel.md +14 -14
  650. package/docs/OrdersApi.md +115 -1
  651. package/docs/OutboundCli.md +70 -0
  652. package/docs/PartnerDTO.md +10 -10
  653. package/docs/PasswordSenderDTO.md +2 -2
  654. package/docs/PasswordSenderEntity.md +7 -7
  655. package/docs/PortalAccountModel.md +23 -23
  656. package/docs/PortalLoginModel.md +7 -7
  657. package/docs/PostAddBroadbandRequest.md +28 -0
  658. package/docs/PostAddCallTariffToCallTariffPlanRequest.md +34 -0
  659. package/docs/PostAddEthernetRequest.md +28 -0
  660. package/docs/PostAddRecurringChargeRequest.md +30 -0
  661. package/docs/PostAddServiceToServicePlanRequest.md +30 -0
  662. package/docs/PostAddSipTrunkDDIsRequest.md +30 -0
  663. package/docs/PostDisconnectDDIRequest.md +20 -0
  664. package/docs/PostGenerateReport200Response.md +8 -8
  665. package/docs/PostGetBaseServicesRequest.md +22 -0
  666. package/docs/PostGetPriceGroupsRequest.md +22 -0
  667. package/docs/PostGetServicePlansRequest.md +22 -0
  668. package/docs/PostGetSipTrunksBillingRequest.md +34 -0
  669. package/docs/PostUpdateConnectionRequest.md +22 -0
  670. package/docs/PostUpdateRecurringChargeRequest.md +30 -0
  671. package/docs/PriceGroup.md +30 -0
  672. package/docs/PriceGroupResponse.md +24 -0
  673. package/docs/PriceListItemModel.md +2 -2
  674. package/docs/PricingApi.md +1 -1
  675. package/docs/PrinterEntity.md +5 -5
  676. package/docs/PrizesEntity.md +6 -6
  677. package/docs/ProcessedCdr.md +96 -0
  678. package/docs/ProductDetailedSummaryDTO.md +2 -2
  679. package/docs/ProductPriceListItemModel.md +2 -2
  680. package/docs/ProductSearchResultsModel.md +1 -1
  681. package/docs/ProductSerialInfoDTO.md +27 -0
  682. package/docs/ProductSerialInfoModel.md +3 -3
  683. package/docs/ProductSummaryDTO.md +2 -2
  684. package/docs/ProductsApi.md +1 -1
  685. package/docs/PromoCodesEntity.md +13 -13
  686. package/docs/PromoItemModel.md +35 -0
  687. package/docs/PromoItemsEntity.md +8 -8
  688. package/docs/PromoModel.md +45 -0
  689. package/docs/PromoSummariesModel.md +27 -0
  690. package/docs/PromoSummaryDTO.md +31 -0
  691. package/docs/PromotionsApi.md +241 -0
  692. package/docs/ProspectDTO.md +7 -7
  693. package/docs/ProspectEntity.md +11 -11
  694. package/docs/ProspectsApi.md +1 -1
  695. package/docs/ProvisioningApi.md +1 -1
  696. package/docs/ProvisioningModel.md +3 -3
  697. package/docs/ProvisioningRequestEntity.md +3 -3
  698. package/docs/PutAddCallTariffToCallTariffPlanRequest.md +30 -0
  699. package/docs/PutAddServiceToServicePlanRequest.md +26 -0
  700. package/docs/PutConnectionSearchRequest.md +20 -0
  701. package/docs/PutGetBaseServicesRequest.md +28 -0
  702. package/docs/PutGetCallTariffPlanRequest.md +28 -0
  703. package/docs/PutGetPriceGroupsRequest.md +28 -0
  704. package/docs/RMAApi.md +1749 -0
  705. package/docs/ReasonRequestModel.md +21 -0
  706. package/docs/RecordingBackupAzureModel.md +4 -4
  707. package/docs/RecurringCharge.md +48 -0
  708. package/docs/RemoteStorageDTO.md +4 -4
  709. package/docs/ReportRequestDTO.md +1 -1
  710. package/docs/ReportsApi.md +1 -1
  711. package/docs/ResolutionRequestModel.md +21 -0
  712. package/docs/ResourceNotReadyException.md +3 -3
  713. package/docs/RmaCollectionDTO.md +27 -0
  714. package/docs/RmaCreditItemRequestDTO.md +25 -0
  715. package/docs/RmaDTO.md +47 -0
  716. package/docs/RmaItemDTO.md +35 -0
  717. package/docs/RmaItemRequestDTO.md +25 -0
  718. package/docs/RmaOrderDTO.md +33 -0
  719. package/docs/RmaOrderItemDTO.md +37 -0
  720. package/docs/RmaOrderSummaryDTO.md +25 -0
  721. package/docs/RmaReplacementOrderItemDTO.md +23 -0
  722. package/docs/RmaReplacementOrderRequestDTO.md +21 -0
  723. package/docs/RmaRequestDTO.md +36 -0
  724. package/docs/RmaReturnDTO.md +31 -0
  725. package/docs/RmaSummaryDTO.md +31 -0
  726. package/docs/RmaSummaryItemDTO.md +23 -0
  727. package/docs/RootAccessModel.md +3 -3
  728. package/docs/S3BucketEntity.md +4 -4
  729. package/docs/SIPTrunksApi.md +1 -1
  730. package/docs/SMSApi.md +1 -1
  731. package/docs/ScannedItemModel.md +1 -1
  732. package/docs/ScopeModel.md +2 -2
  733. package/docs/Sdr.md +66 -0
  734. package/docs/SdrReferenceType.md +24 -0
  735. package/docs/SearchSchoolModel.md +35 -0
  736. package/docs/SerialNumberRequestModel.md +21 -0
  737. package/docs/SeriesDTO.md +3 -3
  738. package/docs/Service.md +42 -0
  739. package/docs/ServiceHealthDTO.md +2 -2
  740. package/docs/ServicePlan.md +36 -0
  741. package/docs/ServiceStatusDTO.md +4 -4
  742. package/docs/ServicesApi.md +1 -1
  743. package/docs/ShipmentAddressEntity.md +11 -11
  744. package/docs/ShipmentDTO.md +4 -4
  745. package/docs/ShipmentEntity.md +12 -12
  746. package/docs/ShipmentItemDTO.md +2 -2
  747. package/docs/ShipmentItemEntity.md +5 -5
  748. package/docs/ShipmentItemModel.md +5 -5
  749. package/docs/ShipmentModel.md +12 -12
  750. package/docs/ShipmentRequestDTO.md +4 -4
  751. package/docs/ShippingApi.md +57 -1
  752. package/docs/ShippingConsignmentModel.md +4 -4
  753. package/docs/ShippingInformationDTO.md +3 -3
  754. package/docs/ShippingRequestDTO.md +3 -3
  755. package/docs/ShippingServiceDTO.md +2 -2
  756. package/docs/ShippingServiceModel.md +4 -4
  757. package/docs/ShippingServicesModel.md +1 -1
  758. package/docs/SipTrunkChangeResponseModel.md +5 -5
  759. package/docs/SipTrunkCreationRequestModel.md +6 -6
  760. package/docs/SipTrunkEntity.md +12 -12
  761. package/docs/SipTrunksResponseModel.md +4 -4
  762. package/docs/SmsAccountDTO.md +6 -6
  763. package/docs/SmsAccountEntity.md +6 -6
  764. package/docs/SmsAccountRequestDTO.md +5 -5
  765. package/docs/SmsDataModel.md +1 -1
  766. package/docs/SmsMessageModel.md +3 -3
  767. package/docs/SmsNumbersEntity.md +2 -2
  768. package/docs/SmsPayloadModel.md +3 -3
  769. package/docs/SmsPhoneNumberModel.md +1 -1
  770. package/docs/SmsResponseModel.md +3 -3
  771. package/docs/SmsWhitelistEntity.md +2 -2
  772. package/docs/SpecialService.md +40 -0
  773. package/docs/StockManagementApi.md +1 -1
  774. package/docs/StockOrderCourierEntity.md +4 -4
  775. package/docs/StockOrderDeductionModel.md +4 -4
  776. package/docs/StockOrderDeductionRequestModel.md +2 -2
  777. package/docs/StockOrderDeductionsEntity.md +4 -4
  778. package/docs/StockOrderEntity.md +22 -22
  779. package/docs/StockOrderItemEntity.md +7 -7
  780. package/docs/StockOrderItemModel.md +7 -7
  781. package/docs/StockOrderItemRequestModel.md +4 -4
  782. package/docs/StockOrderModel.md +14 -14
  783. package/docs/StockOrderProductEntity.md +6 -6
  784. package/docs/StockOrderRequestModel.md +3 -3
  785. package/docs/StockOrderSupplierEntity.md +9 -9
  786. package/docs/StockOrderSupplierModel.md +9 -9
  787. package/docs/StockOrdersModel.md +4 -4
  788. package/docs/StockProductModel.md +6 -6
  789. package/docs/StockProductPriceModel.md +1 -1
  790. package/docs/StockProductSummariesModel.md +4 -4
  791. package/docs/StockProductSummaryModel.md +6 -6
  792. package/docs/StockReportItemModel.md +6 -6
  793. package/docs/StockReportModel.md +5 -5
  794. package/docs/StockTransactionsEntity.md +8 -8
  795. package/docs/SupplierEntity.md +9 -9
  796. package/docs/SupplierItemEntity.md +8 -8
  797. package/docs/SupplierItemModel.md +8 -8
  798. package/docs/SupplierItemsResultsDTO.md +1 -1
  799. package/docs/SupplierModel.md +9 -9
  800. package/docs/SupplierProductModel.md +3 -3
  801. package/docs/SupplierProductResultsModel.md +4 -4
  802. package/docs/SuppliersApi.md +1 -1
  803. package/docs/SupportTicketModel.md +10 -10
  804. package/docs/SystemApi.md +1 -1
  805. package/docs/TableDTO.md +3 -3
  806. package/docs/TableDataDTO.md +1 -1
  807. package/docs/TableHistoryEntity.md +8 -8
  808. package/docs/TableRowDTO.md +1 -1
  809. package/docs/TariffRate.md +30 -0
  810. package/docs/TcxBackupEntity.md +9 -9
  811. package/docs/TcxBackupModel.md +9 -9
  812. package/docs/TcxBillingEntity.md +10 -10
  813. package/docs/TcxBulkLicenceDetailsModel.md +2 -2
  814. package/docs/TcxDeadLicenceEntity.md +3 -3
  815. package/docs/TcxEngineerTaskDTO.md +29 -0
  816. package/docs/TcxEngineeringDTO.md +37 -0
  817. package/docs/TcxInstallationModel.md +17 -17
  818. package/docs/TcxInstallationsModel.md +4 -4
  819. package/docs/TcxKeySummaryDTO.md +3 -3
  820. package/docs/TcxKeysEntity.md +6 -6
  821. package/docs/TcxLicenceDetailsErrorModel.md +4 -4
  822. package/docs/TcxLicenceDetailsModel.md +11 -11
  823. package/docs/TcxMacsEntity.md +3 -3
  824. package/docs/TcxMultiTenantModel.md +7 -7
  825. package/docs/TcxMultiTenantUserModel.md +3 -3
  826. package/docs/TcxMultiTenantsModel.md +4 -4
  827. package/docs/TcxRemoteStorageModel.md +4 -4
  828. package/docs/TcxSbcDTO.md +7 -7
  829. package/docs/TcxSbcResponseDTO.md +2 -2
  830. package/docs/TcxSetupsModel.md +4 -4
  831. package/docs/TcxSummaryDTO.md +21 -0
  832. package/docs/TcxTemplateXmlEnum.md +2 -2
  833. package/docs/TcxUsersEntity.md +6 -6
  834. package/docs/TcxWizardConfigModel.md +2 -2
  835. package/docs/TcxWizardModel.md +2 -0
  836. package/docs/TechSupportCompanySummaryDTO.md +5 -5
  837. package/docs/ThumbnailDTO.md +25 -0
  838. package/docs/TicketSummaryModel.md +6 -6
  839. package/docs/TicketTimeDTO.md +9 -9
  840. package/docs/TicketsApi.md +11 -11
  841. package/docs/TokenResponseModel.md +3 -3
  842. package/docs/UnconnectedSdr.md +68 -0
  843. package/docs/UpgradeOrderResponseModel.md +2 -2
  844. package/docs/UpgradeRequestModel.md +4 -4
  845. package/docs/UserEntity.md +10 -10
  846. package/docs/VideoRequestEntity.md +51 -0
  847. package/docs/WebhooksApi.md +1 -1
  848. package/docs/XeroLogEntity.md +10 -10
  849. package/getEnums.php +31 -31
  850. package/index.ts +1 -1
  851. package/models/ConnectionTypeEnum.ts +74 -0
  852. package/models/ReasonEnum.ts +19 -0
  853. package/models/ReportEnum.ts +15 -0
  854. package/models/ResolutionEnum.ts +19 -0
  855. package/models/RmaItemCreditTypeEnum.ts +14 -0
  856. package/models/RmaItemResolutionEnum.ts +29 -0
  857. package/models/RmaItemStatusEnum.ts +19 -0
  858. package/models/RmaStatusEnum.ts +34 -0
  859. package/package.json +1 -1
package/docs/Sdr.md ADDED
@@ -0,0 +1,66 @@
1
+ # Sdr
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **id** | **number** | | [optional] [default to undefined]
9
+ **customerIdentifier** | **string** | | [default to undefined]
10
+ **fromDate** | **string** | | [default to undefined]
11
+ **fromTime** | **string** | | [optional] [default to undefined]
12
+ **toDate** | **string** | | [optional] [default to undefined]
13
+ **toTime** | **string** | | [optional] [default to undefined]
14
+ **refund** | **string** | | [optional] [default to undefined]
15
+ **quantity** | **number** | | [optional] [default to undefined]
16
+ **frequency** | **number** | | [optional] [default to undefined]
17
+ **unitCost** | **number** | | [optional] [default to undefined]
18
+ **totalCost** | **number** | | [optional] [default to undefined]
19
+ **chargeTypeClass** | **string** | | [optional] [default to undefined]
20
+ **description** | **string** | | [default to undefined]
21
+ **serviceID** | **string** | | [optional] [default to undefined]
22
+ **accountRef** | **string** | | [optional] [default to undefined]
23
+ **carrier** | **string** | | [optional] [default to undefined]
24
+ **recordID** | **string** | | [optional] [default to undefined]
25
+ **currency** | **string** | | [optional] [default to undefined]
26
+ **discountReference** | **string** | | [optional] [default to undefined]
27
+ **effectiveDate** | **string** | | [optional] [default to undefined]
28
+ **partMonthCost** | **number** | | [optional] [default to undefined]
29
+ **filename** | **string** | | [default to undefined]
30
+ **contentReference** | **string** | | [default to undefined]
31
+ **filePeriod** | **string** | | [default to undefined]
32
+
33
+ ## Example
34
+
35
+ ```typescript
36
+ import { Sdr } from 'yellowgrid-api-ts';
37
+
38
+ const instance: Sdr = {
39
+ id,
40
+ customerIdentifier,
41
+ fromDate,
42
+ fromTime,
43
+ toDate,
44
+ toTime,
45
+ refund,
46
+ quantity,
47
+ frequency,
48
+ unitCost,
49
+ totalCost,
50
+ chargeTypeClass,
51
+ description,
52
+ serviceID,
53
+ accountRef,
54
+ carrier,
55
+ recordID,
56
+ currency,
57
+ discountReference,
58
+ effectiveDate,
59
+ partMonthCost,
60
+ filename,
61
+ contentReference,
62
+ filePeriod,
63
+ };
64
+ ```
65
+
66
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,24 @@
1
+ # SdrReferenceType
2
+
3
+
4
+ ## Enum
5
+
6
+ * `SipTrunk` (value: `'SIP_TRUNK'`)
7
+
8
+ * `Broadband` (value: `'BROADBAND'`)
9
+
10
+ * `Ethernet` (value: `'ETHERNET'`)
11
+
12
+ * `Mobile` (value: `'MOBILE'`)
13
+
14
+ * `Wlr` (value: `'WLR'`)
15
+
16
+ * `Hzn` (value: `'HZN'`)
17
+
18
+ * `Nts` (value: `'NTS'`)
19
+
20
+ * `Hosting` (value: `'HOSTING'`)
21
+
22
+ * `Crm` (value: `'CRM'`)
23
+
24
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,35 @@
1
+ # SearchSchoolModel
2
+
3
+ EdTechPro School Information
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **id** | **number** | School ID | [default to undefined]
10
+ **urn** | **string** | URN Number | [default to undefined]
11
+ **dfe** | **string** | DFE Code | [default to undefined]
12
+ **name** | **string** | School Name | [default to undefined]
13
+ **phaseOfEducation** | **string** | Phase of Education | [default to undefined]
14
+ **text** | **string** | Text Display | [default to undefined]
15
+ **mis** | **string** | MIS | [default to undefined]
16
+ **address** | **string** | Address | [default to undefined]
17
+
18
+ ## Example
19
+
20
+ ```typescript
21
+ import { SearchSchoolModel } from 'yellowgrid-api-ts';
22
+
23
+ const instance: SearchSchoolModel = {
24
+ id,
25
+ urn,
26
+ dfe,
27
+ name,
28
+ phaseOfEducation,
29
+ text,
30
+ mis,
31
+ address,
32
+ };
33
+ ```
34
+
35
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,21 @@
1
+ # SerialNumberRequestModel
2
+
3
+ Serial Number Request
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **serialNumber** | **string** | Serial Number | [default to undefined]
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import { SerialNumberRequestModel } from 'yellowgrid-api-ts';
15
+
16
+ const instance: SerialNumberRequestModel = {
17
+ serialNumber,
18
+ };
19
+ ```
20
+
21
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
package/docs/SeriesDTO.md CHANGED
@@ -6,10 +6,10 @@ Graph Series Data
6
6
 
7
7
  Name | Type | Description | Notes
8
8
  ------------ | ------------- | ------------- | -------------
9
- **name** | **string** | Name | [optional] [default to undefined]
10
- **type** | **string** | Type | [optional] [default to undefined]
9
+ **name** | **string** | Name | [default to undefined]
10
+ **type** | **string** | Type | [default to undefined]
11
11
  **stack** | **string** | Stack | [optional] [default to undefined]
12
- **data** | **Array<string>** | Data | [optional] [default to undefined]
12
+ **data** | **Array<string>** | Data | [default to undefined]
13
13
 
14
14
  ## Example
15
15
 
@@ -0,0 +1,42 @@
1
+ # Service
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **createdDate** | **string** | | [optional] [default to undefined]
9
+ **id** | **number** | | [optional] [default to undefined]
10
+ **servicePlanId** | **number** | | [optional] [default to undefined]
11
+ **servicePlan** | [**ServicePlan**](ServicePlan.md) | | [optional] [default to undefined]
12
+ **baseServiceId** | **number** | | [optional] [default to undefined]
13
+ **baseService** | [**BaseService**](BaseService.md) | | [optional] [default to undefined]
14
+ **customerRate** | [**CustomerRate**](CustomerRate.md) | | [optional] [default to undefined]
15
+ **description** | **string** | | [optional] [default to undefined]
16
+ **hideOnInvoice** | **boolean** | | [optional] [default to undefined]
17
+ **bureauRate** | **string** | | [optional] [default to undefined]
18
+ **filePeriod** | **string** | | [optional] [default to undefined]
19
+ **common** | **boolean** | | [optional] [default to undefined]
20
+
21
+ ## Example
22
+
23
+ ```typescript
24
+ import { Service } from 'yellowgrid-api-ts';
25
+
26
+ const instance: Service = {
27
+ createdDate,
28
+ id,
29
+ servicePlanId,
30
+ servicePlan,
31
+ baseServiceId,
32
+ baseService,
33
+ customerRate,
34
+ description,
35
+ hideOnInvoice,
36
+ bureauRate,
37
+ filePeriod,
38
+ common,
39
+ };
40
+ ```
41
+
42
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -6,8 +6,8 @@ Service Health DTO
6
6
 
7
7
  Name | Type | Description | Notes
8
8
  ------------ | ------------- | ------------- | -------------
9
- **services** | [**Array<ServiceStatusDTO>**](ServiceStatusDTO.md) | | [optional] [default to undefined]
10
- **globalStatus** | **number** | | [optional] [default to undefined]
9
+ **services** | [**Array<ServiceStatusDTO>**](ServiceStatusDTO.md) | | [default to undefined]
10
+ **globalStatus** | **number** | | [default to undefined]
11
11
 
12
12
  ## Example
13
13
 
@@ -0,0 +1,36 @@
1
+ # ServicePlan
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **createdDate** | **string** | | [optional] [default to undefined]
9
+ **id** | **number** | | [optional] [default to undefined]
10
+ **name** | **string** | | [default to undefined]
11
+ **services** | [**Array<Service>**](Service.md) | | [optional] [readonly] [default to undefined]
12
+ **filePeriod** | **string** | | [optional] [default to undefined]
13
+ **planGroup** | **string** | | [optional] [default to undefined]
14
+ **connectionTypeId** | **number** | | [optional] [default to undefined]
15
+ **connectionType** | [**ConnectionType**](ConnectionType.md) | | [optional] [default to undefined]
16
+ **closed** | **boolean** | | [optional] [default to undefined]
17
+
18
+ ## Example
19
+
20
+ ```typescript
21
+ import { ServicePlan } from 'yellowgrid-api-ts';
22
+
23
+ const instance: ServicePlan = {
24
+ createdDate,
25
+ id,
26
+ name,
27
+ services,
28
+ filePeriod,
29
+ planGroup,
30
+ connectionTypeId,
31
+ connectionType,
32
+ closed,
33
+ };
34
+ ```
35
+
36
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -6,10 +6,10 @@ Service Status DTO
6
6
 
7
7
  Name | Type | Description | Notes
8
8
  ------------ | ------------- | ------------- | -------------
9
- **statusName** | **string** | Service Status Description | [optional] [default to undefined]
10
- **name** | **string** | Service Name | [optional] [default to undefined]
11
- **status** | **string** | Service Status | [optional] [default to undefined]
12
- **events** | [**Array<EventDTO>**](EventDTO.md) | Service Events | [optional] [default to undefined]
9
+ **statusName** | **string** | Service Status Description | [default to undefined]
10
+ **name** | **string** | Service Name | [default to undefined]
11
+ **status** | **string** | Service Status | [default to undefined]
12
+ **events** | [**Array<EventDTO>**](EventDTO.md) | Service Events | [default to undefined]
13
13
 
14
14
  ## Example
15
15
 
@@ -1,6 +1,6 @@
1
1
  # ServicesApi
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
  |------------- | ------------- | -------------|
@@ -6,17 +6,17 @@ ShipmentAddressEntity
6
6
 
7
7
  Name | Type | Description | Notes
8
8
  ------------ | ------------- | ------------- | -------------
9
- **id** | **number** | id | [optional] [default to undefined]
10
- **shipmentId** | **number** | shipmentId | [optional] [default to undefined]
11
- **shipName** | **string** | shipName | [optional] [default to undefined]
12
- **shipCompany** | **string** | shipCompany | [optional] [default to undefined]
13
- **shipAddress1** | **string** | shipAddress1 | [optional] [default to undefined]
14
- **shipAddress2** | **string** | shipAddress2 | [optional] [default to undefined]
15
- **shipCity** | **string** | shipCity | [optional] [default to undefined]
16
- **shipStateRegion** | **string** | shipStateRegion | [optional] [default to undefined]
17
- **shipPostalCode** | **string** | shipPostalCode | [optional] [default to undefined]
18
- **shipCountry** | **string** | shipCountry | [optional] [default to undefined]
19
- **shipPhoneNumber** | **string** | shipPhoneNumber | [optional] [default to undefined]
9
+ **id** | **number** | id | [default to undefined]
10
+ **shipmentId** | **number** | shipmentId | [default to undefined]
11
+ **shipName** | **string** | shipName | [default to undefined]
12
+ **shipCompany** | **string** | shipCompany | [default to undefined]
13
+ **shipAddress1** | **string** | shipAddress1 | [default to undefined]
14
+ **shipAddress2** | **string** | shipAddress2 | [default to undefined]
15
+ **shipCity** | **string** | shipCity | [default to undefined]
16
+ **shipStateRegion** | **string** | shipStateRegion | [default to undefined]
17
+ **shipPostalCode** | **string** | shipPostalCode | [default to undefined]
18
+ **shipCountry** | **string** | shipCountry | [default to undefined]
19
+ **shipPhoneNumber** | **string** | shipPhoneNumber | [default to undefined]
20
20
 
21
21
  ## Example
22
22
 
@@ -12,10 +12,10 @@ Name | Type | Description | Notes
12
12
  **reference** | **string** | Courier Reference | [optional] [default to undefined]
13
13
  **tracking** | **string** | Courier Tracking | [optional] [default to undefined]
14
14
  **trackingUrl** | **string** | Courier Tracking URL | [optional] [default to undefined]
15
- **requestedDate** | **string** | Date Time | [optional] [default to undefined]
16
- **scannedItems** | [**Array<ScannedItemModel>**](ScannedItemModel.md) | Scanned Items | [optional] [default to undefined]
17
- **items** | [**Array<ShipmentItemModel>**](ShipmentItemModel.md) | Items | [optional] [default to undefined]
18
- **address** | [**AddressModel**](AddressModel.md) | | [optional] [default to undefined]
15
+ **requestedDate** | **string** | Date Time | [default to undefined]
16
+ **scannedItems** | [**Array<ScannedItemModel>**](ScannedItemModel.md) | Scanned Items | [default to undefined]
17
+ **items** | [**Array<ShipmentItemModel>**](ShipmentItemModel.md) | Items | [default to undefined]
18
+ **address** | [**AddressModel**](AddressModel.md) | | [default to undefined]
19
19
  **boxes** | **number** | Boxes Shipped | [optional] [default to undefined]
20
20
 
21
21
  ## Example
@@ -6,18 +6,18 @@ ShipmentsEntity
6
6
 
7
7
  Name | Type | Description | Notes
8
8
  ------------ | ------------- | ------------- | -------------
9
- **id** | **number** | id | [optional] [default to undefined]
10
- **batchId** | **number** | batchId | [optional] [default to undefined]
11
- **courier** | **string** | courier | [optional] [default to undefined]
12
- **courierService** | **string** | courierService | [optional] [default to undefined]
13
- **courierServiceDesc** | **string** | courierServiceDesc | [optional] [default to undefined]
14
- **courierReference** | **string** | courierReference | [optional] [default to undefined]
15
- **courierTracking** | **string** | courierTracking | [optional] [default to undefined]
16
- **courierBoxes** | **number** | courierBoxes | [optional] [default to undefined]
17
- **scannedData** | **string** | mac | [optional] [default to undefined]
18
- **dateShipped** | **string** | date | [optional] [default to undefined]
19
- **requestDate** | **string** | requestDate | [optional] [default to undefined]
20
- **provId** | **number** | provId | [optional] [default to undefined]
9
+ **id** | **number** | id | [default to undefined]
10
+ **batchId** | **number** | batchId | [default to undefined]
11
+ **courier** | **string** | courier | [default to undefined]
12
+ **courierService** | **string** | courierService | [default to undefined]
13
+ **courierServiceDesc** | **string** | courierServiceDesc | [default to undefined]
14
+ **courierReference** | **string** | courierReference | [default to undefined]
15
+ **courierTracking** | **string** | courierTracking | [default to undefined]
16
+ **courierBoxes** | **number** | courierBoxes | [default to undefined]
17
+ **scannedData** | **string** | mac | [default to undefined]
18
+ **dateShipped** | **string** | date | [default to undefined]
19
+ **requestDate** | **string** | requestDate | [default to undefined]
20
+ **provId** | **number** | provId | [default to undefined]
21
21
 
22
22
  ## Example
23
23
 
@@ -6,8 +6,8 @@ Shipment Item
6
6
 
7
7
  Name | Type | Description | Notes
8
8
  ------------ | ------------- | ------------- | -------------
9
- **itemId** | **number** | Item ID | [optional] [default to undefined]
10
- **quantity** | **number** | Quantity | [optional] [default to undefined]
9
+ **itemId** | **number** | Item ID | [default to undefined]
10
+ **quantity** | **number** | Quantity | [default to undefined]
11
11
 
12
12
  ## Example
13
13
 
@@ -6,11 +6,11 @@ ShipmentItemsEntity
6
6
 
7
7
  Name | Type | Description | Notes
8
8
  ------------ | ------------- | ------------- | -------------
9
- **id** | **number** | id | [optional] [default to undefined]
10
- **shipmentId** | **number** | shipmentId | [optional] [default to undefined]
11
- **batchId** | **number** | batchId | [optional] [default to undefined]
12
- **quantity** | **number** | quantity | [optional] [default to undefined]
13
- **itemId** | **number** | item | [optional] [default to undefined]
9
+ **id** | **number** | id | [default to undefined]
10
+ **shipmentId** | **number** | shipmentId | [default to undefined]
11
+ **batchId** | **number** | batchId | [default to undefined]
12
+ **quantity** | **number** | quantity | [default to undefined]
13
+ **itemId** | **number** | item | [default to undefined]
14
14
 
15
15
  ## Example
16
16
 
@@ -6,11 +6,11 @@ Shipment Item
6
6
 
7
7
  Name | Type | Description | Notes
8
8
  ------------ | ------------- | ------------- | -------------
9
- **id** | **number** | id | [optional] [default to undefined]
10
- **shipmentId** | **number** | shipmentId | [optional] [default to undefined]
11
- **batchId** | **number** | batchId | [optional] [default to undefined]
12
- **quantity** | **number** | quantity | [optional] [default to undefined]
13
- **itemId** | **number** | item | [optional] [default to undefined]
9
+ **id** | **number** | id | [default to undefined]
10
+ **shipmentId** | **number** | shipmentId | [default to undefined]
11
+ **batchId** | **number** | batchId | [default to undefined]
12
+ **quantity** | **number** | quantity | [default to undefined]
13
+ **itemId** | **number** | item | [default to undefined]
14
14
 
15
15
  ## Example
16
16
 
@@ -6,18 +6,18 @@ Shipment
6
6
 
7
7
  Name | Type | Description | Notes
8
8
  ------------ | ------------- | ------------- | -------------
9
- **id** | **number** | id | [optional] [default to undefined]
10
- **batchId** | **number** | batchId | [optional] [default to undefined]
11
- **courier** | **string** | courier | [optional] [default to undefined]
12
- **courierService** | **string** | courierService | [optional] [default to undefined]
13
- **courierServiceDesc** | **string** | courierServiceDesc | [optional] [default to undefined]
14
- **courierReference** | **string** | courierReference | [optional] [default to undefined]
15
- **courierTracking** | **string** | courierTracking | [optional] [default to undefined]
16
- **courierBoxes** | **number** | courierBoxes | [optional] [default to undefined]
17
- **scannedData** | **string** | mac | [optional] [default to undefined]
18
- **dateShipped** | **string** | date | [optional] [default to undefined]
19
- **requestDate** | **string** | requestDate | [optional] [default to undefined]
20
- **provId** | **number** | provId | [optional] [default to undefined]
9
+ **id** | **number** | id | [default to undefined]
10
+ **batchId** | **number** | batchId | [default to undefined]
11
+ **courier** | **string** | courier | [default to undefined]
12
+ **courierService** | **string** | courierService | [default to undefined]
13
+ **courierServiceDesc** | **string** | courierServiceDesc | [default to undefined]
14
+ **courierReference** | **string** | courierReference | [default to undefined]
15
+ **courierTracking** | **string** | courierTracking | [default to undefined]
16
+ **courierBoxes** | **number** | courierBoxes | [default to undefined]
17
+ **scannedData** | **string** | mac | [default to undefined]
18
+ **dateShipped** | **string** | date | [default to undefined]
19
+ **requestDate** | **string** | requestDate | [default to undefined]
20
+ **provId** | **number** | provId | [default to undefined]
21
21
 
22
22
  ## Example
23
23
 
@@ -6,12 +6,12 @@ Shipment Request
6
6
 
7
7
  Name | Type | Description | Notes
8
8
  ------------ | ------------- | ------------- | -------------
9
- **courier** | **string** | Courier | [optional] [default to undefined]
9
+ **courier** | **string** | Courier | [default to undefined]
10
10
  **address** | [**AddressModel**](AddressModel.md) | Address | [optional] [default to undefined]
11
- **scannedLines** | **Array<string>** | Scanned Lines | [optional] [default to undefined]
12
- **service** | **string** | Service | [optional] [default to undefined]
11
+ **scannedLines** | **Array<string>** | Scanned Lines | [default to undefined]
12
+ **service** | **string** | Service | [default to undefined]
13
13
  **shipDate** | **string** | Ship Date | [optional] [default to undefined]
14
- **items** | [**Array<ShipmentItemDTO>**](ShipmentItemDTO.md) | Items | [optional] [default to undefined]
14
+ **items** | [**Array<ShipmentItemDTO>**](ShipmentItemDTO.md) | Items | [default to undefined]
15
15
 
16
16
  ## Example
17
17
 
@@ -1,10 +1,11 @@
1
1
  # ShippingApi
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
7
  |[**postGetAdminShippingServices**](#postgetadminshippingservices) | **POST** /admin/shipping/services | Get Shipping Services|
8
+ |[**postGetCollectionDates**](#postgetcollectiondates) | **POST** /shipping/collections/dates | |
8
9
  |[**postGetShippingServices**](#postgetshippingservices) | **POST** /shipping/services | Get Shipping Services|
9
10
 
10
11
  # **postGetAdminShippingServices**
@@ -65,6 +66,61 @@ No authorization required
65
66
 
66
67
  [[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)
67
68
 
69
+ # **postGetCollectionDates**
70
+ > Array<CollectionDateDTO> postGetCollectionDates()
71
+
72
+ Get Collection Dates
73
+
74
+ ### Example
75
+
76
+ ```typescript
77
+ import {
78
+ ShippingApi,
79
+ Configuration,
80
+ CollectionDatesRequestDTO
81
+ } from 'yellowgrid-api-ts';
82
+
83
+ const configuration = new Configuration();
84
+ const apiInstance = new ShippingApi(configuration);
85
+
86
+ let collectionDatesRequestDTO: CollectionDatesRequestDTO; //Collection Dates Request (optional)
87
+
88
+ const { status, data } = await apiInstance.postGetCollectionDates(
89
+ collectionDatesRequestDTO
90
+ );
91
+ ```
92
+
93
+ ### Parameters
94
+
95
+ |Name | Type | Description | Notes|
96
+ |------------- | ------------- | ------------- | -------------|
97
+ | **collectionDatesRequestDTO** | **CollectionDatesRequestDTO**| Collection Dates Request | |
98
+
99
+
100
+ ### Return type
101
+
102
+ **Array<CollectionDateDTO>**
103
+
104
+ ### Authorization
105
+
106
+ No authorization required
107
+
108
+ ### HTTP request headers
109
+
110
+ - **Content-Type**: application/json
111
+ - **Accept**: application/json
112
+
113
+
114
+ ### HTTP response details
115
+ | Status code | Description | Response headers |
116
+ |-------------|-------------|------------------|
117
+ |**200** | Collection Dates | - |
118
+ |**400** | Bad Request | - |
119
+ |**401** | Unauthorised | - |
120
+ |**403** | Access Denied | - |
121
+
122
+ [[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)
123
+
68
124
  # **postGetShippingServices**
69
125
  > ShippingServicesModel postGetShippingServices()
70
126
 
@@ -5,10 +5,10 @@
5
5
 
6
6
  Name | Type | Description | Notes
7
7
  ------------ | ------------- | ------------- | -------------
8
- **service** | [**ShippingServiceModel**](ShippingServiceModel.md) | | [optional] [default to undefined]
9
- **id** | **string** | ID/Number | [optional] [default to undefined]
10
- **trackingNumber** | **string** | Tracking Number | [optional] [default to undefined]
11
- **parcelIds** | **Array&lt;string&gt;** | Parcels | [optional] [default to undefined]
8
+ **service** | [**ShippingServiceModel**](ShippingServiceModel.md) | | [default to undefined]
9
+ **id** | **string** | ID/Number | [default to undefined]
10
+ **trackingNumber** | **string** | Tracking Number | [default to undefined]
11
+ **parcelIds** | **Array&lt;string&gt;** | Parcels | [default to undefined]
12
12
 
13
13
  ## Example
14
14
 
@@ -6,9 +6,9 @@ Shipping Information
6
6
 
7
7
  Name | Type | Description | Notes
8
8
  ------------ | ------------- | ------------- | -------------
9
- **items** | [**Array&lt;BasicItemDTO&gt;**](BasicItemDTO.md) | Items | [optional] [default to undefined]
10
- **postalCode** | **string** | Destination Post Code | [optional] [default to undefined]
11
- **iso** | **string** | Destination ISO | [optional] [default to undefined]
9
+ **items** | [**Array&lt;BasicItemDTO&gt;**](BasicItemDTO.md) | Items | [default to undefined]
10
+ **postalCode** | **string** | Destination Post Code | [default to undefined]
11
+ **iso** | **string** | Destination ISO | [default to undefined]
12
12
 
13
13
  ## Example
14
14
 
@@ -5,9 +5,9 @@
5
5
 
6
6
  Name | Type | Description | Notes
7
7
  ------------ | ------------- | ------------- | -------------
8
- **courier** | **string** | Courier | [optional] [default to undefined]
9
- **service** | **string** | Courier Service | [optional] [default to undefined]
10
- **boxes** | **number** | Boxes | [optional] [default to undefined]
8
+ **courier** | **string** | Courier | [default to undefined]
9
+ **service** | **string** | Courier Service | [default to undefined]
10
+ **boxes** | **number** | Boxes | [default to undefined]
11
11
  **printer** | **number** | Printer | [optional] [default to undefined]
12
12
  **shipment** | [**ShipmentRequestDTO**](ShipmentRequestDTO.md) | | [optional] [default to undefined]
13
13
 
@@ -6,8 +6,8 @@ Shipping Service
6
6
 
7
7
  Name | Type | Description | Notes
8
8
  ------------ | ------------- | ------------- | -------------
9
- **courier** | **string** | Courier | [optional] [default to undefined]
10
- **serviceName** | **string** | Service Name | [optional] [default to undefined]
9
+ **courier** | **string** | Courier | [default to undefined]
10
+ **serviceName** | **string** | Service Name | [default to undefined]
11
11
 
12
12
  ## Example
13
13
 
@@ -6,10 +6,10 @@ Shipping Service
6
6
 
7
7
  Name | Type | Description | Notes
8
8
  ------------ | ------------- | ------------- | -------------
9
- **courier** | **string** | Courier | [optional] [default to undefined]
10
- **code** | **string** | Code | [optional] [default to undefined]
11
- **name** | **string** | Name | [optional] [default to undefined]
12
- **description** | **string** | Description | [optional] [default to undefined]
9
+ **courier** | **string** | Courier | [default to undefined]
10
+ **code** | **string** | Code | [default to undefined]
11
+ **name** | **string** | Name | [default to undefined]
12
+ **description** | **string** | Description | [default to undefined]
13
13
  **label** | **string** | Label | [optional] [default to undefined]
14
14
  **price** | **number** | Price | [optional] [default to undefined]
15
15
 
@@ -5,7 +5,7 @@
5
5
 
6
6
  Name | Type | Description | Notes
7
7
  ------------ | ------------- | ------------- | -------------
8
- **services** | [**Array&lt;ShippingServiceModel&gt;**](ShippingServiceModel.md) | Services | [optional] [default to undefined]
8
+ **services** | [**Array&lt;ShippingServiceModel&gt;**](ShippingServiceModel.md) | Services | [default to undefined]
9
9
 
10
10
  ## Example
11
11
 
@@ -6,11 +6,11 @@ Change Response
6
6
 
7
7
  Name | Type | Description | Notes
8
8
  ------------ | ------------- | ------------- | -------------
9
- **changeId** | **string** | ID | [optional] [default to undefined]
10
- **trunk** | [**SipTrunkEntity**](SipTrunkEntity.md) | | [optional] [default to undefined]
11
- **type** | **string** | Type | [optional] [default to undefined]
12
- **progress** | **number** | Progress | [optional] [default to undefined]
13
- **provider** | **number** | Service Provider | [optional] [default to undefined]
9
+ **changeId** | **string** | ID | [default to undefined]
10
+ **trunk** | [**SipTrunkEntity**](SipTrunkEntity.md) | | [default to undefined]
11
+ **type** | **string** | Type | [default to undefined]
12
+ **progress** | **number** | Progress | [default to undefined]
13
+ **provider** | **number** | Service Provider | [default to undefined]
14
14
 
15
15
  ## Example
16
16