yellowgrid-api-ts 3.2.262 → 3.2.264-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 (372) hide show
  1. package/.openapi-generator/FILES +418 -365
  2. package/.openapi-generator/VERSION +1 -1
  3. package/README.md +116 -3
  4. package/api.ts +9158 -3176
  5. package/base.ts +2 -2
  6. package/common.ts +3 -3
  7. package/config.json +4 -4
  8. package/configuration.ts +1 -1
  9. package/dist/api.d.ts +11799 -8220
  10. package/dist/api.js +14316 -9051
  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/AgentEnum.d.ts +48 -0
  20. package/dist/models/AgentEnum.js +50 -0
  21. package/dist/models/CategoryEnum.d.ts +108 -0
  22. package/dist/models/CategoryEnum.js +110 -0
  23. package/dist/models/ConnectionTypeEnum.d.ts +17 -7
  24. package/dist/models/ConnectionTypeEnum.js +17 -7
  25. package/dist/models/ReasonEnum.d.ts +18 -0
  26. package/dist/models/ReasonEnum.js +20 -0
  27. package/dist/models/ReportEnum.d.ts +11 -1
  28. package/dist/models/ReportEnum.js +11 -1
  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 +33 -0
  38. package/dist/models/RmaStatusEnum.js +35 -0
  39. package/docs/AbstractOrderRequestDTO.md +4 -4
  40. package/docs/AccountAddressesDTO.md +3 -3
  41. package/docs/AccountContactEntity.md +13 -13
  42. package/docs/AccountContactModel.md +13 -13
  43. package/docs/AccountContactRequestModel.md +9 -9
  44. package/docs/AccountDetailedSummaryDTO.md +11 -9
  45. package/docs/AccountFinanceDTO.md +10 -10
  46. package/docs/AccountRequestModel.md +11 -11
  47. package/docs/AccountSummaryDTO.md +3 -3
  48. package/docs/AccountsApi.md +159 -1
  49. package/docs/AccountsResponseModel.md +4 -4
  50. package/docs/AddressDTO.md +12 -6
  51. package/docs/AddressModel.md +5 -5
  52. package/docs/AddressRequestModel.md +4 -4
  53. package/docs/AdminCustomerRmasModel.md +27 -0
  54. package/docs/AdminNumberPortDTO.md +7 -7
  55. package/docs/AdminOrderRequestDTO.md +4 -4
  56. package/docs/AdminRmaDTO.md +67 -0
  57. package/docs/AdminRmaItemDTO.md +51 -0
  58. package/docs/AdminRmaNoteDTO.md +27 -0
  59. package/docs/AdminRmaSummaryDTO.md +39 -0
  60. package/docs/AdminUserModel.md +7 -5
  61. package/docs/AgentHoursGraphModel.md +4 -4
  62. package/docs/AgentHoursGraphMonthModel.md +2 -2
  63. package/docs/ApiLogEntity.md +12 -12
  64. package/docs/AreaCodeModel.md +2 -2
  65. package/docs/AttachmentModel.md +5 -5
  66. package/docs/AttributeSetEnum.md +2 -2
  67. package/docs/AuditLogEntity.md +9 -9
  68. package/docs/AuthCodeResponseModel.md +1 -1
  69. package/docs/AxisDataDTO.md +1 -1
  70. package/docs/BasicItemDTO.md +2 -2
  71. package/docs/BasicProductDTO.md +2 -2
  72. package/docs/BatchDTO.md +17 -17
  73. package/docs/BatchEntity.md +17 -17
  74. package/docs/BillingApi.md +65 -7
  75. package/docs/BrandedVideoSummaryDTO.md +47 -0
  76. package/docs/BrandedVideosApi.md +424 -0
  77. package/docs/BrandedVideosSummariesModel.md +27 -0
  78. package/docs/CRMApi.md +60 -1
  79. package/docs/CallBarringModel.md +5 -5
  80. package/docs/CallJournalRequestModel.md +35 -0
  81. package/docs/Class3CXApi.md +49 -1
  82. package/docs/Class3CXInstallationWizardApi.md +385 -1
  83. package/docs/Class3CXInstallationsApi.md +1 -1
  84. package/docs/Class3CXIntegrationsApi.md +53 -1
  85. package/docs/Class3CXMultiTenantApi.md +1 -1
  86. package/docs/ClientDetailsModel.md +7 -7
  87. package/docs/ClientModel.md +4 -4
  88. package/docs/CollectionDateDTO.md +27 -0
  89. package/docs/CollectionDatesRequestDTO.md +23 -0
  90. package/docs/CompanyContractModel.md +5 -5
  91. package/docs/ContactInfoModel.md +5 -5
  92. package/docs/ConversationModel.md +8 -8
  93. package/docs/CourierPriceEntity.md +10 -10
  94. package/docs/CreditAccountEntity.md +25 -23
  95. package/docs/CreditNoteDTO.md +5 -1
  96. package/docs/CreditNoteEntity.md +5 -5
  97. package/docs/CreditNoteItemDTO.md +3 -1
  98. package/docs/CreditNoteItemEntity.md +7 -5
  99. package/docs/CreditNoteItemModel.md +7 -5
  100. package/docs/CreditNoteModel.md +5 -5
  101. package/docs/CrmActivitiesResponseDTO.md +2 -2
  102. package/docs/CrmActivityDTO.md +11 -3
  103. package/docs/CrmContactDTO.md +7 -7
  104. package/docs/CrmDateActivitiesDTO.md +1 -1
  105. package/docs/CrmNoteEntity.md +10 -10
  106. package/docs/CrmNoteModel.md +10 -10
  107. package/docs/CustomerCoordinatesDTO.md +5 -5
  108. package/docs/CustomerInformationModel.md +4 -4
  109. package/docs/CustomerItemRequestDTO.md +4 -2
  110. package/docs/CustomerListAccountDTO.md +13 -13
  111. package/docs/CustomerOrderRequestDTO.md +4 -4
  112. package/docs/CustomerPriceListEnum.md +2 -2
  113. package/docs/CustomerRmasModel.md +27 -0
  114. package/docs/CustomerSummaryReportDTO.md +6 -6
  115. package/docs/DdiRangeRequestModel.md +3 -3
  116. package/docs/DdiRangesRequestModel.md +1 -1
  117. package/docs/DetailedItemRequestDTO.md +4 -2
  118. package/docs/DetailedOrderRequestDTO.md +4 -4
  119. package/docs/DeviceModel.md +25 -0
  120. package/docs/DivertRequestModel.md +1 -1
  121. package/docs/DivertResponseModel.md +2 -2
  122. package/docs/EdTechProClientEntity.md +4 -4
  123. package/docs/EdTechProSchoolModel.md +11 -11
  124. package/docs/EdTechProSchoolsModel.md +4 -4
  125. package/docs/EdTechProSetupModel.md +5 -5
  126. package/docs/{PostSplitOrderRequest.md → EmailRequestModel.md} +6 -5
  127. package/docs/EngineeredWizardRequestModel.md +25 -0
  128. package/docs/EventDTO.md +8 -8
  129. package/docs/EventRequestDTO.md +3 -3
  130. package/docs/EventSubscriptionModel.md +2 -2
  131. package/docs/EventUpdateDTO.md +4 -4
  132. package/docs/EventUpdateEntity.md +5 -5
  133. package/docs/EventUpdateRequestDTO.md +3 -3
  134. package/docs/ExpiringKeyDTO.md +5 -5
  135. package/docs/FraudManagementModel.md +2 -2
  136. package/docs/FreshdeskCompanyTicketsModel.md +4 -4
  137. package/docs/FreshdeskTicketEntity.md +6 -6
  138. package/docs/FtpAccountsEntity.md +5 -5
  139. package/docs/GenericFileModel.md +3 -3
  140. package/docs/GetGetTcxHostingPriceList200Response.md +20 -0
  141. package/docs/GraphDTO.md +6 -6
  142. package/docs/HostingChangeResponseModel.md +5 -5
  143. package/docs/HostingRegionDTO.md +3 -3
  144. package/docs/InstallationDetailsDTO.md +3 -3
  145. package/docs/InstanceAutoFailoverEntity.md +5 -5
  146. package/docs/InstanceDeletionScheduleEntity.md +4 -4
  147. package/docs/InstanceEntity.md +21 -21
  148. package/docs/InstanceFailoverEntity.md +11 -11
  149. package/docs/InstanceMonitoringEntity.md +3 -3
  150. package/docs/InstanceMonitoringLogEntity.md +6 -6
  151. package/docs/InstanceScheduledTasksEntity.md +6 -6
  152. package/docs/InstanceTcxDetailsEntity.md +10 -10
  153. package/docs/InstanceUserCredentialsEntity.md +5 -5
  154. package/docs/ItemDTO.md +2 -2
  155. package/docs/ItemDiscountEntity.md +6 -6
  156. package/docs/ItemEntity.md +21 -21
  157. package/docs/ItemResolutionRequestModel.md +21 -0
  158. package/docs/LinkedOrderEntity.md +2 -2
  159. package/docs/MFARequiredModel.md +2 -2
  160. package/docs/MacAddressDTO.md +2 -2
  161. package/docs/MacAddressRequestModel.md +21 -0
  162. package/docs/MiscApi.md +1 -1
  163. package/docs/MonthlyUsageModel.md +2 -2
  164. package/docs/MultiTenantChangeResponseModel.md +4 -4
  165. package/docs/MyPBXToolsApi.md +1 -1
  166. package/docs/NameRequestModel.md +21 -0
  167. package/docs/NavigationModel.md +4 -4
  168. package/docs/NoteRequestModel.md +21 -0
  169. package/docs/NumberPortDTO.md +7 -7
  170. package/docs/NumberPortNoteDTO.md +5 -5
  171. package/docs/NumberPortRangeDTO.md +2 -2
  172. package/docs/NumberPortingApi.md +22 -22
  173. package/docs/NumberPortsModel.md +4 -4
  174. package/docs/OAuth20Api.md +5 -5
  175. package/docs/OfflineInstancesEntity.md +5 -5
  176. package/docs/OrderDTO.md +3 -3
  177. package/docs/OrderDetailsDTO.md +14 -10
  178. package/docs/OrderEntity.md +56 -56
  179. package/docs/OrderItemDTO.md +2 -2
  180. package/docs/OrderRequestModel.md +6 -6
  181. package/docs/OrderSummariesModel.md +4 -4
  182. package/docs/OrderSummaryDTO.md +12 -10
  183. package/docs/OrderTotalModel.md +7 -7
  184. package/docs/OrderedItemEntity.md +14 -14
  185. package/docs/OrderedItemModel.md +14 -14
  186. package/docs/OrdersApi.md +119 -6
  187. package/docs/PartnerDTO.md +12 -10
  188. package/docs/PasswordSenderDTO.md +2 -2
  189. package/docs/PasswordSenderEntity.md +7 -7
  190. package/docs/PatchApproveRmaRequest.md +20 -0
  191. package/docs/PortalAccountModel.md +25 -23
  192. package/docs/PortalLoginModel.md +7 -7
  193. package/docs/PostGenerateReport200Response.md +8 -8
  194. package/docs/PriceListItemModel.md +2 -2
  195. package/docs/PricingApi.md +5 -5
  196. package/docs/PrinterEntity.md +5 -5
  197. package/docs/PrizesEntity.md +6 -6
  198. package/docs/ProductDetailedSummaryDTO.md +2 -2
  199. package/docs/ProductPriceListItemModel.md +2 -2
  200. package/docs/{StockProductPriceModel.md → ProductPriceModel.md} +5 -5
  201. package/docs/ProductSearchResultsModel.md +1 -1
  202. package/docs/ProductSerialInfoDTO.md +27 -0
  203. package/docs/ProductSerialInfoModel.md +3 -3
  204. package/docs/ProductSummaryDTO.md +2 -2
  205. package/docs/ProductsApi.md +1 -1
  206. package/docs/PromoCodesEntity.md +13 -13
  207. package/docs/PromoItemModel.md +35 -0
  208. package/docs/PromoItemsEntity.md +8 -8
  209. package/docs/PromoModel.md +45 -0
  210. package/docs/PromoSummariesModel.md +27 -0
  211. package/docs/PromoSummaryDTO.md +31 -0
  212. package/docs/PromotionsApi.md +241 -0
  213. package/docs/ProspectDTO.md +7 -7
  214. package/docs/ProspectEntity.md +11 -11
  215. package/docs/ProspectsApi.md +1 -1
  216. package/docs/ProvisioningApi.md +1 -1
  217. package/docs/ProvisioningModel.md +3 -3
  218. package/docs/ProvisioningRequestEntity.md +3 -3
  219. package/docs/RMAApi.md +1753 -0
  220. package/docs/ReasonRequestModel.md +21 -0
  221. package/docs/RecordingBackupAzureModel.md +4 -4
  222. package/docs/RemoteStorageDTO.md +4 -4
  223. package/docs/ReportRequestDTO.md +1 -1
  224. package/docs/ReportsApi.md +1 -1
  225. package/docs/RequestDTO.md +29 -0
  226. package/docs/ResolutionRequestModel.md +21 -0
  227. package/docs/ResourceNotReadyException.md +3 -3
  228. package/docs/ResponseDTO.md +27 -0
  229. package/docs/RmaCollectionDTO.md +27 -0
  230. package/docs/RmaCreditItemRequestDTO.md +25 -0
  231. package/docs/RmaDTO.md +47 -0
  232. package/docs/RmaItemDTO.md +35 -0
  233. package/docs/RmaItemRequestDTO.md +25 -0
  234. package/docs/RmaOrderDTO.md +33 -0
  235. package/docs/RmaOrderItemDTO.md +37 -0
  236. package/docs/RmaOrderSummaryDTO.md +25 -0
  237. package/docs/RmaReplacementOrderItemDTO.md +23 -0
  238. package/docs/RmaReplacementOrderRequestDTO.md +21 -0
  239. package/docs/RmaRequestDTO.md +36 -0
  240. package/docs/RmaReturnDTO.md +31 -0
  241. package/docs/RmaSummaryDTO.md +31 -0
  242. package/docs/RmaSummaryItemDTO.md +23 -0
  243. package/docs/RootAccessModel.md +3 -3
  244. package/docs/S3BucketEntity.md +4 -4
  245. package/docs/SIPTrunksApi.md +1 -1
  246. package/docs/SMSApi.md +1 -1
  247. package/docs/ScannedItemModel.md +1 -1
  248. package/docs/ScopeModel.md +2 -2
  249. package/docs/SearchSchoolModel.md +35 -0
  250. package/docs/SerialNumberRequestModel.md +21 -0
  251. package/docs/SeriesDTO.md +3 -3
  252. package/docs/ServiceHealthDTO.md +2 -2
  253. package/docs/ServiceStatusDTO.md +4 -4
  254. package/docs/ServicesApi.md +1 -1
  255. package/docs/ShipmentAddressEntity.md +11 -11
  256. package/docs/ShipmentDTO.md +4 -4
  257. package/docs/ShipmentEntity.md +12 -12
  258. package/docs/ShipmentItemDTO.md +2 -2
  259. package/docs/ShipmentItemEntity.md +5 -5
  260. package/docs/ShipmentItemModel.md +5 -5
  261. package/docs/ShipmentModel.md +12 -12
  262. package/docs/ShipmentRequestDTO.md +4 -4
  263. package/docs/ShippingApi.md +57 -1
  264. package/docs/ShippingConsignmentModel.md +4 -4
  265. package/docs/ShippingInformationDTO.md +3 -3
  266. package/docs/ShippingRequestDTO.md +3 -3
  267. package/docs/ShippingServiceDTO.md +2 -2
  268. package/docs/ShippingServiceModel.md +4 -4
  269. package/docs/ShippingServicesModel.md +1 -1
  270. package/docs/SipTrunkChangeResponseModel.md +5 -5
  271. package/docs/SipTrunkCreationRequestModel.md +6 -6
  272. package/docs/SipTrunkEntity.md +12 -12
  273. package/docs/SipTrunksResponseModel.md +4 -4
  274. package/docs/SmsAccountDTO.md +6 -6
  275. package/docs/SmsAccountEntity.md +6 -6
  276. package/docs/SmsAccountRequestDTO.md +5 -5
  277. package/docs/SmsDataModel.md +1 -1
  278. package/docs/SmsMessageModel.md +3 -3
  279. package/docs/SmsNumbersEntity.md +2 -2
  280. package/docs/SmsPayloadModel.md +3 -3
  281. package/docs/SmsPhoneNumberModel.md +1 -1
  282. package/docs/SmsResponseModel.md +3 -3
  283. package/docs/SmsWhitelistEntity.md +2 -2
  284. package/docs/StockManagementApi.md +1 -1
  285. package/docs/StockOrderCourierEntity.md +4 -4
  286. package/docs/StockOrderDeductionModel.md +4 -4
  287. package/docs/StockOrderDeductionRequestModel.md +2 -2
  288. package/docs/StockOrderDeductionsEntity.md +4 -4
  289. package/docs/StockOrderEntity.md +22 -22
  290. package/docs/StockOrderItemEntity.md +7 -7
  291. package/docs/StockOrderItemModel.md +7 -7
  292. package/docs/StockOrderItemRequestModel.md +4 -4
  293. package/docs/StockOrderModel.md +14 -14
  294. package/docs/StockOrderProductEntity.md +6 -6
  295. package/docs/StockOrderRequestModel.md +3 -3
  296. package/docs/StockOrderSupplierEntity.md +9 -9
  297. package/docs/StockOrderSupplierModel.md +9 -9
  298. package/docs/StockOrdersModel.md +4 -4
  299. package/docs/StockProductModel.md +11 -9
  300. package/docs/StockProductSummariesModel.md +4 -4
  301. package/docs/StockProductSummaryModel.md +6 -6
  302. package/docs/StockReportItemModel.md +6 -6
  303. package/docs/StockReportModel.md +5 -5
  304. package/docs/StockTransactionsEntity.md +8 -8
  305. package/docs/SupplierEntity.md +9 -9
  306. package/docs/SupplierItemEntity.md +8 -8
  307. package/docs/SupplierItemModel.md +8 -8
  308. package/docs/SupplierItemsResultsDTO.md +1 -1
  309. package/docs/SupplierModel.md +9 -9
  310. package/docs/SupplierProductDTO.md +43 -0
  311. package/docs/SupplierProductModel.md +3 -3
  312. package/docs/SupplierProductResultsModel.md +4 -4
  313. package/docs/SuppliersApi.md +57 -1
  314. package/docs/SupportTicketModel.md +10 -10
  315. package/docs/SystemApi.md +1 -1
  316. package/docs/TableDTO.md +3 -3
  317. package/docs/TableDataDTO.md +1 -1
  318. package/docs/TableHistoryEntity.md +8 -8
  319. package/docs/TableRowDTO.md +1 -1
  320. package/docs/TcxBackupEntity.md +9 -9
  321. package/docs/TcxBackupModel.md +9 -9
  322. package/docs/TcxBillingEntity.md +10 -10
  323. package/docs/TcxBulkLicenceDetailsModel.md +2 -2
  324. package/docs/TcxDeadLicenceEntity.md +3 -3
  325. package/docs/TcxEngineerTaskDTO.md +29 -0
  326. package/docs/TcxEngineeringDTO.md +37 -0
  327. package/docs/TcxInstallationModel.md +17 -17
  328. package/docs/TcxInstallationsModel.md +4 -4
  329. package/docs/TcxKeySummaryDTO.md +3 -3
  330. package/docs/TcxKeysEntity.md +7 -7
  331. package/docs/TcxLicenceDetailsErrorModel.md +4 -4
  332. package/docs/TcxLicenceDetailsModel.md +11 -11
  333. package/docs/TcxMacsEntity.md +3 -3
  334. package/docs/TcxMultiTenantModel.md +7 -7
  335. package/docs/TcxMultiTenantUserModel.md +3 -3
  336. package/docs/TcxMultiTenantsModel.md +4 -4
  337. package/docs/TcxRemoteStorageModel.md +4 -4
  338. package/docs/TcxSbcDTO.md +7 -7
  339. package/docs/TcxSbcResponseDTO.md +2 -2
  340. package/docs/TcxSetupsModel.md +4 -4
  341. package/docs/TcxSummaryDTO.md +23 -0
  342. package/docs/TcxTemplateXmlEnum.md +2 -2
  343. package/docs/TcxUsersEntity.md +6 -6
  344. package/docs/TcxWizardConfigModel.md +2 -2
  345. package/docs/TcxWizardModel.md +2 -0
  346. package/docs/TechSupportCompanySummaryDTO.md +5 -5
  347. package/docs/ThumbnailDTO.md +25 -0
  348. package/docs/TicketSummaryModel.md +6 -6
  349. package/docs/TicketTimeDTO.md +9 -9
  350. package/docs/TicketsApi.md +11 -11
  351. package/docs/TokenResponseModel.md +3 -3
  352. package/docs/UpgradeOrderResponseModel.md +2 -2
  353. package/docs/UpgradeRequestModel.md +4 -4
  354. package/docs/UserEntity.md +10 -10
  355. package/docs/VideoRequestEntity.md +51 -0
  356. package/docs/WebhooksApi.md +1 -1
  357. package/docs/XeroLogEntity.md +10 -10
  358. package/getEnums.php +31 -31
  359. package/git_push.sh +14 -17
  360. package/index.ts +1 -1
  361. package/models/AgentEnum.ts +49 -0
  362. package/models/CategoryEnum.ts +109 -0
  363. package/models/ConnectionTypeEnum.ts +17 -7
  364. package/models/ReasonEnum.ts +19 -0
  365. package/models/ReportEnum.ts +11 -1
  366. package/models/ResolutionEnum.ts +19 -0
  367. package/models/RmaItemCreditTypeEnum.ts +14 -0
  368. package/models/RmaItemResolutionEnum.ts +29 -0
  369. package/models/RmaItemStatusEnum.ts +19 -0
  370. package/models/RmaStatusEnum.ts +34 -0
  371. package/openapitools.json +1 -1
  372. package/package.json +2 -2
package/docs/CRMApi.md CHANGED
@@ -1,12 +1,13 @@
1
1
  # CRMApi
2
2
 
3
- All URIs are relative to *https://bitbucket.org*
3
+ All URIs are relative to *https://api.local.yellowgrid.co.uk*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
7
7
  |[**getGetCrmActivities**](#getgetcrmactivities) | **GET** /admin/crm/{id}/activities | |
8
8
  |[**getSearchByPhone**](#getsearchbyphone) | **GET** /crm/contact/search | |
9
9
  |[**postCreateCrmNote**](#postcreatecrmnote) | **POST** /admin/crm/{id}/activities/note | |
10
+ |[**postJournalCall**](#postjournalcall) | **POST** /crm/contact/{id}/journal | |
10
11
 
11
12
  # **getGetCrmActivities**
12
13
  > CrmActivitiesResponseDTO getGetCrmActivities()
@@ -173,3 +174,61 @@ No authorization required
173
174
 
174
175
  [[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)
175
176
 
177
+ # **postJournalCall**
178
+ > CrmActivityDTO postJournalCall()
179
+
180
+ Journal a phone call
181
+
182
+ ### Example
183
+
184
+ ```typescript
185
+ import {
186
+ CRMApi,
187
+ Configuration,
188
+ CallJournalRequestModel
189
+ } from 'yellowgrid-api-ts';
190
+
191
+ const configuration = new Configuration();
192
+ const apiInstance = new CRMApi(configuration);
193
+
194
+ let id: number; //Contact ID (default to undefined)
195
+ let callJournalRequestModel: CallJournalRequestModel; //Journal Call Request (optional)
196
+
197
+ const { status, data } = await apiInstance.postJournalCall(
198
+ id,
199
+ callJournalRequestModel
200
+ );
201
+ ```
202
+
203
+ ### Parameters
204
+
205
+ |Name | Type | Description | Notes|
206
+ |------------- | ------------- | ------------- | -------------|
207
+ | **callJournalRequestModel** | **CallJournalRequestModel**| Journal Call Request | |
208
+ | **id** | [**number**] | Contact ID | defaults to undefined|
209
+
210
+
211
+ ### Return type
212
+
213
+ **CrmActivityDTO**
214
+
215
+ ### Authorization
216
+
217
+ No authorization required
218
+
219
+ ### HTTP request headers
220
+
221
+ - **Content-Type**: application/json
222
+ - **Accept**: application/json
223
+
224
+
225
+ ### HTTP response details
226
+ | Status code | Description | Response headers |
227
+ |-------------|-------------|------------------|
228
+ |**200** | CRM Contact | - |
229
+ |**400** | Bad Request | - |
230
+ |**401** | Unauthorised | - |
231
+ |**403** | Access Denied | - |
232
+
233
+ [[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)
234
+
@@ -6,11 +6,11 @@ Call Barring
6
6
 
7
7
  Name | Type | Description | Notes
8
8
  ------------ | ------------- | ------------- | -------------
9
- **blockPremiumCalls** | **boolean** | Block Premium Calls | [optional] [default to true]
10
- **blockMobileCalls** | **boolean** | Block Mobile Calls | [optional] [default to false]
11
- **blockInternationalCalls** | **boolean** | Block International Calls | [optional] [default to false]
12
- **block084Calls** | **boolean** | Block 084 Calls | [optional] [default to false]
13
- **block087Calls** | **boolean** | Block 087 Calls | [optional] [default to false]
9
+ **blockPremiumCalls** | **boolean** | Block Premium Calls | [default to true]
10
+ **blockMobileCalls** | **boolean** | Block Mobile Calls | [default to false]
11
+ **blockInternationalCalls** | **boolean** | Block International Calls | [default to false]
12
+ **block084Calls** | **boolean** | Block 084 Calls | [default to false]
13
+ **block087Calls** | **boolean** | Block 087 Calls | [default to false]
14
14
 
15
15
  ## Example
16
16
 
@@ -0,0 +1,35 @@
1
+ # CallJournalRequestModel
2
+
3
+ Call Journal Request Model
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **userEmail** | **string** | User Email | [default to undefined]
10
+ **note** | **string** | Call Note | [default to undefined]
11
+ **timestamp** | **string** | Call Timestamp | [default to undefined]
12
+ **duration** | **string** | Call Duration | [default to undefined]
13
+ **recordingUrl** | **string** | Call Recording URL | [default to undefined]
14
+ **transcription** | **string** | Call Transcription | [default to undefined]
15
+ **summary** | **string** | Call Summary | [default to undefined]
16
+ **sentiment** | **number** | Call Sentiment | [default to undefined]
17
+
18
+ ## Example
19
+
20
+ ```typescript
21
+ import { CallJournalRequestModel } from 'yellowgrid-api-ts';
22
+
23
+ const instance: CallJournalRequestModel = {
24
+ userEmail,
25
+ note,
26
+ timestamp,
27
+ duration,
28
+ recordingUrl,
29
+ transcription,
30
+ summary,
31
+ sentiment,
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)
@@ -1,9 +1,10 @@
1
1
  # Class3CXApi
2
2
 
3
- All URIs are relative to *https://bitbucket.org*
3
+ All URIs are relative to *https://api.local.yellowgrid.co.uk*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
7
+ |[**getGetCCDevices**](#getgetccdevices) | **GET** /tcx/cc/devices | |
7
8
  |[**getGetLicenceDetails**](#getgetlicencedetails) | **GET** /tcx/licences/details | Get 3CX Licence Details|
8
9
  |[**getGetTcxCreditStatus**](#getgettcxcreditstatus) | **GET** /tcx/admin/credit | Get 3CX Credit Status|
9
10
  |[**getGetTcxExpiringKeys**](#getgettcxexpiringkeys) | **GET** /tcx/admin/keys/expiring | Get 3CX Expiring Keys|
@@ -11,6 +12,53 @@ All URIs are relative to *https://bitbucket.org*
11
12
  |[**getGetTcxPartners**](#getgettcxpartners) | **GET** /tcx/admin/partners | Get 3CX Partners|
12
13
  |[**postGetBulkLicenceDetails**](#postgetbulklicencedetails) | **POST** /tcx/licences/bulk/details | Get bulk 3CX Licence Details|
13
14
 
15
+ # **getGetCCDevices**
16
+ > Array<DeviceModel> getGetCCDevices()
17
+
18
+ Get a list of 3CX call control devices
19
+
20
+ ### Example
21
+
22
+ ```typescript
23
+ import {
24
+ Class3CXApi,
25
+ Configuration
26
+ } from 'yellowgrid-api-ts';
27
+
28
+ const configuration = new Configuration();
29
+ const apiInstance = new Class3CXApi(configuration);
30
+
31
+ const { status, data } = await apiInstance.getGetCCDevices();
32
+ ```
33
+
34
+ ### Parameters
35
+ This endpoint does not have any parameters.
36
+
37
+
38
+ ### Return type
39
+
40
+ **Array<DeviceModel>**
41
+
42
+ ### Authorization
43
+
44
+ No authorization required
45
+
46
+ ### HTTP request headers
47
+
48
+ - **Content-Type**: Not defined
49
+ - **Accept**: application/json
50
+
51
+
52
+ ### HTTP response details
53
+ | Status code | Description | Response headers |
54
+ |-------------|-------------|------------------|
55
+ |**200** | Devices | - |
56
+ |**400** | Bad Request | - |
57
+ |**401** | Unauthorised | - |
58
+ |**403** | Access Denied | - |
59
+
60
+ [[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)
61
+
14
62
  # **getGetLicenceDetails**
15
63
  > TcxLicenceDetailsModel getGetLicenceDetails()
16
64
 
@@ -1,6 +1,6 @@
1
1
  # Class3CXInstallationWizardApi
2
2
 
3
- All URIs are relative to *https://bitbucket.org*
3
+ All URIs are relative to *https://api.local.yellowgrid.co.uk*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
@@ -16,6 +16,7 @@ All URIs are relative to *https://bitbucket.org*
16
16
  |[**getGetHostingRegions**](#getgethostingregions) | **GET** /tcx/wizards/regions | Get 3CX Hosting Regions|
17
17
  |[**getGetInstallStatus**](#getgetinstallstatus) | **GET** /tcx/wizard/build/status | Get 3CX Instance Install Status|
18
18
  |[**getGetInstanceInstallStatus**](#getgetinstanceinstallstatus) | **GET** /tcx/wizards/instances/build/status | Get 3CX Instance Install Status|
19
+ |[**getGetOrderItems**](#getgetorderitems) | **GET** /tcx/wizards/order/items | Get all items on the order linked to this wizard\&#39;s licence key|
19
20
  |[**getGetPbxIpAddress**](#getgetpbxipaddress) | **GET** /tcx/wizards/instances/ip | Get PBX IP Address|
20
21
  |[**getGetSipTrunkTcxWizard**](#getgetsiptrunktcxwizard) | **GET** /tcx/wizards/sip/trunks/{id} | Get SIP Trunk|
21
22
  |[**getGetSipTrunksTcxWizard**](#getgetsiptrunkstcxwizard) | **GET** /tcx/wizards/sip/trunks | Get SIP Trunks|
@@ -24,7 +25,13 @@ All URIs are relative to *https://bitbucket.org*
24
25
  |[**patchAddNumbers**](#patchaddnumbers) | **PATCH** /tcx/wizards/numbers | Update 3CX Installation Wizard Numbers|
25
26
  |[**patchAddPhones**](#patchaddphones) | **PATCH** /tcx/wizards/phones | Update 3CX Installation Wizard Phones|
26
27
  |[**patchAddSbcs**](#patchaddsbcs) | **PATCH** /tcx/wizards/sbcs | Update 3CX Installation Wizard SBCs|
28
+ |[**patchAllocateEngineer**](#patchallocateengineer) | **PATCH** /tcx/wizards/engineering/engineer | |
27
29
  |[**patchGetWizard**](#patchgetwizard) | **PATCH** /tcx/wizards | Update 3CX Installation Wizard|
30
+ |[**patchMarkEngineerTaskAsComplete**](#patchmarkengineertaskascomplete) | **PATCH** /tcx/wizards/engineering/tasks/{task_id}/complete | |
31
+ |[**patchUpdateEngineerTaskNote**](#patchupdateengineertasknote) | **PATCH** /tcx/wizards/engineering/tasks/{task_id}/note | |
32
+ |[**patchUpdateGoLiveDate**](#patchupdategolivedate) | **PATCH** /tcx/wizards/engineering/go_live_date | |
33
+ |[**patchUpdateNote**](#patchupdatenote) | **PATCH** /tcx/wizards/engineering/note | |
34
+ |[**patchUpdateSpec**](#patchupdatespec) | **PATCH** /tcx/wizards/engineering/spec | |
28
35
  |[**postAddExtensions**](#postaddextensions) | **POST** /tcx/wizards/extensions | Add Extensions To 3CX Installation Wizard|
29
36
  |[**postAddNumbers**](#postaddnumbers) | **POST** /tcx/wizards/numbers | Add Numbers To 3CX Installation Wizard|
30
37
  |[**postAddPhones**](#postaddphones) | **POST** /tcx/wizards/phones | Add Phones To 3CX Installation Wizard|
@@ -654,6 +661,53 @@ No authorization required
654
661
 
655
662
  [[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)
656
663
 
664
+ # **getGetOrderItems**
665
+ > Array<ItemEntity> getGetOrderItems()
666
+
667
+ Get all items on the order linked to the wizard licence key
668
+
669
+ ### Example
670
+
671
+ ```typescript
672
+ import {
673
+ Class3CXInstallationWizardApi,
674
+ Configuration
675
+ } from 'yellowgrid-api-ts';
676
+
677
+ const configuration = new Configuration();
678
+ const apiInstance = new Class3CXInstallationWizardApi(configuration);
679
+
680
+ const { status, data } = await apiInstance.getGetOrderItems();
681
+ ```
682
+
683
+ ### Parameters
684
+ This endpoint does not have any parameters.
685
+
686
+
687
+ ### Return type
688
+
689
+ **Array<ItemEntity>**
690
+
691
+ ### Authorization
692
+
693
+ No authorization required
694
+
695
+ ### HTTP request headers
696
+
697
+ - **Content-Type**: Not defined
698
+ - **Accept**: application/json
699
+
700
+
701
+ ### HTTP response details
702
+ | Status code | Description | Response headers |
703
+ |-------------|-------------|------------------|
704
+ |**200** | Order Items | - |
705
+ |**400** | Bad Request | - |
706
+ |**401** | Unauthorised | - |
707
+ |**403** | Access Denied | - |
708
+
709
+ [[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)
710
+
657
711
  # **getGetPbxIpAddress**
658
712
  > string getGetPbxIpAddress()
659
713
 
@@ -1079,6 +1133,60 @@ No authorization required
1079
1133
 
1080
1134
  [[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)
1081
1135
 
1136
+ # **patchAllocateEngineer**
1137
+ > patchAllocateEngineer()
1138
+
1139
+ Allocate Wizard Engineer
1140
+
1141
+ ### Example
1142
+
1143
+ ```typescript
1144
+ import {
1145
+ Class3CXInstallationWizardApi,
1146
+ Configuration
1147
+ } from 'yellowgrid-api-ts';
1148
+
1149
+ const configuration = new Configuration();
1150
+ const apiInstance = new Class3CXInstallationWizardApi(configuration);
1151
+
1152
+ let engineerId: number; //Engineer ID (default to undefined)
1153
+
1154
+ const { status, data } = await apiInstance.patchAllocateEngineer(
1155
+ engineerId
1156
+ );
1157
+ ```
1158
+
1159
+ ### Parameters
1160
+
1161
+ |Name | Type | Description | Notes|
1162
+ |------------- | ------------- | ------------- | -------------|
1163
+ | **engineerId** | [**number**] | Engineer ID | defaults to undefined|
1164
+
1165
+
1166
+ ### Return type
1167
+
1168
+ void (empty response body)
1169
+
1170
+ ### Authorization
1171
+
1172
+ No authorization required
1173
+
1174
+ ### HTTP request headers
1175
+
1176
+ - **Content-Type**: Not defined
1177
+ - **Accept**: Not defined
1178
+
1179
+
1180
+ ### HTTP response details
1181
+ | Status code | Description | Response headers |
1182
+ |-------------|-------------|------------------|
1183
+ |**204** | No Response | - |
1184
+ |**400** | Bad Request | - |
1185
+ |**401** | Unauthorised | - |
1186
+ |**403** | Access Denied | - |
1187
+
1188
+ [[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)
1189
+
1082
1190
  # **patchGetWizard**
1083
1191
  > TcxWizardModel patchGetWizard()
1084
1192
 
@@ -1134,6 +1242,282 @@ No authorization required
1134
1242
 
1135
1243
  [[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)
1136
1244
 
1245
+ # **patchMarkEngineerTaskAsComplete**
1246
+ > patchMarkEngineerTaskAsComplete()
1247
+
1248
+ Update Wizard Engineer Task Complete Status
1249
+
1250
+ ### Example
1251
+
1252
+ ```typescript
1253
+ import {
1254
+ Class3CXInstallationWizardApi,
1255
+ Configuration
1256
+ } from 'yellowgrid-api-ts';
1257
+
1258
+ const configuration = new Configuration();
1259
+ const apiInstance = new Class3CXInstallationWizardApi(configuration);
1260
+
1261
+ let taskId: number; //Task ID (default to undefined)
1262
+ let complete: 'true' | 'false'; //Complete Status (default to undefined)
1263
+
1264
+ const { status, data } = await apiInstance.patchMarkEngineerTaskAsComplete(
1265
+ taskId,
1266
+ complete
1267
+ );
1268
+ ```
1269
+
1270
+ ### Parameters
1271
+
1272
+ |Name | Type | Description | Notes|
1273
+ |------------- | ------------- | ------------- | -------------|
1274
+ | **taskId** | [**number**] | Task ID | defaults to undefined|
1275
+ | **complete** | [**&#39;true&#39; | &#39;false&#39;**]**Array<&#39;true&#39; &#124; &#39;false&#39;>** | Complete Status | defaults to undefined|
1276
+
1277
+
1278
+ ### Return type
1279
+
1280
+ void (empty response body)
1281
+
1282
+ ### Authorization
1283
+
1284
+ No authorization required
1285
+
1286
+ ### HTTP request headers
1287
+
1288
+ - **Content-Type**: Not defined
1289
+ - **Accept**: Not defined
1290
+
1291
+
1292
+ ### HTTP response details
1293
+ | Status code | Description | Response headers |
1294
+ |-------------|-------------|------------------|
1295
+ |**204** | No Response | - |
1296
+ |**400** | Bad Request | - |
1297
+ |**401** | Unauthorised | - |
1298
+ |**403** | Access Denied | - |
1299
+
1300
+ [[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)
1301
+
1302
+ # **patchUpdateEngineerTaskNote**
1303
+ > patchUpdateEngineerTaskNote()
1304
+
1305
+ Update Wizard Engineer Task Note
1306
+
1307
+ ### Example
1308
+
1309
+ ```typescript
1310
+ import {
1311
+ Class3CXInstallationWizardApi,
1312
+ Configuration
1313
+ } from 'yellowgrid-api-ts';
1314
+
1315
+ const configuration = new Configuration();
1316
+ const apiInstance = new Class3CXInstallationWizardApi(configuration);
1317
+
1318
+ let taskId: number; //Task ID (default to undefined)
1319
+ let note: string; //note (default to undefined)
1320
+
1321
+ const { status, data } = await apiInstance.patchUpdateEngineerTaskNote(
1322
+ taskId,
1323
+ note
1324
+ );
1325
+ ```
1326
+
1327
+ ### Parameters
1328
+
1329
+ |Name | Type | Description | Notes|
1330
+ |------------- | ------------- | ------------- | -------------|
1331
+ | **taskId** | [**number**] | Task ID | defaults to undefined|
1332
+ | **note** | [**string**] | note | defaults to undefined|
1333
+
1334
+
1335
+ ### Return type
1336
+
1337
+ void (empty response body)
1338
+
1339
+ ### Authorization
1340
+
1341
+ No authorization required
1342
+
1343
+ ### HTTP request headers
1344
+
1345
+ - **Content-Type**: Not defined
1346
+ - **Accept**: Not defined
1347
+
1348
+
1349
+ ### HTTP response details
1350
+ | Status code | Description | Response headers |
1351
+ |-------------|-------------|------------------|
1352
+ |**204** | No Response | - |
1353
+ |**400** | Bad Request | - |
1354
+ |**401** | Unauthorised | - |
1355
+ |**403** | Access Denied | - |
1356
+
1357
+ [[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)
1358
+
1359
+ # **patchUpdateGoLiveDate**
1360
+ > patchUpdateGoLiveDate()
1361
+
1362
+ Update Wizard Go Live Date
1363
+
1364
+ ### Example
1365
+
1366
+ ```typescript
1367
+ import {
1368
+ Class3CXInstallationWizardApi,
1369
+ Configuration
1370
+ } from 'yellowgrid-api-ts';
1371
+
1372
+ const configuration = new Configuration();
1373
+ const apiInstance = new Class3CXInstallationWizardApi(configuration);
1374
+
1375
+ let goLiveDate: string; //Go Live Date (default to undefined)
1376
+
1377
+ const { status, data } = await apiInstance.patchUpdateGoLiveDate(
1378
+ goLiveDate
1379
+ );
1380
+ ```
1381
+
1382
+ ### Parameters
1383
+
1384
+ |Name | Type | Description | Notes|
1385
+ |------------- | ------------- | ------------- | -------------|
1386
+ | **goLiveDate** | [**string**] | Go Live Date | defaults to undefined|
1387
+
1388
+
1389
+ ### Return type
1390
+
1391
+ void (empty response body)
1392
+
1393
+ ### Authorization
1394
+
1395
+ No authorization required
1396
+
1397
+ ### HTTP request headers
1398
+
1399
+ - **Content-Type**: Not defined
1400
+ - **Accept**: Not defined
1401
+
1402
+
1403
+ ### HTTP response details
1404
+ | Status code | Description | Response headers |
1405
+ |-------------|-------------|------------------|
1406
+ |**204** | No Response | - |
1407
+ |**400** | Bad Request | - |
1408
+ |**401** | Unauthorised | - |
1409
+ |**403** | Access Denied | - |
1410
+
1411
+ [[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)
1412
+
1413
+ # **patchUpdateNote**
1414
+ > patchUpdateNote()
1415
+
1416
+ Update Wizard Engineer Note
1417
+
1418
+ ### Example
1419
+
1420
+ ```typescript
1421
+ import {
1422
+ Class3CXInstallationWizardApi,
1423
+ Configuration
1424
+ } from 'yellowgrid-api-ts';
1425
+
1426
+ const configuration = new Configuration();
1427
+ const apiInstance = new Class3CXInstallationWizardApi(configuration);
1428
+
1429
+ let note: string; //Note (default to undefined)
1430
+
1431
+ const { status, data } = await apiInstance.patchUpdateNote(
1432
+ note
1433
+ );
1434
+ ```
1435
+
1436
+ ### Parameters
1437
+
1438
+ |Name | Type | Description | Notes|
1439
+ |------------- | ------------- | ------------- | -------------|
1440
+ | **note** | [**string**] | Note | defaults to undefined|
1441
+
1442
+
1443
+ ### Return type
1444
+
1445
+ void (empty response body)
1446
+
1447
+ ### Authorization
1448
+
1449
+ No authorization required
1450
+
1451
+ ### HTTP request headers
1452
+
1453
+ - **Content-Type**: Not defined
1454
+ - **Accept**: Not defined
1455
+
1456
+
1457
+ ### HTTP response details
1458
+ | Status code | Description | Response headers |
1459
+ |-------------|-------------|------------------|
1460
+ |**204** | No Response | - |
1461
+ |**400** | Bad Request | - |
1462
+ |**401** | Unauthorised | - |
1463
+ |**403** | Access Denied | - |
1464
+
1465
+ [[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)
1466
+
1467
+ # **patchUpdateSpec**
1468
+ > patchUpdateSpec()
1469
+
1470
+ Update Wizard Engineer Spec
1471
+
1472
+ ### Example
1473
+
1474
+ ```typescript
1475
+ import {
1476
+ Class3CXInstallationWizardApi,
1477
+ Configuration
1478
+ } from 'yellowgrid-api-ts';
1479
+
1480
+ const configuration = new Configuration();
1481
+ const apiInstance = new Class3CXInstallationWizardApi(configuration);
1482
+
1483
+ let spec: string; //Spec (default to undefined)
1484
+
1485
+ const { status, data } = await apiInstance.patchUpdateSpec(
1486
+ spec
1487
+ );
1488
+ ```
1489
+
1490
+ ### Parameters
1491
+
1492
+ |Name | Type | Description | Notes|
1493
+ |------------- | ------------- | ------------- | -------------|
1494
+ | **spec** | [**string**] | Spec | defaults to undefined|
1495
+
1496
+
1497
+ ### Return type
1498
+
1499
+ void (empty response body)
1500
+
1501
+ ### Authorization
1502
+
1503
+ No authorization required
1504
+
1505
+ ### HTTP request headers
1506
+
1507
+ - **Content-Type**: Not defined
1508
+ - **Accept**: Not defined
1509
+
1510
+
1511
+ ### HTTP response details
1512
+ | Status code | Description | Response headers |
1513
+ |-------------|-------------|------------------|
1514
+ |**204** | No Response | - |
1515
+ |**400** | Bad Request | - |
1516
+ |**401** | Unauthorised | - |
1517
+ |**403** | Access Denied | - |
1518
+
1519
+ [[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)
1520
+
1137
1521
  # **postAddExtensions**
1138
1522
  > Array<TcxExtsEntity> postAddExtensions()
1139
1523
 
@@ -1,6 +1,6 @@
1
1
  # Class3CXInstallationsApi
2
2
 
3
- All URIs are relative to *https://bitbucket.org*
3
+ All URIs are relative to *https://api.local.yellowgrid.co.uk*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
@@ -1,12 +1,13 @@
1
1
  # Class3CXIntegrationsApi
2
2
 
3
- All URIs are relative to *https://bitbucket.org*
3
+ All URIs are relative to *https://api.local.yellowgrid.co.uk*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
7
7
  |[**getGetPrice**](#getgetprice) | **GET** /tcx/integrations/edtechpro/prices | |
8
8
  |[**getGetSchools**](#getgetschools) | **GET** /tcx/integrations/edtechpro/schools | |
9
9
  |[**getGetTrusts**](#getgettrusts) | **GET** /tcx/integrations/edtechpro/trusts | |
10
+ |[**getSearchSchools**](#getsearchschools) | **GET** /tcx/integrations/edtechpro/search/schools | |
10
11
  |[**patchUpdateEtpOrderReference**](#patchupdateetporderreference) | **PATCH** /tcx/integrations/edtechpro/{clientId}/schools/{schoolId}/orderReference | |
11
12
  |[**postOrderEdTechPro**](#postorderedtechpro) | **POST** /tcx/integrations/edtechpro/orders | |
12
13
  |[**postUpgradeEdTechPro**](#postupgradeedtechpro) | **POST** /tcx/integrations/edtechpro/upgrades | |
@@ -172,6 +173,57 @@ No authorization required
172
173
 
173
174
  [[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)
174
175
 
176
+ # **getSearchSchools**
177
+ > Array<SearchSchoolModel> getSearchSchools()
178
+
179
+ Seach EdTechPro Schools
180
+
181
+ ### Example
182
+
183
+ ```typescript
184
+ import {
185
+ Class3CXIntegrationsApi,
186
+ Configuration
187
+ } from 'yellowgrid-api-ts';
188
+
189
+ const configuration = new Configuration();
190
+ const apiInstance = new Class3CXIntegrationsApi(configuration);
191
+
192
+ let search: string; //School Name, Dfe code or URN (default to undefined)
193
+
194
+ const { status, data } = await apiInstance.getSearchSchools(
195
+ search
196
+ );
197
+ ```
198
+
199
+ ### Parameters
200
+
201
+ |Name | Type | Description | Notes|
202
+ |------------- | ------------- | ------------- | -------------|
203
+ | **search** | [**string**] | School Name, Dfe code or URN | defaults to undefined|
204
+
205
+
206
+ ### Return type
207
+
208
+ **Array<SearchSchoolModel>**
209
+
210
+ ### Authorization
211
+
212
+ No authorization required
213
+
214
+ ### HTTP request headers
215
+
216
+ - **Content-Type**: Not defined
217
+ - **Accept**: application/json
218
+
219
+
220
+ ### HTTP response details
221
+ | Status code | Description | Response headers |
222
+ |-------------|-------------|------------------|
223
+ |**200** | EdTechPro Schools | - |
224
+
225
+ [[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)
226
+
175
227
  # **patchUpdateEtpOrderReference**
176
228
  > patchUpdateEtpOrderReference()
177
229