yellowgrid-api-ts 3.2.144-dev.0 → 3.2.146-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 (532) hide show
  1. package/.openapi-generator/FILES +21 -6
  2. package/.openapi-generator/VERSION +1 -1
  3. package/README.md +46 -8
  4. package/api.ts +2440 -5147
  5. package/base.ts +2 -26
  6. package/common.ts +16 -39
  7. package/configuration.ts +25 -19
  8. package/dist/api.d.ts +1254 -4702
  9. package/dist/api.js +2492 -810
  10. package/dist/base.d.ts +1 -25
  11. package/dist/base.js +2 -21
  12. package/dist/common.d.ts +5 -36
  13. package/dist/common.js +17 -39
  14. package/dist/configuration.d.ts +25 -18
  15. package/dist/configuration.js +2 -2
  16. package/dist/index.d.ts +1 -1
  17. package/dist/index.js +1 -1
  18. package/dist/models/StatusEnum.d.ts +18 -0
  19. package/dist/models/StatusEnum.js +20 -0
  20. package/dist/src/apis/AccountsApi.d.ts +258 -0
  21. package/dist/src/apis/AccountsApi.js +975 -0
  22. package/dist/src/apis/CRMApi.d.ts +26 -0
  23. package/dist/src/apis/CRMApi.js +122 -0
  24. package/dist/src/apis/Class3CXApi.d.ts +44 -0
  25. package/dist/src/apis/Class3CXApi.js +177 -0
  26. package/dist/src/apis/Class3CXInstallationWizardApi.d.ts +446 -0
  27. package/dist/src/apis/Class3CXInstallationWizardApi.js +1740 -0
  28. package/dist/src/apis/Class3CXInstallationsApi.d.ts +253 -0
  29. package/dist/src/apis/Class3CXInstallationsApi.js +806 -0
  30. package/dist/src/apis/Class3CXIntegrationsApi.d.ts +102 -0
  31. package/dist/src/apis/Class3CXIntegrationsApi.js +386 -0
  32. package/dist/src/apis/Class3CXMultiTenantApi.d.ts +122 -0
  33. package/dist/src/apis/Class3CXMultiTenantApi.js +431 -0
  34. package/dist/src/apis/MyPBXToolsApi.d.ts +32 -0
  35. package/dist/src/apis/MyPBXToolsApi.js +136 -0
  36. package/dist/src/apis/OAuth20Api.d.ts +185 -0
  37. package/dist/src/apis/OAuth20Api.js +507 -0
  38. package/dist/src/apis/OrdersApi.d.ts +154 -0
  39. package/dist/src/apis/OrdersApi.js +512 -0
  40. package/dist/src/apis/PricingApi.d.ts +154 -0
  41. package/dist/src/apis/PricingApi.js +308 -0
  42. package/dist/src/apis/ProductsApi.d.ts +135 -0
  43. package/dist/src/apis/ProductsApi.js +531 -0
  44. package/dist/src/apis/ProvisioningApi.d.ts +112 -0
  45. package/dist/src/apis/ProvisioningApi.js +427 -0
  46. package/dist/src/apis/SIPTrunksApi.d.ts +315 -0
  47. package/dist/src/apis/SIPTrunksApi.js +1197 -0
  48. package/dist/src/apis/SMSApi.d.ts +30 -0
  49. package/dist/src/apis/SMSApi.js +130 -0
  50. package/dist/src/apis/ServicesApi.d.ts +81 -0
  51. package/dist/src/apis/ServicesApi.js +386 -0
  52. package/dist/src/apis/ShippingApi.d.ts +45 -0
  53. package/dist/src/apis/ShippingApi.js +179 -0
  54. package/dist/src/apis/StockManagementApi.d.ts +345 -0
  55. package/dist/src/apis/StockManagementApi.js +1293 -0
  56. package/dist/src/apis/SystemApi.d.ts +37 -0
  57. package/dist/src/apis/SystemApi.js +146 -0
  58. package/dist/src/apis/TicketsApi.d.ts +79 -0
  59. package/dist/src/apis/TicketsApi.js +360 -0
  60. package/dist/src/apis/WebhooksApi.d.ts +56 -0
  61. package/dist/src/apis/WebhooksApi.js +189 -0
  62. package/dist/src/apis/index.d.ts +21 -0
  63. package/dist/src/apis/index.js +39 -0
  64. package/dist/src/index.d.ts +3 -0
  65. package/dist/src/index.js +21 -0
  66. package/dist/src/models/AbstractOrderRequestDTO.d.ts +71 -0
  67. package/dist/src/models/AbstractOrderRequestDTO.js +64 -0
  68. package/dist/src/models/AccountContactEntity.d.ts +104 -0
  69. package/dist/src/models/AccountContactEntity.js +73 -0
  70. package/dist/src/models/AccountContactModel.d.ts +104 -0
  71. package/dist/src/models/AccountContactModel.js +73 -0
  72. package/dist/src/models/AccountContactRequestModel.d.ts +80 -0
  73. package/dist/src/models/AccountContactRequestModel.js +65 -0
  74. package/dist/src/models/AccountDetailedSummaryDTO.d.ts +89 -0
  75. package/dist/src/models/AccountDetailedSummaryDTO.js +70 -0
  76. package/dist/src/models/AccountRequestModel.d.ts +128 -0
  77. package/dist/src/models/AccountRequestModel.js +81 -0
  78. package/dist/src/models/AccountSummaryDTO.d.ts +44 -0
  79. package/dist/src/models/AccountSummaryDTO.js +53 -0
  80. package/dist/src/models/AccountsResponseModel.d.ts +51 -0
  81. package/dist/src/models/AccountsResponseModel.js +56 -0
  82. package/dist/src/models/AddressModel.d.ts +110 -0
  83. package/dist/src/models/AddressModel.js +75 -0
  84. package/dist/src/models/AddressRequestModel.d.ts +50 -0
  85. package/dist/src/models/AddressRequestModel.js +55 -0
  86. package/dist/src/models/AdminOrderRequestDTO.d.ts +113 -0
  87. package/dist/src/models/AdminOrderRequestDTO.js +78 -0
  88. package/dist/src/models/AdminUserModel.d.ts +79 -0
  89. package/dist/src/models/AdminUserModel.js +72 -0
  90. package/dist/src/models/AgentHoursGraphModel.d.ts +51 -0
  91. package/dist/src/models/AgentHoursGraphModel.js +56 -0
  92. package/dist/src/models/AgentHoursGraphMonthModel.d.ts +38 -0
  93. package/dist/src/models/AgentHoursGraphMonthModel.js +51 -0
  94. package/dist/src/models/ApiLogEntity.d.ts +98 -0
  95. package/dist/src/models/ApiLogEntity.js +71 -0
  96. package/dist/src/models/AreaCodeModel.d.ts +38 -0
  97. package/dist/src/models/AreaCodeModel.js +51 -0
  98. package/dist/src/models/AttachmentModel.d.ts +56 -0
  99. package/dist/src/models/AttachmentModel.js +57 -0
  100. package/dist/src/models/AttributeSetEnum.d.ts +38 -0
  101. package/dist/src/models/AttributeSetEnum.js +51 -0
  102. package/dist/src/models/AuditLogEntity.d.ts +80 -0
  103. package/dist/src/models/AuditLogEntity.js +65 -0
  104. package/dist/src/models/AuthCodeResponseModel.d.ts +44 -0
  105. package/dist/src/models/AuthCodeResponseModel.js +53 -0
  106. package/dist/src/models/BasicItemDTO.d.ts +38 -0
  107. package/dist/src/models/BasicItemDTO.js +51 -0
  108. package/dist/src/models/BasicProductDTO.d.ts +38 -0
  109. package/dist/src/models/BasicProductDTO.js +51 -0
  110. package/dist/src/models/BatchEntity.d.ts +128 -0
  111. package/dist/src/models/BatchEntity.js +81 -0
  112. package/dist/src/models/CallBarringModel.d.ts +56 -0
  113. package/dist/src/models/CallBarringModel.js +57 -0
  114. package/dist/src/models/ClientDetailsModel.d.ts +68 -0
  115. package/dist/src/models/ClientDetailsModel.js +61 -0
  116. package/dist/src/models/ClientModel.d.ts +50 -0
  117. package/dist/src/models/ClientModel.js +55 -0
  118. package/dist/src/models/CompanyContractModel.d.ts +56 -0
  119. package/dist/src/models/CompanyContractModel.js +57 -0
  120. package/dist/src/models/ContactInfoModel.d.ts +56 -0
  121. package/dist/src/models/ContactInfoModel.js +57 -0
  122. package/dist/src/models/ConversationModel.d.ts +75 -0
  123. package/dist/src/models/ConversationModel.js +64 -0
  124. package/dist/src/models/CourierPriceEntity.d.ts +86 -0
  125. package/dist/src/models/CourierPriceEntity.js +67 -0
  126. package/dist/src/models/CreditAccountEntity.d.ts +152 -0
  127. package/dist/src/models/CreditAccountEntity.js +89 -0
  128. package/dist/src/models/CrmContactDTO.d.ts +68 -0
  129. package/dist/src/models/CrmContactDTO.js +61 -0
  130. package/dist/src/models/CustomerInformationModel.d.ts +68 -0
  131. package/dist/src/models/CustomerInformationModel.js +61 -0
  132. package/dist/src/models/CustomerItemRequestDTO.d.ts +81 -0
  133. package/dist/src/models/CustomerItemRequestDTO.js +66 -0
  134. package/dist/src/models/CustomerOrderRequestDTO.d.ts +71 -0
  135. package/dist/src/models/CustomerOrderRequestDTO.js +64 -0
  136. package/dist/src/models/CustomerPriceListEnum.d.ts +38 -0
  137. package/dist/src/models/CustomerPriceListEnum.js +51 -0
  138. package/dist/src/models/CustomerSummaryReportDTO.d.ts +65 -0
  139. package/dist/src/models/CustomerSummaryReportDTO.js +62 -0
  140. package/dist/src/models/DdiRangeRequestModel.d.ts +44 -0
  141. package/dist/src/models/DdiRangeRequestModel.js +53 -0
  142. package/dist/src/models/DdiRangesRequestModel.d.ts +33 -0
  143. package/dist/src/models/DdiRangesRequestModel.js +50 -0
  144. package/dist/src/models/DetailedItemRequestDTO.d.ts +99 -0
  145. package/dist/src/models/DetailedItemRequestDTO.js +72 -0
  146. package/dist/src/models/DetailedOrderRequestDTO.d.ts +71 -0
  147. package/dist/src/models/DetailedOrderRequestDTO.js +64 -0
  148. package/dist/src/models/DivertRequestModel.d.ts +38 -0
  149. package/dist/src/models/DivertRequestModel.js +51 -0
  150. package/dist/src/models/DivertResponseModel.d.ts +52 -0
  151. package/dist/src/models/DivertResponseModel.js +61 -0
  152. package/dist/src/models/EdTechProClientEntity.d.ts +56 -0
  153. package/dist/src/models/EdTechProClientEntity.js +57 -0
  154. package/dist/src/models/EdTechProSchoolModel.d.ts +104 -0
  155. package/dist/src/models/EdTechProSchoolModel.js +73 -0
  156. package/dist/src/models/EdTechProSchoolsModel.d.ts +51 -0
  157. package/dist/src/models/EdTechProSchoolsModel.js +56 -0
  158. package/dist/src/models/EdTechProSetupModel.d.ts +56 -0
  159. package/dist/src/models/EdTechProSetupModel.js +57 -0
  160. package/dist/src/models/EventDTO.d.ts +84 -0
  161. package/dist/src/models/EventDTO.js +73 -0
  162. package/dist/src/models/EventRequestDTO.d.ts +44 -0
  163. package/dist/src/models/EventRequestDTO.js +53 -0
  164. package/dist/src/models/EventSubscriptionModel.d.ts +38 -0
  165. package/dist/src/models/EventSubscriptionModel.js +51 -0
  166. package/dist/src/models/EventTypeEnum.d.ts +19 -0
  167. package/dist/src/models/EventTypeEnum.js +24 -0
  168. package/dist/src/models/EventUpdateDTO.d.ts +50 -0
  169. package/dist/src/models/EventUpdateDTO.js +55 -0
  170. package/dist/src/models/EventUpdateEntity.d.ts +56 -0
  171. package/dist/src/models/EventUpdateEntity.js +57 -0
  172. package/dist/src/models/EventUpdateRequestDTO.d.ts +44 -0
  173. package/dist/src/models/EventUpdateRequestDTO.js +53 -0
  174. package/dist/src/models/FraudManagementModel.d.ts +38 -0
  175. package/dist/src/models/FraudManagementModel.js +51 -0
  176. package/dist/src/models/FreshdeskCompanyTicketsModel.d.ts +51 -0
  177. package/dist/src/models/FreshdeskCompanyTicketsModel.js +56 -0
  178. package/dist/src/models/FreshdeskTicketEntity.d.ts +68 -0
  179. package/dist/src/models/FreshdeskTicketEntity.js +61 -0
  180. package/dist/src/models/FtpAccountsEntity.d.ts +56 -0
  181. package/dist/src/models/FtpAccountsEntity.js +57 -0
  182. package/dist/src/models/GenericFileModel.d.ts +44 -0
  183. package/dist/src/models/GenericFileModel.js +53 -0
  184. package/dist/src/models/GetGetPrice200Response.d.ts +32 -0
  185. package/dist/src/models/GetGetPrice200Response.js +49 -0
  186. package/dist/src/models/GetGetRecording200Response.d.ts +32 -0
  187. package/dist/src/models/GetGetRecording200Response.js +49 -0
  188. package/dist/src/models/HostingChangeResponseModel.d.ts +64 -0
  189. package/dist/src/models/HostingChangeResponseModel.js +65 -0
  190. package/dist/src/models/HostingRegionDTO.d.ts +59 -0
  191. package/dist/src/models/HostingRegionDTO.js +68 -0
  192. package/dist/src/models/InstanceAutoFailoverEntity.d.ts +56 -0
  193. package/dist/src/models/InstanceAutoFailoverEntity.js +57 -0
  194. package/dist/src/models/InstanceDeletionScheduleEntity.d.ts +50 -0
  195. package/dist/src/models/InstanceDeletionScheduleEntity.js +55 -0
  196. package/dist/src/models/InstanceEntity.d.ts +152 -0
  197. package/dist/src/models/InstanceEntity.js +89 -0
  198. package/dist/src/models/InstanceFailoverEntity.d.ts +92 -0
  199. package/dist/src/models/InstanceFailoverEntity.js +69 -0
  200. package/dist/src/models/InstanceMonitoringEntity.d.ts +44 -0
  201. package/dist/src/models/InstanceMonitoringEntity.js +53 -0
  202. package/dist/src/models/InstanceMonitoringLogEntity.d.ts +62 -0
  203. package/dist/src/models/InstanceMonitoringLogEntity.js +59 -0
  204. package/dist/src/models/InstanceScheduledTasksEntity.d.ts +62 -0
  205. package/dist/src/models/InstanceScheduledTasksEntity.js +59 -0
  206. package/dist/src/models/InstanceTcxDetailsEntity.d.ts +86 -0
  207. package/dist/src/models/InstanceTcxDetailsEntity.js +67 -0
  208. package/dist/src/models/InstanceUserCredentialsEntity.d.ts +56 -0
  209. package/dist/src/models/InstanceUserCredentialsEntity.js +57 -0
  210. package/dist/src/models/ItemDTO.d.ts +117 -0
  211. package/dist/src/models/ItemDTO.js +78 -0
  212. package/dist/src/models/ItemDiscountEntity.d.ts +77 -0
  213. package/dist/src/models/ItemDiscountEntity.js +70 -0
  214. package/dist/src/models/ItemEntity.d.ts +158 -0
  215. package/dist/src/models/ItemEntity.js +91 -0
  216. package/dist/src/models/LinkedOrderEntity.d.ts +38 -0
  217. package/dist/src/models/LinkedOrderEntity.js +51 -0
  218. package/dist/src/models/MFARequiredModel.d.ts +38 -0
  219. package/dist/src/models/MFARequiredModel.js +51 -0
  220. package/dist/src/models/MonthlyUsageModel.d.ts +38 -0
  221. package/dist/src/models/MonthlyUsageModel.js +51 -0
  222. package/dist/src/models/MultiTenantChangeResponseModel.d.ts +70 -0
  223. package/dist/src/models/MultiTenantChangeResponseModel.js +75 -0
  224. package/dist/src/models/NavigationModel.d.ts +50 -0
  225. package/dist/src/models/NavigationModel.js +55 -0
  226. package/dist/src/models/OfflineInstancesEntity.d.ts +56 -0
  227. package/dist/src/models/OfflineInstancesEntity.js +57 -0
  228. package/dist/src/models/OrderEntity.d.ts +374 -0
  229. package/dist/src/models/OrderEntity.js +163 -0
  230. package/dist/src/models/OrderRequestModel.d.ts +120 -0
  231. package/dist/src/models/OrderRequestModel.js +88 -0
  232. package/dist/src/models/OrderSummariesModel.d.ts +51 -0
  233. package/dist/src/models/OrderSummariesModel.js +56 -0
  234. package/dist/src/models/OrderSummaryDTO.d.ts +126 -0
  235. package/dist/src/models/OrderSummaryDTO.js +83 -0
  236. package/dist/src/models/OrderTotalModel.d.ts +111 -0
  237. package/dist/src/models/OrderTotalModel.js +100 -0
  238. package/dist/src/models/OrderedItemEntity.d.ts +110 -0
  239. package/dist/src/models/OrderedItemEntity.js +75 -0
  240. package/dist/src/models/PatchSetTcxWizardCnameRequest.d.ts +32 -0
  241. package/dist/src/models/PatchSetTcxWizardCnameRequest.js +49 -0
  242. package/dist/src/models/PatchUpdateAccountContactPasswordRequest.d.ts +32 -0
  243. package/dist/src/models/PatchUpdateAccountContactPasswordRequest.js +49 -0
  244. package/dist/src/models/PortalAccountModel.d.ts +171 -0
  245. package/dist/src/models/PortalAccountModel.js +96 -0
  246. package/dist/src/models/PortalLoginModel.d.ts +68 -0
  247. package/dist/src/models/PortalLoginModel.js +61 -0
  248. package/dist/src/models/PostAddWebhook200Response.d.ts +32 -0
  249. package/dist/src/models/PostAddWebhook200Response.js +49 -0
  250. package/dist/src/models/PostGetClientCredentialsRequest.d.ts +32 -0
  251. package/dist/src/models/PostGetClientCredentialsRequest.js +49 -0
  252. package/dist/src/models/PostGetProductForCustomerRequest.d.ts +50 -0
  253. package/dist/src/models/PostGetProductForCustomerRequest.js +55 -0
  254. package/dist/src/models/PostGetProductRequest.d.ts +44 -0
  255. package/dist/src/models/PostGetProductRequest.js +53 -0
  256. package/dist/src/models/PriceListItemModel.d.ts +56 -0
  257. package/dist/src/models/PriceListItemModel.js +57 -0
  258. package/dist/src/models/PrizesEntity.d.ts +62 -0
  259. package/dist/src/models/PrizesEntity.js +59 -0
  260. package/dist/src/models/ProductPriceListItemModel.d.ts +62 -0
  261. package/dist/src/models/ProductPriceListItemModel.js +59 -0
  262. package/dist/src/models/ProductSearchResultsModel.d.ts +33 -0
  263. package/dist/src/models/ProductSearchResultsModel.js +50 -0
  264. package/dist/src/models/ProductSerialInfoModel.d.ts +50 -0
  265. package/dist/src/models/ProductSerialInfoModel.js +55 -0
  266. package/dist/src/models/ProductSummaryDTO.d.ts +81 -0
  267. package/dist/src/models/ProductSummaryDTO.js +66 -0
  268. package/dist/src/models/PromoCodesEntity.d.ts +98 -0
  269. package/dist/src/models/PromoCodesEntity.js +71 -0
  270. package/dist/src/models/PromoItemsEntity.d.ts +74 -0
  271. package/dist/src/models/PromoItemsEntity.js +63 -0
  272. package/dist/src/models/ProvisioningModel.d.ts +56 -0
  273. package/dist/src/models/ProvisioningModel.js +57 -0
  274. package/dist/src/models/ProvisioningRequestEntity.d.ts +44 -0
  275. package/dist/src/models/ProvisioningRequestEntity.js +53 -0
  276. package/dist/src/models/RecordingBackupAzureModel.d.ts +50 -0
  277. package/dist/src/models/RecordingBackupAzureModel.js +55 -0
  278. package/dist/src/models/RecordingsBackupInfoDTO.d.ts +40 -0
  279. package/dist/src/models/RecordingsBackupInfoDTO.js +53 -0
  280. package/dist/src/models/ResourceNotReadyException.d.ts +44 -0
  281. package/dist/src/models/ResourceNotReadyException.js +53 -0
  282. package/dist/src/models/RootAccessModel.d.ts +44 -0
  283. package/dist/src/models/RootAccessModel.js +53 -0
  284. package/dist/src/models/S3BucketEntity.d.ts +50 -0
  285. package/dist/src/models/S3BucketEntity.js +55 -0
  286. package/dist/src/models/ScannedItemModel.d.ts +56 -0
  287. package/dist/src/models/ScannedItemModel.js +57 -0
  288. package/dist/src/models/ScopeModel.d.ts +38 -0
  289. package/dist/src/models/ScopeModel.js +51 -0
  290. package/dist/src/models/ServiceEnum.d.ts +14 -0
  291. package/dist/src/models/ServiceEnum.js +19 -0
  292. package/dist/src/models/ServiceHealthDTO.d.ts +48 -0
  293. package/dist/src/models/ServiceHealthDTO.js +61 -0
  294. package/dist/src/models/ServiceHealthEnum.d.ts +19 -0
  295. package/dist/src/models/ServiceHealthEnum.js +24 -0
  296. package/dist/src/models/ServiceStatusDTO.d.ts +60 -0
  297. package/dist/src/models/ServiceStatusDTO.js +65 -0
  298. package/dist/src/models/ServiceStatusEnum.d.ts +19 -0
  299. package/dist/src/models/ServiceStatusEnum.js +24 -0
  300. package/dist/src/models/ShipmentAddressEntity.d.ts +92 -0
  301. package/dist/src/models/ShipmentAddressEntity.js +69 -0
  302. package/dist/src/models/ShipmentEntity.d.ts +98 -0
  303. package/dist/src/models/ShipmentEntity.js +71 -0
  304. package/dist/src/models/ShipmentItemEntity.d.ts +56 -0
  305. package/dist/src/models/ShipmentItemEntity.js +57 -0
  306. package/dist/src/models/ShippingConsignmentModel.d.ts +51 -0
  307. package/dist/src/models/ShippingConsignmentModel.js +56 -0
  308. package/dist/src/models/ShippingInformationDTO.d.ts +45 -0
  309. package/dist/src/models/ShippingInformationDTO.js +54 -0
  310. package/dist/src/models/ShippingServiceDTO.d.ts +47 -0
  311. package/dist/src/models/ShippingServiceDTO.js +60 -0
  312. package/dist/src/models/ShippingServiceModel.d.ts +71 -0
  313. package/dist/src/models/ShippingServiceModel.js +68 -0
  314. package/dist/src/models/ShippingServicesModel.d.ts +33 -0
  315. package/dist/src/models/ShippingServicesModel.js +50 -0
  316. package/dist/src/models/SipTrunkChangeResponseModel.d.ts +77 -0
  317. package/dist/src/models/SipTrunkChangeResponseModel.js +78 -0
  318. package/dist/src/models/SipTrunkCreationRequestModel.d.ts +66 -0
  319. package/dist/src/models/SipTrunkCreationRequestModel.js +63 -0
  320. package/dist/src/models/SipTrunkEntity.d.ts +98 -0
  321. package/dist/src/models/SipTrunkEntity.js +71 -0
  322. package/dist/src/models/SipTrunksResponseModel.d.ts +51 -0
  323. package/dist/src/models/SipTrunksResponseModel.js +56 -0
  324. package/dist/src/models/SmsAccountEntity.d.ts +68 -0
  325. package/dist/src/models/SmsAccountEntity.js +61 -0
  326. package/dist/src/models/SmsDataModel.d.ts +33 -0
  327. package/dist/src/models/SmsDataModel.js +50 -0
  328. package/dist/src/models/SmsMessageModel.d.ts +44 -0
  329. package/dist/src/models/SmsMessageModel.js +53 -0
  330. package/dist/src/models/SmsNumbersEntity.d.ts +38 -0
  331. package/dist/src/models/SmsNumbersEntity.js +51 -0
  332. package/dist/src/models/SmsPayloadModel.d.ts +45 -0
  333. package/dist/src/models/SmsPayloadModel.js +54 -0
  334. package/dist/src/models/SmsPhoneNumberModel.d.ts +53 -0
  335. package/dist/src/models/SmsPhoneNumberModel.js +66 -0
  336. package/dist/src/models/SmsResponseModel.d.ts +67 -0
  337. package/dist/src/models/SmsResponseModel.js +68 -0
  338. package/dist/src/models/SmsWhitelistEntity.d.ts +38 -0
  339. package/dist/src/models/SmsWhitelistEntity.js +51 -0
  340. package/dist/src/models/StockOrderCourierEntity.d.ts +50 -0
  341. package/dist/src/models/StockOrderCourierEntity.js +55 -0
  342. package/dist/src/models/StockOrderDeductionModel.d.ts +50 -0
  343. package/dist/src/models/StockOrderDeductionModel.js +55 -0
  344. package/dist/src/models/StockOrderDeductionRequestModel.d.ts +38 -0
  345. package/dist/src/models/StockOrderDeductionRequestModel.js +51 -0
  346. package/dist/src/models/StockOrderDeductionsEntity.d.ts +50 -0
  347. package/dist/src/models/StockOrderDeductionsEntity.js +55 -0
  348. package/dist/src/models/StockOrderEntity.d.ts +158 -0
  349. package/dist/src/models/StockOrderEntity.js +91 -0
  350. package/dist/src/models/StockOrderItemEntity.d.ts +68 -0
  351. package/dist/src/models/StockOrderItemEntity.js +61 -0
  352. package/dist/src/models/StockOrderItemModel.d.ts +80 -0
  353. package/dist/src/models/StockOrderItemModel.js +65 -0
  354. package/dist/src/models/StockOrderItemRequestModel.d.ts +50 -0
  355. package/dist/src/models/StockOrderItemRequestModel.js +55 -0
  356. package/dist/src/models/StockOrderModel.d.ts +137 -0
  357. package/dist/src/models/StockOrderModel.js +97 -0
  358. package/dist/src/models/StockOrderProductEntity.d.ts +62 -0
  359. package/dist/src/models/StockOrderProductEntity.js +59 -0
  360. package/dist/src/models/StockOrderRequestModel.d.ts +46 -0
  361. package/dist/src/models/StockOrderRequestModel.js +55 -0
  362. package/dist/src/models/StockOrderSupplierEntity.d.ts +80 -0
  363. package/dist/src/models/StockOrderSupplierEntity.js +65 -0
  364. package/dist/src/models/StockOrderSupplierModel.d.ts +80 -0
  365. package/dist/src/models/StockOrderSupplierModel.js +65 -0
  366. package/dist/src/models/StockOrdersModel.d.ts +51 -0
  367. package/dist/src/models/StockOrdersModel.js +56 -0
  368. package/dist/src/models/StockProductModel.d.ts +120 -0
  369. package/dist/src/models/StockProductModel.js +81 -0
  370. package/dist/src/models/StockProductPriceModel.d.ts +39 -0
  371. package/dist/src/models/StockProductPriceModel.js +52 -0
  372. package/dist/src/models/StockProductSummariesModel.d.ts +51 -0
  373. package/dist/src/models/StockProductSummariesModel.js +56 -0
  374. package/dist/src/models/StockProductSummaryModel.d.ts +69 -0
  375. package/dist/src/models/StockProductSummaryModel.js +62 -0
  376. package/dist/src/models/StockTransactionsEntity.d.ts +74 -0
  377. package/dist/src/models/StockTransactionsEntity.js +63 -0
  378. package/dist/src/models/SupplierEntity.d.ts +80 -0
  379. package/dist/src/models/SupplierEntity.js +65 -0
  380. package/dist/src/models/SupplierItemEntity.d.ts +74 -0
  381. package/dist/src/models/SupplierItemEntity.js +63 -0
  382. package/dist/src/models/TcxBackupEntity.d.ts +80 -0
  383. package/dist/src/models/TcxBackupEntity.js +65 -0
  384. package/dist/src/models/TcxBackupModel.d.ts +140 -0
  385. package/dist/src/models/TcxBackupModel.js +85 -0
  386. package/dist/src/models/TcxBillingEntity.d.ts +86 -0
  387. package/dist/src/models/TcxBillingEntity.js +67 -0
  388. package/dist/src/models/TcxBulkLicenceDetailsModel.d.ts +40 -0
  389. package/dist/src/models/TcxBulkLicenceDetailsModel.js +53 -0
  390. package/dist/src/models/TcxDeadLicenceEntity.d.ts +44 -0
  391. package/dist/src/models/TcxDeadLicenceEntity.js +53 -0
  392. package/dist/src/models/TcxExtsEntity.d.ts +74 -0
  393. package/dist/src/models/TcxExtsEntity.js +63 -0
  394. package/dist/src/models/TcxHostingPricingEntity.d.ts +74 -0
  395. package/dist/src/models/TcxHostingPricingEntity.js +63 -0
  396. package/dist/src/models/TcxInstallationDetailsModel.d.ts +106 -0
  397. package/dist/src/models/TcxInstallationDetailsModel.js +75 -0
  398. package/dist/src/models/TcxInstallationModel.d.ts +200 -0
  399. package/dist/src/models/TcxInstallationModel.js +105 -0
  400. package/dist/src/models/TcxInstallationsModel.d.ts +51 -0
  401. package/dist/src/models/TcxInstallationsModel.js +56 -0
  402. package/dist/src/models/TcxKeySummaryDTO.d.ts +56 -0
  403. package/dist/src/models/TcxKeySummaryDTO.js +57 -0
  404. package/dist/src/models/TcxKeysEntity.d.ts +62 -0
  405. package/dist/src/models/TcxKeysEntity.js +59 -0
  406. package/dist/src/models/TcxLicenceDetailsErrorModel.d.ts +50 -0
  407. package/dist/src/models/TcxLicenceDetailsErrorModel.js +55 -0
  408. package/dist/src/models/TcxLicenceDetailsModel.d.ts +92 -0
  409. package/dist/src/models/TcxLicenceDetailsModel.js +69 -0
  410. package/dist/src/models/TcxMacsEntity.d.ts +44 -0
  411. package/dist/src/models/TcxMacsEntity.js +53 -0
  412. package/dist/src/models/TcxMultiTenantModel.d.ts +118 -0
  413. package/dist/src/models/TcxMultiTenantModel.js +83 -0
  414. package/dist/src/models/TcxMultiTenantUserModel.d.ts +44 -0
  415. package/dist/src/models/TcxMultiTenantUserModel.js +53 -0
  416. package/dist/src/models/TcxMultiTenantsModel.d.ts +51 -0
  417. package/dist/src/models/TcxMultiTenantsModel.js +56 -0
  418. package/dist/src/models/TcxNumbersEntity.d.ts +44 -0
  419. package/dist/src/models/TcxNumbersEntity.js +53 -0
  420. package/dist/src/models/TcxOfficeHoursEntity.d.ts +116 -0
  421. package/dist/src/models/TcxOfficeHoursEntity.js +77 -0
  422. package/dist/src/models/TcxPhoneModel.d.ts +68 -0
  423. package/dist/src/models/TcxPhoneModel.js +61 -0
  424. package/dist/src/models/TcxPhonesEntity.d.ts +62 -0
  425. package/dist/src/models/TcxPhonesEntity.js +59 -0
  426. package/dist/src/models/TcxRemoteStorageModel.d.ts +50 -0
  427. package/dist/src/models/TcxRemoteStorageModel.js +55 -0
  428. package/dist/src/models/TcxSbcDTO.d.ts +62 -0
  429. package/dist/src/models/TcxSbcDTO.js +59 -0
  430. package/dist/src/models/TcxSbcEntity.d.ts +122 -0
  431. package/dist/src/models/TcxSbcEntity.js +79 -0
  432. package/dist/src/models/TcxSbcModel.d.ts +122 -0
  433. package/dist/src/models/TcxSbcModel.js +79 -0
  434. package/dist/src/models/TcxSetupEntity.d.ts +207 -0
  435. package/dist/src/models/TcxSetupEntity.js +123 -0
  436. package/dist/src/models/TcxSetupsModel.d.ts +51 -0
  437. package/dist/src/models/TcxSetupsModel.js +56 -0
  438. package/dist/src/models/TcxSipTrunksEntity.d.ts +104 -0
  439. package/dist/src/models/TcxSipTrunksEntity.js +73 -0
  440. package/dist/src/models/TcxTemplateXmlEnum.d.ts +38 -0
  441. package/dist/src/models/TcxTemplateXmlEnum.js +51 -0
  442. package/dist/src/models/TcxUsersEntity.d.ts +62 -0
  443. package/dist/src/models/TcxUsersEntity.js +59 -0
  444. package/dist/src/models/TcxWizardConfigModel.d.ts +39 -0
  445. package/dist/src/models/TcxWizardConfigModel.js +52 -0
  446. package/dist/src/models/TcxWizardModel.d.ts +150 -0
  447. package/dist/src/models/TcxWizardModel.js +114 -0
  448. package/dist/src/models/TechSupportCompanySummaryDTO.d.ts +57 -0
  449. package/dist/src/models/TechSupportCompanySummaryDTO.js +58 -0
  450. package/dist/src/models/TelephonySupportTicketModel.d.ts +94 -0
  451. package/dist/src/models/TelephonySupportTicketModel.js +71 -0
  452. package/dist/src/models/TicketSummaryModel.d.ts +74 -0
  453. package/dist/src/models/TicketSummaryModel.js +63 -0
  454. package/dist/src/models/TicketTimeDTO.d.ts +80 -0
  455. package/dist/src/models/TicketTimeDTO.js +65 -0
  456. package/dist/src/models/TokenResponseModel.d.ts +44 -0
  457. package/dist/src/models/TokenResponseModel.js +53 -0
  458. package/dist/src/models/UpdateTypeEnum.d.ts +19 -0
  459. package/dist/src/models/UpdateTypeEnum.js +24 -0
  460. package/dist/src/models/UpgradeOrderResponseModel.d.ts +38 -0
  461. package/dist/src/models/UpgradeOrderResponseModel.js +51 -0
  462. package/dist/src/models/UpgradeRequestModel.d.ts +66 -0
  463. package/dist/src/models/UpgradeRequestModel.js +70 -0
  464. package/dist/src/models/UserEntity.d.ts +98 -0
  465. package/dist/src/models/UserEntity.js +71 -0
  466. package/dist/src/models/XeroLogEntity.d.ts +86 -0
  467. package/dist/src/models/XeroLogEntity.js +67 -0
  468. package/dist/src/models/index.d.ts +196 -0
  469. package/dist/src/models/index.js +214 -0
  470. package/dist/src/runtime.d.ts +184 -0
  471. package/dist/src/runtime.js +564 -0
  472. package/docs/AccountFinanceDTO.md +37 -0
  473. package/docs/AccountPageDetailsDTO.md +41 -0
  474. package/docs/AccountsApi.md +1332 -54
  475. package/docs/AddressDTO.md +31 -0
  476. package/docs/AdminUserModel.md +2 -0
  477. package/docs/CRMApi.md +121 -1
  478. package/docs/Class3CXApi.md +1 -1
  479. package/docs/Class3CXInstallationWizardApi.md +1 -1
  480. package/docs/Class3CXInstallationsApi.md +1 -1
  481. package/docs/Class3CXIntegrationsApi.md +1 -1
  482. package/docs/Class3CXMultiTenantApi.md +1 -1
  483. package/docs/CreateCrmNoteBody.md +20 -0
  484. package/docs/CrmActivitiesResponseDto.md +23 -0
  485. package/docs/CrmActivityDto.md +33 -0
  486. package/docs/CrmDateActivitiesDTO.md +23 -0
  487. package/docs/CrmNoteEntity.md +39 -0
  488. package/docs/CrmNoteModel.md +39 -0
  489. package/docs/MyPBXToolsApi.md +1 -1
  490. package/docs/NumberPortAdminNoteBody.md +20 -0
  491. package/docs/NumberPortingApi.md +6 -6
  492. package/docs/OAuth20Api.md +1 -1
  493. package/docs/OrdersApi.md +1 -57
  494. package/docs/PartnerDTO.md +39 -0
  495. package/docs/PatchSendWelcomeEmailRequest.md +20 -0
  496. package/docs/PatchUpdateAccountCnameRequest.md +20 -0
  497. package/docs/PatchUpdateAccountCompanyNumberRequest.md +20 -0
  498. package/docs/PatchUpdateAccountPhoneRequest.md +20 -0
  499. package/docs/PatchUpdateAccountVatNumberRequest.md +20 -0
  500. package/docs/PatchUpdateCreditLimitRequest.md +20 -0
  501. package/docs/PatchUpdatePriceListRequest.md +20 -0
  502. package/docs/PatchUpdateSipChannelCostRequest.md +20 -0
  503. package/docs/PatchUpdateTcxHostingPriceListRequest.md +20 -0
  504. package/docs/PatchUpdateTcxPartnerIdRequest.md +20 -0
  505. package/docs/PostCreateCrmNoteRequest.md +20 -0
  506. package/docs/PostSendWelcomeEmailRequest.md +20 -0
  507. package/docs/PricingApi.md +1 -1
  508. package/docs/ProductsApi.md +1 -1
  509. package/docs/ProspectDTO.md +2 -0
  510. package/docs/ProspectsApi.md +1 -1
  511. package/docs/ProvisioningApi.md +1 -1
  512. package/docs/SIPTrunksApi.md +1 -1
  513. package/docs/SMSApi.md +1 -1
  514. package/docs/ServicesApi.md +1 -1
  515. package/docs/ShippingApi.md +1 -1
  516. package/docs/StockManagementApi.md +1 -1
  517. package/docs/SystemApi.md +1 -1
  518. package/docs/TicketsApi.md +1 -1
  519. package/docs/WebhooksApi.md +1 -1
  520. package/index.ts +1 -1
  521. package/openapitools.json +1 -1
  522. package/package.json +2 -2
  523. package/docs/NumberPortModel.md +0 -51
  524. package/docs/OrderDTO.md +0 -25
  525. package/docs/OrderResponseDTO.md +0 -25
  526. package/docs/SbcDTO.md +0 -35
  527. package/docs/ShippingAddressDTO.md +0 -35
  528. package/docs/TelephonySupportTicketModel.md +0 -41
  529. package/hs_err_pid16044.log +0 -249
  530. package/hs_err_pid44560.log +0 -249
  531. package/hs_err_pid53988.log +0 -249
  532. package/hs_err_pid58728.log +0 -40
@@ -1,28 +1,161 @@
1
1
  # AccountsApi
2
2
 
3
- All URIs are relative to *https://api.local.yellowgrid.co.uk*
3
+ All URIs are relative to *https://localhost*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
7
+ |[**deleteAdminUpdateAccountContact**](#deleteadminupdateaccountcontact) | **DELETE** /admin/accounts/{id}/contacts/{contact_id} | |
8
+ |[**deleteArchiveAccount**](#deletearchiveaccount) | **DELETE** /admin/accounts/{id}/archive | |
7
9
  |[**deleteDeleteClientCredentials**](#deletedeleteclientcredentials) | **DELETE** /accounts/me/contacts/credentials/{id} | Delete client credentials|
8
10
  |[**deleteUpdateAccountContact**](#deleteupdateaccountcontact) | **DELETE** /accounts/me/contacts/{email} | Delete Account Contact|
11
+ |[**getAdminCreateAccountContact**](#getadmincreateaccountcontact) | **GET** /admin/accounts/{id}/contacts | |
9
12
  |[**getGetAccount**](#getgetaccount) | **GET** /accounts/me | Get Account|
10
13
  |[**getGetAccountContacts**](#getgetaccountcontacts) | **GET** /accounts/me/contacts | Get Account Contacts|
11
14
  |[**getGetAccountDetailedSummary**](#getgetaccountdetailedsummary) | **GET** /accounts/{id}/summary | Get Account Detailed Summary|
15
+ |[**getGetAccountPageInfo**](#getgetaccountpageinfo) | **GET** /admin/accounts/{id} | |
12
16
  |[**getGetAccounts**](#getgetaccounts) | **GET** /accounts | Get Accounts|
13
17
  |[**getGetClientCredentials**](#getgetclientcredentials) | **GET** /accounts/me/contacts/credentials | Get user\'s client credentials|
14
18
  |[**getGetCustomerKeys**](#getgetcustomerkeys) | **GET** /accounts/me/tcx/keys | Get 3CX Keys|
19
+ |[**getGetFinanceSettings**](#getgetfinancesettings) | **GET** /admin/accounts/{id}/finance | |
20
+ |[**getGetTcxPartnerDetails**](#getgettcxpartnerdetails) | **GET** /admin/accounts/{id}/tcx/partner | |
15
21
  |[**getVerifyEmailAddress**](#getverifyemailaddress) | **GET** /accounts/contacts/verify | Verify account email address|
22
+ |[**patchSetPortalAccess**](#patchsetportalaccess) | **PATCH** /admin/accounts/{id}/portal/access/{state} | |
23
+ |[**patchSetPrizePromo**](#patchsetprizepromo) | **PATCH** /admin/accounts/{id}/prizes/{state} | |
16
24
  |[**patchSetTcxWizardCname**](#patchsettcxwizardcname) | **PATCH** /accounts/me/cname | |
25
+ |[**patchUpdateAccountCname**](#patchupdateaccountcname) | **PATCH** /admin/accounts/{id}/cname | |
26
+ |[**patchUpdateAccountCompanyNumber**](#patchupdateaccountcompanynumber) | **PATCH** /admin/accounts/{id}/companyNumber | |
17
27
  |[**patchUpdateAccountContactPassword**](#patchupdateaccountcontactpassword) | **PATCH** /accounts/contacts/password | Update Account Password|
28
+ |[**patchUpdateAccountPhone**](#patchupdateaccountphone) | **PATCH** /admin/accounts/{id}/phone | |
29
+ |[**patchUpdateAccountVatNumber**](#patchupdateaccountvatnumber) | **PATCH** /admin/accounts/{id}/vatNumber | |
30
+ |[**patchUpdateCreditLimit**](#patchupdatecreditlimit) | **PATCH** /admin/accounts/{id}/creditLimit | |
31
+ |[**patchUpdatePriceList**](#patchupdatepricelist) | **PATCH** /admin/accounts/{id}/priceList | |
32
+ |[**patchUpdateSipChannelCost**](#patchupdatesipchannelcost) | **PATCH** /admin/accounts/{id}/channelCost | |
33
+ |[**patchUpdateTcxHostingPriceList**](#patchupdatetcxhostingpricelist) | **PATCH** /admin/accounts/{id}/tcx/hosting/priceList | |
34
+ |[**patchUpdateTcxPartnerId**](#patchupdatetcxpartnerid) | **PATCH** /admin/accounts{id}/tcx/partner/id | |
35
+ |[**postAdminCreateAccountContact**](#postadmincreateaccountcontact) | **POST** /admin/accounts/{id}/contacts | |
18
36
  |[**postGetAccountContacts**](#postgetaccountcontacts) | **POST** /accounts/me/contacts | Add Account Contact|
19
37
  |[**postGetAccounts**](#postgetaccounts) | **POST** /accounts | Create a new customer account|
20
38
  |[**postGetAdminAccount**](#postgetadminaccount) | **POST** /admin/me | Get Admin Account|
21
39
  |[**postGetClientCredentials**](#postgetclientcredentials) | **POST** /accounts/me/contacts/credentials | Create client credentials|
22
40
  |[**postSendEmailVerificationEmail**](#postsendemailverificationemail) | **POST** /accounts/contacts/verify/{email} | Send email verification email|
23
41
  |[**postSendPasswordReset**](#postsendpasswordreset) | **POST** /accounts/contacts/password/reset | Send password reset email|
42
+ |[**postSendWelcomeEmail**](#postsendwelcomeemail) | **POST** /admin/accounts/{id}/email/welcome | |
24
43
  |[**postSubmitResellerApplication**](#postsubmitresellerapplication) | **POST** /accounts/reseller | Submit reseller application|
44
+ |[**putAdminUpdateAccountContact**](#putadminupdateaccountcontact) | **PUT** /admin/accounts/{id}/contacts/{contact_id} | |
25
45
  |[**putUpdateAccountContact**](#putupdateaccountcontact) | **PUT** /accounts/me/contacts/{email} | Update Account Contact|
46
+ |[**putUpdateBillingAddress**](#putupdatebillingaddress) | **PUT** /admin/accounts/{id}/billing/address | |
47
+ |[**putUpdateShippingAddress**](#putupdateshippingaddress) | **PUT** /admin/accounts/{id}/shipping/address | |
48
+
49
+ # **deleteAdminUpdateAccountContact**
50
+ > deleteAdminUpdateAccountContact()
51
+
52
+ Delete Account Contact
53
+
54
+ ### Example
55
+
56
+ ```typescript
57
+ import {
58
+ AccountsApi,
59
+ Configuration
60
+ } from 'yellowgrid-api-ts';
61
+
62
+ const configuration = new Configuration();
63
+ const apiInstance = new AccountsApi(configuration);
64
+
65
+ let id: string; //Account Xero ID (default to undefined)
66
+ let contactId: number; //Contact ID (default to undefined)
67
+
68
+ const { status, data } = await apiInstance.deleteAdminUpdateAccountContact(
69
+ id,
70
+ contactId
71
+ );
72
+ ```
73
+
74
+ ### Parameters
75
+
76
+ |Name | Type | Description | Notes|
77
+ |------------- | ------------- | ------------- | -------------|
78
+ | **id** | [**string**] | Account Xero ID | defaults to undefined|
79
+ | **contactId** | [**number**] | Contact ID | defaults to undefined|
80
+
81
+
82
+ ### Return type
83
+
84
+ void (empty response body)
85
+
86
+ ### Authorization
87
+
88
+ No authorization required
89
+
90
+ ### HTTP request headers
91
+
92
+ - **Content-Type**: Not defined
93
+ - **Accept**: Not defined
94
+
95
+
96
+ ### HTTP response details
97
+ | Status code | Description | Response headers |
98
+ |-------------|-------------|------------------|
99
+ |**204** | No Response | - |
100
+ |**400** | Bad Request | - |
101
+ |**401** | Unauthorised | - |
102
+ |**403** | Access Denied | - |
103
+
104
+ [[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)
105
+
106
+ # **deleteArchiveAccount**
107
+ > deleteArchiveAccount()
108
+
109
+ Delete Account
110
+
111
+ ### Example
112
+
113
+ ```typescript
114
+ import {
115
+ AccountsApi,
116
+ Configuration
117
+ } from 'yellowgrid-api-ts';
118
+
119
+ const configuration = new Configuration();
120
+ const apiInstance = new AccountsApi(configuration);
121
+
122
+ let id: string; //Account Xero ID (default to undefined)
123
+
124
+ const { status, data } = await apiInstance.deleteArchiveAccount(
125
+ id
126
+ );
127
+ ```
128
+
129
+ ### Parameters
130
+
131
+ |Name | Type | Description | Notes|
132
+ |------------- | ------------- | ------------- | -------------|
133
+ | **id** | [**string**] | Account Xero ID | defaults to undefined|
134
+
135
+
136
+ ### Return type
137
+
138
+ void (empty response body)
139
+
140
+ ### Authorization
141
+
142
+ No authorization required
143
+
144
+ ### HTTP request headers
145
+
146
+ - **Content-Type**: Not defined
147
+ - **Accept**: Not defined
148
+
149
+
150
+ ### HTTP response details
151
+ | Status code | Description | Response headers |
152
+ |-------------|-------------|------------------|
153
+ |**204** | No Response | - |
154
+ |**400** | Bad Request | - |
155
+ |**401** | Unauthorised | - |
156
+ |**403** | Access Denied | - |
157
+
158
+ [[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)
26
159
 
27
160
  # **deleteDeleteClientCredentials**
28
161
  > deleteDeleteClientCredentials()
@@ -132,6 +265,60 @@ No authorization required
132
265
 
133
266
  [[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)
134
267
 
268
+ # **getAdminCreateAccountContact**
269
+ > Array<AccountContactModel> getAdminCreateAccountContact()
270
+
271
+ Get Account Contacts
272
+
273
+ ### Example
274
+
275
+ ```typescript
276
+ import {
277
+ AccountsApi,
278
+ Configuration
279
+ } from 'yellowgrid-api-ts';
280
+
281
+ const configuration = new Configuration();
282
+ const apiInstance = new AccountsApi(configuration);
283
+
284
+ let id: string; //Account Xero ID (default to undefined)
285
+
286
+ const { status, data } = await apiInstance.getAdminCreateAccountContact(
287
+ id
288
+ );
289
+ ```
290
+
291
+ ### Parameters
292
+
293
+ |Name | Type | Description | Notes|
294
+ |------------- | ------------- | ------------- | -------------|
295
+ | **id** | [**string**] | Account Xero ID | defaults to undefined|
296
+
297
+
298
+ ### Return type
299
+
300
+ **Array<AccountContactModel>**
301
+
302
+ ### Authorization
303
+
304
+ No authorization required
305
+
306
+ ### HTTP request headers
307
+
308
+ - **Content-Type**: Not defined
309
+ - **Accept**: application/json
310
+
311
+
312
+ ### HTTP response details
313
+ | Status code | Description | Response headers |
314
+ |-------------|-------------|------------------|
315
+ |**200** | Account | - |
316
+ |**400** | Bad Request | - |
317
+ |**401** | Unauthorised | - |
318
+ |**403** | Access Denied | - |
319
+
320
+ [[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)
321
+
135
322
  # **getGetAccount**
136
323
  > PortalAccountModel getGetAccount()
137
324
 
@@ -287,6 +474,60 @@ No authorization required
287
474
 
288
475
  [[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)
289
476
 
477
+ # **getGetAccountPageInfo**
478
+ > AccountPageDetailsDTO getGetAccountPageInfo()
479
+
480
+ Get Account Page Details
481
+
482
+ ### Example
483
+
484
+ ```typescript
485
+ import {
486
+ AccountsApi,
487
+ Configuration
488
+ } from 'yellowgrid-api-ts';
489
+
490
+ const configuration = new Configuration();
491
+ const apiInstance = new AccountsApi(configuration);
492
+
493
+ let id: string; //Xero ID (default to undefined)
494
+
495
+ const { status, data } = await apiInstance.getGetAccountPageInfo(
496
+ id
497
+ );
498
+ ```
499
+
500
+ ### Parameters
501
+
502
+ |Name | Type | Description | Notes|
503
+ |------------- | ------------- | ------------- | -------------|
504
+ | **id** | [**string**] | Xero ID | defaults to undefined|
505
+
506
+
507
+ ### Return type
508
+
509
+ **AccountPageDetailsDTO**
510
+
511
+ ### Authorization
512
+
513
+ No authorization required
514
+
515
+ ### HTTP request headers
516
+
517
+ - **Content-Type**: Not defined
518
+ - **Accept**: application/json
519
+
520
+
521
+ ### HTTP response details
522
+ | Status code | Description | Response headers |
523
+ |-------------|-------------|------------------|
524
+ |**200** | Accounts Page Details | - |
525
+ |**400** | Bad Request | - |
526
+ |**401** | Unauthorised | - |
527
+ |**403** | Access Denied | - |
528
+
529
+ [[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)
530
+
290
531
  # **getGetAccounts**
291
532
  > AccountsResponseModel getGetAccounts()
292
533
 
@@ -350,32 +591,816 @@ No authorization required
350
591
 
351
592
  [[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)
352
593
 
353
- # **getGetClientCredentials**
354
- > Array<ClientModel> getGetClientCredentials()
594
+ # **getGetClientCredentials**
595
+ > Array<ClientModel> getGetClientCredentials()
596
+
597
+ Get user\'s client credentials
598
+
599
+ ### Example
600
+
601
+ ```typescript
602
+ import {
603
+ AccountsApi,
604
+ Configuration
605
+ } from 'yellowgrid-api-ts';
606
+
607
+ const configuration = new Configuration();
608
+ const apiInstance = new AccountsApi(configuration);
609
+
610
+ const { status, data } = await apiInstance.getGetClientCredentials();
611
+ ```
612
+
613
+ ### Parameters
614
+ This endpoint does not have any parameters.
615
+
616
+
617
+ ### Return type
618
+
619
+ **Array<ClientModel>**
620
+
621
+ ### Authorization
622
+
623
+ No authorization required
624
+
625
+ ### HTTP request headers
626
+
627
+ - **Content-Type**: Not defined
628
+ - **Accept**: application/json
629
+
630
+
631
+ ### HTTP response details
632
+ | Status code | Description | Response headers |
633
+ |-------------|-------------|------------------|
634
+ |**200** | List of client credentials | - |
635
+ |**400** | Bad Request | - |
636
+ |**401** | Unauthorised | - |
637
+ |**403** | Access Denied | - |
638
+
639
+ [[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)
640
+
641
+ # **getGetCustomerKeys**
642
+ > Array<TcxKeySummaryDTO> getGetCustomerKeys()
643
+
644
+ Get 3CX Keys
645
+
646
+ ### Example
647
+
648
+ ```typescript
649
+ import {
650
+ AccountsApi,
651
+ Configuration
652
+ } from 'yellowgrid-api-ts';
653
+
654
+ const configuration = new Configuration();
655
+ const apiInstance = new AccountsApi(configuration);
656
+
657
+ const { status, data } = await apiInstance.getGetCustomerKeys();
658
+ ```
659
+
660
+ ### Parameters
661
+ This endpoint does not have any parameters.
662
+
663
+
664
+ ### Return type
665
+
666
+ **Array<TcxKeySummaryDTO>**
667
+
668
+ ### Authorization
669
+
670
+ No authorization required
671
+
672
+ ### HTTP request headers
673
+
674
+ - **Content-Type**: Not defined
675
+ - **Accept**: application/json
676
+
677
+
678
+ ### HTTP response details
679
+ | Status code | Description | Response headers |
680
+ |-------------|-------------|------------------|
681
+ |**200** | 3CX Key Summaries | - |
682
+ |**400** | Bad Request | - |
683
+ |**401** | Unauthorised | - |
684
+ |**403** | Access Denied | - |
685
+
686
+ [[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)
687
+
688
+ # **getGetFinanceSettings**
689
+ > AccountFinanceDTO getGetFinanceSettings()
690
+
691
+ Get Account Finance
692
+
693
+ ### Example
694
+
695
+ ```typescript
696
+ import {
697
+ AccountsApi,
698
+ Configuration
699
+ } from 'yellowgrid-api-ts';
700
+
701
+ const configuration = new Configuration();
702
+ const apiInstance = new AccountsApi(configuration);
703
+
704
+ let id: string; //Account Xero ID (default to undefined)
705
+
706
+ const { status, data } = await apiInstance.getGetFinanceSettings(
707
+ id
708
+ );
709
+ ```
710
+
711
+ ### Parameters
712
+
713
+ |Name | Type | Description | Notes|
714
+ |------------- | ------------- | ------------- | -------------|
715
+ | **id** | [**string**] | Account Xero ID | defaults to undefined|
716
+
717
+
718
+ ### Return type
719
+
720
+ **AccountFinanceDTO**
721
+
722
+ ### Authorization
723
+
724
+ No authorization required
725
+
726
+ ### HTTP request headers
727
+
728
+ - **Content-Type**: Not defined
729
+ - **Accept**: application/json
730
+
731
+
732
+ ### HTTP response details
733
+ | Status code | Description | Response headers |
734
+ |-------------|-------------|------------------|
735
+ |**200** | Accounts Finance Details | - |
736
+ |**400** | Bad Request | - |
737
+ |**401** | Unauthorised | - |
738
+ |**403** | Access Denied | - |
739
+
740
+ [[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)
741
+
742
+ # **getGetTcxPartnerDetails**
743
+ > PartnerDTO getGetTcxPartnerDetails()
744
+
745
+ Get Account 3CX Details
746
+
747
+ ### Example
748
+
749
+ ```typescript
750
+ import {
751
+ AccountsApi,
752
+ Configuration
753
+ } from 'yellowgrid-api-ts';
754
+
755
+ const configuration = new Configuration();
756
+ const apiInstance = new AccountsApi(configuration);
757
+
758
+ let id: string; //Xero ID (default to undefined)
759
+
760
+ const { status, data } = await apiInstance.getGetTcxPartnerDetails(
761
+ id
762
+ );
763
+ ```
764
+
765
+ ### Parameters
766
+
767
+ |Name | Type | Description | Notes|
768
+ |------------- | ------------- | ------------- | -------------|
769
+ | **id** | [**string**] | Xero ID | defaults to undefined|
770
+
771
+
772
+ ### Return type
773
+
774
+ **PartnerDTO**
775
+
776
+ ### Authorization
777
+
778
+ No authorization required
779
+
780
+ ### HTTP request headers
781
+
782
+ - **Content-Type**: Not defined
783
+ - **Accept**: application/json
784
+
785
+
786
+ ### HTTP response details
787
+ | Status code | Description | Response headers |
788
+ |-------------|-------------|------------------|
789
+ |**200** | Account 3CX Partner Details | - |
790
+ |**400** | Bad Request | - |
791
+ |**401** | Unauthorised | - |
792
+ |**403** | Access Denied | - |
793
+
794
+ [[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)
795
+
796
+ # **getVerifyEmailAddress**
797
+ > getVerifyEmailAddress()
798
+
799
+ Verify account email address
800
+
801
+ ### Example
802
+
803
+ ```typescript
804
+ import {
805
+ AccountsApi,
806
+ Configuration
807
+ } from 'yellowgrid-api-ts';
808
+
809
+ const configuration = new Configuration();
810
+ const apiInstance = new AccountsApi(configuration);
811
+
812
+ let token: string; //Verification Token (default to undefined)
813
+
814
+ const { status, data } = await apiInstance.getVerifyEmailAddress(
815
+ token
816
+ );
817
+ ```
818
+
819
+ ### Parameters
820
+
821
+ |Name | Type | Description | Notes|
822
+ |------------- | ------------- | ------------- | -------------|
823
+ | **token** | [**string**] | Verification Token | defaults to undefined|
824
+
825
+
826
+ ### Return type
827
+
828
+ void (empty response body)
829
+
830
+ ### Authorization
831
+
832
+ No authorization required
833
+
834
+ ### HTTP request headers
835
+
836
+ - **Content-Type**: Not defined
837
+ - **Accept**: Not defined
838
+
839
+
840
+ ### HTTP response details
841
+ | Status code | Description | Response headers |
842
+ |-------------|-------------|------------------|
843
+ |**200** | No Response | - |
844
+ |**400** | Bad Request | - |
845
+ |**401** | Unauthorised | - |
846
+ |**403** | Access Denied | - |
847
+
848
+ [[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)
849
+
850
+ # **patchSetPortalAccess**
851
+ > patchSetPortalAccess()
852
+
853
+ Set Account Portal Access
854
+
855
+ ### Example
856
+
857
+ ```typescript
858
+ import {
859
+ AccountsApi,
860
+ Configuration
861
+ } from 'yellowgrid-api-ts';
862
+
863
+ const configuration = new Configuration();
864
+ const apiInstance = new AccountsApi(configuration);
865
+
866
+ let id: string; //Xero ID (default to undefined)
867
+ let state: 'enable' | 'disable'; //Portal Access State (default to undefined)
868
+
869
+ const { status, data } = await apiInstance.patchSetPortalAccess(
870
+ id,
871
+ state
872
+ );
873
+ ```
874
+
875
+ ### Parameters
876
+
877
+ |Name | Type | Description | Notes|
878
+ |------------- | ------------- | ------------- | -------------|
879
+ | **id** | [**string**] | Xero ID | defaults to undefined|
880
+ | **state** | [**&#39;enable&#39; | &#39;disable&#39;**]**Array<&#39;enable&#39; &#124; &#39;disable&#39;>** | Portal Access State | defaults to undefined|
881
+
882
+
883
+ ### Return type
884
+
885
+ void (empty response body)
886
+
887
+ ### Authorization
888
+
889
+ No authorization required
890
+
891
+ ### HTTP request headers
892
+
893
+ - **Content-Type**: Not defined
894
+ - **Accept**: Not defined
895
+
896
+
897
+ ### HTTP response details
898
+ | Status code | Description | Response headers |
899
+ |-------------|-------------|------------------|
900
+ |**204** | No Response | - |
901
+ |**400** | Bad Request | - |
902
+ |**401** | Unauthorised | - |
903
+ |**403** | Access Denied | - |
904
+
905
+ [[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)
906
+
907
+ # **patchSetPrizePromo**
908
+ > patchSetPrizePromo()
909
+
910
+ Set Account Prize Promo
911
+
912
+ ### Example
913
+
914
+ ```typescript
915
+ import {
916
+ AccountsApi,
917
+ Configuration
918
+ } from 'yellowgrid-api-ts';
919
+
920
+ const configuration = new Configuration();
921
+ const apiInstance = new AccountsApi(configuration);
922
+
923
+ let id: string; //Xero ID (default to undefined)
924
+ let state: 'enable' | 'disable'; //Prize Promo State (default to undefined)
925
+
926
+ const { status, data } = await apiInstance.patchSetPrizePromo(
927
+ id,
928
+ state
929
+ );
930
+ ```
931
+
932
+ ### Parameters
933
+
934
+ |Name | Type | Description | Notes|
935
+ |------------- | ------------- | ------------- | -------------|
936
+ | **id** | [**string**] | Xero ID | defaults to undefined|
937
+ | **state** | [**&#39;enable&#39; | &#39;disable&#39;**]**Array<&#39;enable&#39; &#124; &#39;disable&#39;>** | Prize Promo State | defaults to undefined|
938
+
939
+
940
+ ### Return type
941
+
942
+ void (empty response body)
943
+
944
+ ### Authorization
945
+
946
+ No authorization required
947
+
948
+ ### HTTP request headers
949
+
950
+ - **Content-Type**: Not defined
951
+ - **Accept**: Not defined
952
+
953
+
954
+ ### HTTP response details
955
+ | Status code | Description | Response headers |
956
+ |-------------|-------------|------------------|
957
+ |**204** | No Response | - |
958
+ |**400** | Bad Request | - |
959
+ |**401** | Unauthorised | - |
960
+ |**403** | Access Denied | - |
961
+
962
+ [[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)
963
+
964
+ # **patchSetTcxWizardCname**
965
+ > patchSetTcxWizardCname()
966
+
967
+ Set 3CX Wizard CNAME
968
+
969
+ ### Example
970
+
971
+ ```typescript
972
+ import {
973
+ AccountsApi,
974
+ Configuration,
975
+ PatchUpdateAccountCnameRequest
976
+ } from 'yellowgrid-api-ts';
977
+
978
+ const configuration = new Configuration();
979
+ const apiInstance = new AccountsApi(configuration);
980
+
981
+ let patchUpdateAccountCnameRequest: PatchUpdateAccountCnameRequest; //CNAME Request (optional)
982
+
983
+ const { status, data } = await apiInstance.patchSetTcxWizardCname(
984
+ patchUpdateAccountCnameRequest
985
+ );
986
+ ```
987
+
988
+ ### Parameters
989
+
990
+ |Name | Type | Description | Notes|
991
+ |------------- | ------------- | ------------- | -------------|
992
+ | **patchUpdateAccountCnameRequest** | **PatchUpdateAccountCnameRequest**| CNAME Request | |
993
+
994
+
995
+ ### Return type
996
+
997
+ void (empty response body)
998
+
999
+ ### Authorization
1000
+
1001
+ No authorization required
1002
+
1003
+ ### HTTP request headers
1004
+
1005
+ - **Content-Type**: application/json
1006
+ - **Accept**: Not defined
1007
+
1008
+
1009
+ ### HTTP response details
1010
+ | Status code | Description | Response headers |
1011
+ |-------------|-------------|------------------|
1012
+ |**200** | No Response | - |
1013
+ |**400** | Bad Request | - |
1014
+ |**401** | Unauthorised | - |
1015
+ |**403** | Access Denied | - |
1016
+
1017
+ [[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)
1018
+
1019
+ # **patchUpdateAccountCname**
1020
+ > patchUpdateAccountCname()
1021
+
1022
+ Set Account CNAME
1023
+
1024
+ ### Example
1025
+
1026
+ ```typescript
1027
+ import {
1028
+ AccountsApi,
1029
+ Configuration,
1030
+ PatchUpdateAccountCnameRequest
1031
+ } from 'yellowgrid-api-ts';
1032
+
1033
+ const configuration = new Configuration();
1034
+ const apiInstance = new AccountsApi(configuration);
1035
+
1036
+ let id: string; //Xero ID (default to undefined)
1037
+ let patchUpdateAccountCnameRequest: PatchUpdateAccountCnameRequest; //CNAME Request (optional)
1038
+
1039
+ const { status, data } = await apiInstance.patchUpdateAccountCname(
1040
+ id,
1041
+ patchUpdateAccountCnameRequest
1042
+ );
1043
+ ```
1044
+
1045
+ ### Parameters
1046
+
1047
+ |Name | Type | Description | Notes|
1048
+ |------------- | ------------- | ------------- | -------------|
1049
+ | **patchUpdateAccountCnameRequest** | **PatchUpdateAccountCnameRequest**| CNAME Request | |
1050
+ | **id** | [**string**] | Xero ID | defaults to undefined|
1051
+
1052
+
1053
+ ### Return type
1054
+
1055
+ void (empty response body)
1056
+
1057
+ ### Authorization
1058
+
1059
+ No authorization required
1060
+
1061
+ ### HTTP request headers
1062
+
1063
+ - **Content-Type**: application/json
1064
+ - **Accept**: Not defined
1065
+
1066
+
1067
+ ### HTTP response details
1068
+ | Status code | Description | Response headers |
1069
+ |-------------|-------------|------------------|
1070
+ |**204** | No Response | - |
1071
+ |**400** | Bad Request | - |
1072
+ |**401** | Unauthorised | - |
1073
+ |**403** | Access Denied | - |
1074
+
1075
+ [[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)
1076
+
1077
+ # **patchUpdateAccountCompanyNumber**
1078
+ > patchUpdateAccountCompanyNumber()
1079
+
1080
+ Set Account Company Number
1081
+
1082
+ ### Example
1083
+
1084
+ ```typescript
1085
+ import {
1086
+ AccountsApi,
1087
+ Configuration,
1088
+ PatchUpdateAccountCompanyNumberRequest
1089
+ } from 'yellowgrid-api-ts';
1090
+
1091
+ const configuration = new Configuration();
1092
+ const apiInstance = new AccountsApi(configuration);
1093
+
1094
+ let id: string; //Xero ID (default to undefined)
1095
+ let patchUpdateAccountCompanyNumberRequest: PatchUpdateAccountCompanyNumberRequest; //Account Company Number Request (optional)
1096
+
1097
+ const { status, data } = await apiInstance.patchUpdateAccountCompanyNumber(
1098
+ id,
1099
+ patchUpdateAccountCompanyNumberRequest
1100
+ );
1101
+ ```
1102
+
1103
+ ### Parameters
1104
+
1105
+ |Name | Type | Description | Notes|
1106
+ |------------- | ------------- | ------------- | -------------|
1107
+ | **patchUpdateAccountCompanyNumberRequest** | **PatchUpdateAccountCompanyNumberRequest**| Account Company Number Request | |
1108
+ | **id** | [**string**] | Xero ID | defaults to undefined|
1109
+
1110
+
1111
+ ### Return type
1112
+
1113
+ void (empty response body)
1114
+
1115
+ ### Authorization
1116
+
1117
+ No authorization required
1118
+
1119
+ ### HTTP request headers
1120
+
1121
+ - **Content-Type**: application/json
1122
+ - **Accept**: Not defined
1123
+
1124
+
1125
+ ### HTTP response details
1126
+ | Status code | Description | Response headers |
1127
+ |-------------|-------------|------------------|
1128
+ |**204** | No Response | - |
1129
+ |**400** | Bad Request | - |
1130
+ |**401** | Unauthorised | - |
1131
+ |**403** | Access Denied | - |
1132
+
1133
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
1134
+
1135
+ # **patchUpdateAccountContactPassword**
1136
+ > patchUpdateAccountContactPassword()
1137
+
1138
+ Update Account Password
1139
+
1140
+ ### Example
1141
+
1142
+ ```typescript
1143
+ import {
1144
+ AccountsApi,
1145
+ Configuration,
1146
+ PatchUpdateAccountContactPasswordRequest
1147
+ } from 'yellowgrid-api-ts';
1148
+
1149
+ const configuration = new Configuration();
1150
+ const apiInstance = new AccountsApi(configuration);
1151
+
1152
+ let token: string; //Verification Token (default to undefined)
1153
+ let patchUpdateAccountContactPasswordRequest: PatchUpdateAccountContactPasswordRequest; //New account request (optional)
1154
+
1155
+ const { status, data } = await apiInstance.patchUpdateAccountContactPassword(
1156
+ token,
1157
+ patchUpdateAccountContactPasswordRequest
1158
+ );
1159
+ ```
1160
+
1161
+ ### Parameters
1162
+
1163
+ |Name | Type | Description | Notes|
1164
+ |------------- | ------------- | ------------- | -------------|
1165
+ | **patchUpdateAccountContactPasswordRequest** | **PatchUpdateAccountContactPasswordRequest**| New account request | |
1166
+ | **token** | [**string**] | Verification Token | defaults to undefined|
1167
+
1168
+
1169
+ ### Return type
1170
+
1171
+ void (empty response body)
1172
+
1173
+ ### Authorization
1174
+
1175
+ No authorization required
1176
+
1177
+ ### HTTP request headers
1178
+
1179
+ - **Content-Type**: application/json
1180
+ - **Accept**: Not defined
1181
+
1182
+
1183
+ ### HTTP response details
1184
+ | Status code | Description | Response headers |
1185
+ |-------------|-------------|------------------|
1186
+ |**200** | No Response | - |
1187
+ |**400** | Bad Request | - |
1188
+ |**401** | Unauthorised | - |
1189
+ |**403** | Access Denied | - |
1190
+
1191
+ [[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)
1192
+
1193
+ # **patchUpdateAccountPhone**
1194
+ > patchUpdateAccountPhone()
1195
+
1196
+ Set Account Phone
1197
+
1198
+ ### Example
1199
+
1200
+ ```typescript
1201
+ import {
1202
+ AccountsApi,
1203
+ Configuration,
1204
+ PatchUpdateAccountPhoneRequest
1205
+ } from 'yellowgrid-api-ts';
1206
+
1207
+ const configuration = new Configuration();
1208
+ const apiInstance = new AccountsApi(configuration);
1209
+
1210
+ let id: string; //Xero ID (default to undefined)
1211
+ let patchUpdateAccountPhoneRequest: PatchUpdateAccountPhoneRequest; //Telephone Request (optional)
1212
+
1213
+ const { status, data } = await apiInstance.patchUpdateAccountPhone(
1214
+ id,
1215
+ patchUpdateAccountPhoneRequest
1216
+ );
1217
+ ```
1218
+
1219
+ ### Parameters
1220
+
1221
+ |Name | Type | Description | Notes|
1222
+ |------------- | ------------- | ------------- | -------------|
1223
+ | **patchUpdateAccountPhoneRequest** | **PatchUpdateAccountPhoneRequest**| Telephone Request | |
1224
+ | **id** | [**string**] | Xero ID | defaults to undefined|
1225
+
1226
+
1227
+ ### Return type
1228
+
1229
+ void (empty response body)
1230
+
1231
+ ### Authorization
1232
+
1233
+ No authorization required
1234
+
1235
+ ### HTTP request headers
1236
+
1237
+ - **Content-Type**: application/json
1238
+ - **Accept**: Not defined
1239
+
1240
+
1241
+ ### HTTP response details
1242
+ | Status code | Description | Response headers |
1243
+ |-------------|-------------|------------------|
1244
+ |**204** | No Response | - |
1245
+ |**400** | Bad Request | - |
1246
+ |**401** | Unauthorised | - |
1247
+ |**403** | Access Denied | - |
1248
+
1249
+ [[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)
1250
+
1251
+ # **patchUpdateAccountVatNumber**
1252
+ > patchUpdateAccountVatNumber()
1253
+
1254
+ Set Account VAT Number
1255
+
1256
+ ### Example
1257
+
1258
+ ```typescript
1259
+ import {
1260
+ AccountsApi,
1261
+ Configuration,
1262
+ PatchUpdateAccountVatNumberRequest
1263
+ } from 'yellowgrid-api-ts';
1264
+
1265
+ const configuration = new Configuration();
1266
+ const apiInstance = new AccountsApi(configuration);
1267
+
1268
+ let id: string; //Xero ID (default to undefined)
1269
+ let patchUpdateAccountVatNumberRequest: PatchUpdateAccountVatNumberRequest; //VAT Number Request (optional)
1270
+
1271
+ const { status, data } = await apiInstance.patchUpdateAccountVatNumber(
1272
+ id,
1273
+ patchUpdateAccountVatNumberRequest
1274
+ );
1275
+ ```
1276
+
1277
+ ### Parameters
1278
+
1279
+ |Name | Type | Description | Notes|
1280
+ |------------- | ------------- | ------------- | -------------|
1281
+ | **patchUpdateAccountVatNumberRequest** | **PatchUpdateAccountVatNumberRequest**| VAT Number Request | |
1282
+ | **id** | [**string**] | Xero ID | defaults to undefined|
1283
+
1284
+
1285
+ ### Return type
1286
+
1287
+ void (empty response body)
1288
+
1289
+ ### Authorization
1290
+
1291
+ No authorization required
1292
+
1293
+ ### HTTP request headers
1294
+
1295
+ - **Content-Type**: application/json
1296
+ - **Accept**: Not defined
1297
+
1298
+
1299
+ ### HTTP response details
1300
+ | Status code | Description | Response headers |
1301
+ |-------------|-------------|------------------|
1302
+ |**204** | No Response | - |
1303
+ |**400** | Bad Request | - |
1304
+ |**401** | Unauthorised | - |
1305
+ |**403** | Access Denied | - |
1306
+
1307
+ [[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)
1308
+
1309
+ # **patchUpdateCreditLimit**
1310
+ > AccountFinanceDTO patchUpdateCreditLimit()
1311
+
1312
+ Set Account Credit Limit
1313
+
1314
+ ### Example
1315
+
1316
+ ```typescript
1317
+ import {
1318
+ AccountsApi,
1319
+ Configuration,
1320
+ PatchUpdateCreditLimitRequest
1321
+ } from 'yellowgrid-api-ts';
1322
+
1323
+ const configuration = new Configuration();
1324
+ const apiInstance = new AccountsApi(configuration);
1325
+
1326
+ let id: string; //Xero ID (default to undefined)
1327
+ let patchUpdateCreditLimitRequest: PatchUpdateCreditLimitRequest; //Credit Limit Request (optional)
1328
+
1329
+ const { status, data } = await apiInstance.patchUpdateCreditLimit(
1330
+ id,
1331
+ patchUpdateCreditLimitRequest
1332
+ );
1333
+ ```
1334
+
1335
+ ### Parameters
1336
+
1337
+ |Name | Type | Description | Notes|
1338
+ |------------- | ------------- | ------------- | -------------|
1339
+ | **patchUpdateCreditLimitRequest** | **PatchUpdateCreditLimitRequest**| Credit Limit Request | |
1340
+ | **id** | [**string**] | Xero ID | defaults to undefined|
1341
+
1342
+
1343
+ ### Return type
1344
+
1345
+ **AccountFinanceDTO**
1346
+
1347
+ ### Authorization
1348
+
1349
+ No authorization required
1350
+
1351
+ ### HTTP request headers
1352
+
1353
+ - **Content-Type**: application/json
1354
+ - **Accept**: application/json
1355
+
1356
+
1357
+ ### HTTP response details
1358
+ | Status code | Description | Response headers |
1359
+ |-------------|-------------|------------------|
1360
+ |**200** | Accounts Finance Details | - |
1361
+ |**400** | Bad Request | - |
1362
+ |**401** | Unauthorised | - |
1363
+ |**403** | Access Denied | - |
1364
+
1365
+ [[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)
1366
+
1367
+ # **patchUpdatePriceList**
1368
+ > AccountFinanceDTO patchUpdatePriceList()
355
1369
 
356
- Get user\'s client credentials
1370
+ Set Account Price List
357
1371
 
358
1372
  ### Example
359
1373
 
360
1374
  ```typescript
361
1375
  import {
362
1376
  AccountsApi,
363
- Configuration
1377
+ Configuration,
1378
+ PatchUpdatePriceListRequest
364
1379
  } from 'yellowgrid-api-ts';
365
1380
 
366
1381
  const configuration = new Configuration();
367
1382
  const apiInstance = new AccountsApi(configuration);
368
1383
 
369
- const { status, data } = await apiInstance.getGetClientCredentials();
1384
+ let id: string; //Xero ID (default to undefined)
1385
+ let patchUpdatePriceListRequest: PatchUpdatePriceListRequest; //Price List Request (optional)
1386
+
1387
+ const { status, data } = await apiInstance.patchUpdatePriceList(
1388
+ id,
1389
+ patchUpdatePriceListRequest
1390
+ );
370
1391
  ```
371
1392
 
372
1393
  ### Parameters
373
- This endpoint does not have any parameters.
1394
+
1395
+ |Name | Type | Description | Notes|
1396
+ |------------- | ------------- | ------------- | -------------|
1397
+ | **patchUpdatePriceListRequest** | **PatchUpdatePriceListRequest**| Price List Request | |
1398
+ | **id** | [**string**] | Xero ID | defaults to undefined|
374
1399
 
375
1400
 
376
1401
  ### Return type
377
1402
 
378
- **Array<ClientModel>**
1403
+ **AccountFinanceDTO**
379
1404
 
380
1405
  ### Authorization
381
1406
 
@@ -383,46 +1408,57 @@ No authorization required
383
1408
 
384
1409
  ### HTTP request headers
385
1410
 
386
- - **Content-Type**: Not defined
1411
+ - **Content-Type**: application/json
387
1412
  - **Accept**: application/json
388
1413
 
389
1414
 
390
1415
  ### HTTP response details
391
1416
  | Status code | Description | Response headers |
392
1417
  |-------------|-------------|------------------|
393
- |**200** | List of client credentials | - |
1418
+ |**200** | Accounts Finance Details | - |
394
1419
  |**400** | Bad Request | - |
395
1420
  |**401** | Unauthorised | - |
396
1421
  |**403** | Access Denied | - |
397
1422
 
398
1423
  [[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)
399
1424
 
400
- # **getGetCustomerKeys**
401
- > Array<TcxKeySummaryDTO> getGetCustomerKeys()
1425
+ # **patchUpdateSipChannelCost**
1426
+ > AccountFinanceDTO patchUpdateSipChannelCost()
402
1427
 
403
- Get 3CX Keys
1428
+ Set Account SIP Channel Cost
404
1429
 
405
1430
  ### Example
406
1431
 
407
1432
  ```typescript
408
1433
  import {
409
1434
  AccountsApi,
410
- Configuration
1435
+ Configuration,
1436
+ PatchUpdateSipChannelCostRequest
411
1437
  } from 'yellowgrid-api-ts';
412
1438
 
413
1439
  const configuration = new Configuration();
414
1440
  const apiInstance = new AccountsApi(configuration);
415
1441
 
416
- const { status, data } = await apiInstance.getGetCustomerKeys();
1442
+ let id: string; //Xero ID (default to undefined)
1443
+ let patchUpdateSipChannelCostRequest: PatchUpdateSipChannelCostRequest; //SIP Channel Cost Request (optional)
1444
+
1445
+ const { status, data } = await apiInstance.patchUpdateSipChannelCost(
1446
+ id,
1447
+ patchUpdateSipChannelCostRequest
1448
+ );
417
1449
  ```
418
1450
 
419
1451
  ### Parameters
420
- This endpoint does not have any parameters.
1452
+
1453
+ |Name | Type | Description | Notes|
1454
+ |------------- | ------------- | ------------- | -------------|
1455
+ | **patchUpdateSipChannelCostRequest** | **PatchUpdateSipChannelCostRequest**| SIP Channel Cost Request | |
1456
+ | **id** | [**string**] | Xero ID | defaults to undefined|
421
1457
 
422
1458
 
423
1459
  ### Return type
424
1460
 
425
- **Array<TcxKeySummaryDTO>**
1461
+ **AccountFinanceDTO**
426
1462
 
427
1463
  ### Authorization
428
1464
 
@@ -430,40 +1466,43 @@ No authorization required
430
1466
 
431
1467
  ### HTTP request headers
432
1468
 
433
- - **Content-Type**: Not defined
1469
+ - **Content-Type**: application/json
434
1470
  - **Accept**: application/json
435
1471
 
436
1472
 
437
1473
  ### HTTP response details
438
1474
  | Status code | Description | Response headers |
439
1475
  |-------------|-------------|------------------|
440
- |**200** | 3CX Key Summaries | - |
1476
+ |**200** | Accounts Finance Details | - |
441
1477
  |**400** | Bad Request | - |
442
1478
  |**401** | Unauthorised | - |
443
1479
  |**403** | Access Denied | - |
444
1480
 
445
1481
  [[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)
446
1482
 
447
- # **getVerifyEmailAddress**
448
- > getVerifyEmailAddress()
1483
+ # **patchUpdateTcxHostingPriceList**
1484
+ > PartnerDTO patchUpdateTcxHostingPriceList()
449
1485
 
450
- Verify account email address
1486
+ Set Account 3CX Hosting Price List
451
1487
 
452
1488
  ### Example
453
1489
 
454
1490
  ```typescript
455
1491
  import {
456
1492
  AccountsApi,
457
- Configuration
1493
+ Configuration,
1494
+ PatchUpdateTcxHostingPriceListRequest
458
1495
  } from 'yellowgrid-api-ts';
459
1496
 
460
1497
  const configuration = new Configuration();
461
1498
  const apiInstance = new AccountsApi(configuration);
462
1499
 
463
- let token: string; //Verification Token (default to undefined)
1500
+ let id: string; //Xero ID (default to undefined)
1501
+ let patchUpdateTcxHostingPriceListRequest: PatchUpdateTcxHostingPriceListRequest; //3CX Hosting Price List Request (optional)
464
1502
 
465
- const { status, data } = await apiInstance.getVerifyEmailAddress(
466
- token
1503
+ const { status, data } = await apiInstance.patchUpdateTcxHostingPriceList(
1504
+ id,
1505
+ patchUpdateTcxHostingPriceListRequest
467
1506
  );
468
1507
  ```
469
1508
 
@@ -471,12 +1510,13 @@ const { status, data } = await apiInstance.getVerifyEmailAddress(
471
1510
 
472
1511
  |Name | Type | Description | Notes|
473
1512
  |------------- | ------------- | ------------- | -------------|
474
- | **token** | [**string**] | Verification Token | defaults to undefined|
1513
+ | **patchUpdateTcxHostingPriceListRequest** | **PatchUpdateTcxHostingPriceListRequest**| 3CX Hosting Price List Request | |
1514
+ | **id** | [**string**] | Xero ID | defaults to undefined|
475
1515
 
476
1516
 
477
1517
  ### Return type
478
1518
 
479
- void (empty response body)
1519
+ **PartnerDTO**
480
1520
 
481
1521
  ### Authorization
482
1522
 
@@ -484,24 +1524,24 @@ No authorization required
484
1524
 
485
1525
  ### HTTP request headers
486
1526
 
487
- - **Content-Type**: Not defined
488
- - **Accept**: Not defined
1527
+ - **Content-Type**: application/json
1528
+ - **Accept**: application/json
489
1529
 
490
1530
 
491
1531
  ### HTTP response details
492
1532
  | Status code | Description | Response headers |
493
1533
  |-------------|-------------|------------------|
494
- |**200** | No Response | - |
1534
+ |**200** | Account 3CX Partner Details | - |
495
1535
  |**400** | Bad Request | - |
496
1536
  |**401** | Unauthorised | - |
497
1537
  |**403** | Access Denied | - |
498
1538
 
499
1539
  [[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)
500
1540
 
501
- # **patchSetTcxWizardCname**
502
- > patchSetTcxWizardCname()
1541
+ # **patchUpdateTcxPartnerId**
1542
+ > PartnerDTO patchUpdateTcxPartnerId()
503
1543
 
504
- Set 3CX Wizard CNAME
1544
+ Set Account 3CX Partner ID
505
1545
 
506
1546
  ### Example
507
1547
 
@@ -509,16 +1549,18 @@ Set 3CX Wizard CNAME
509
1549
  import {
510
1550
  AccountsApi,
511
1551
  Configuration,
512
- PatchSetTcxWizardCnameRequest
1552
+ PatchUpdateTcxPartnerIdRequest
513
1553
  } from 'yellowgrid-api-ts';
514
1554
 
515
1555
  const configuration = new Configuration();
516
1556
  const apiInstance = new AccountsApi(configuration);
517
1557
 
518
- let patchSetTcxWizardCnameRequest: PatchSetTcxWizardCnameRequest; //CNAME Request (optional)
1558
+ let id: string; //Xero ID (default to undefined)
1559
+ let patchUpdateTcxPartnerIdRequest: PatchUpdateTcxPartnerIdRequest; //Set Account 3CX Partner ID (optional)
519
1560
 
520
- const { status, data } = await apiInstance.patchSetTcxWizardCname(
521
- patchSetTcxWizardCnameRequest
1561
+ const { status, data } = await apiInstance.patchUpdateTcxPartnerId(
1562
+ id,
1563
+ patchUpdateTcxPartnerIdRequest
522
1564
  );
523
1565
  ```
524
1566
 
@@ -526,12 +1568,13 @@ const { status, data } = await apiInstance.patchSetTcxWizardCname(
526
1568
 
527
1569
  |Name | Type | Description | Notes|
528
1570
  |------------- | ------------- | ------------- | -------------|
529
- | **patchSetTcxWizardCnameRequest** | **PatchSetTcxWizardCnameRequest**| CNAME Request | |
1571
+ | **patchUpdateTcxPartnerIdRequest** | **PatchUpdateTcxPartnerIdRequest**| Set Account 3CX Partner ID | |
1572
+ | **id** | [**string**] | Xero ID | defaults to undefined|
530
1573
 
531
1574
 
532
1575
  ### Return type
533
1576
 
534
- void (empty response body)
1577
+ **PartnerDTO**
535
1578
 
536
1579
  ### Authorization
537
1580
 
@@ -540,23 +1583,23 @@ No authorization required
540
1583
  ### HTTP request headers
541
1584
 
542
1585
  - **Content-Type**: application/json
543
- - **Accept**: Not defined
1586
+ - **Accept**: application/json
544
1587
 
545
1588
 
546
1589
  ### HTTP response details
547
1590
  | Status code | Description | Response headers |
548
1591
  |-------------|-------------|------------------|
549
- |**200** | No Response | - |
1592
+ |**200** | Account 3CX Partner Details | - |
550
1593
  |**400** | Bad Request | - |
551
1594
  |**401** | Unauthorised | - |
552
1595
  |**403** | Access Denied | - |
553
1596
 
554
1597
  [[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)
555
1598
 
556
- # **patchUpdateAccountContactPassword**
557
- > patchUpdateAccountContactPassword()
1599
+ # **postAdminCreateAccountContact**
1600
+ > postAdminCreateAccountContact()
558
1601
 
559
- Update Account Password
1602
+ Create Account Contact
560
1603
 
561
1604
  ### Example
562
1605
 
@@ -564,18 +1607,18 @@ Update Account Password
564
1607
  import {
565
1608
  AccountsApi,
566
1609
  Configuration,
567
- PatchUpdateAccountContactPasswordRequest
1610
+ AccountContactRequestModel
568
1611
  } from 'yellowgrid-api-ts';
569
1612
 
570
1613
  const configuration = new Configuration();
571
1614
  const apiInstance = new AccountsApi(configuration);
572
1615
 
573
- let token: string; //Verification Token (default to undefined)
574
- let patchUpdateAccountContactPasswordRequest: PatchUpdateAccountContactPasswordRequest; //New account request (optional)
1616
+ let id: string; //Account Xero ID (default to undefined)
1617
+ let accountContactRequestModel: AccountContactRequestModel; //Create Account Contact Request (optional)
575
1618
 
576
- const { status, data } = await apiInstance.patchUpdateAccountContactPassword(
577
- token,
578
- patchUpdateAccountContactPasswordRequest
1619
+ const { status, data } = await apiInstance.postAdminCreateAccountContact(
1620
+ id,
1621
+ accountContactRequestModel
579
1622
  );
580
1623
  ```
581
1624
 
@@ -583,8 +1626,8 @@ const { status, data } = await apiInstance.patchUpdateAccountContactPassword(
583
1626
 
584
1627
  |Name | Type | Description | Notes|
585
1628
  |------------- | ------------- | ------------- | -------------|
586
- | **patchUpdateAccountContactPasswordRequest** | **PatchUpdateAccountContactPasswordRequest**| New account request | |
587
- | **token** | [**string**] | Verification Token | defaults to undefined|
1629
+ | **accountContactRequestModel** | **AccountContactRequestModel**| Create Account Contact Request | |
1630
+ | **id** | [**string**] | Account Xero ID | defaults to undefined|
588
1631
 
589
1632
 
590
1633
  ### Return type
@@ -604,7 +1647,7 @@ No authorization required
604
1647
  ### HTTP response details
605
1648
  | Status code | Description | Response headers |
606
1649
  |-------------|-------------|------------------|
607
- |**200** | No Response | - |
1650
+ |**201** | No Response | - |
608
1651
  |**400** | Bad Request | - |
609
1652
  |**401** | Unauthorised | - |
610
1653
  |**403** | Access Denied | - |
@@ -921,6 +1964,64 @@ No authorization required
921
1964
  - **Accept**: Not defined
922
1965
 
923
1966
 
1967
+ ### HTTP response details
1968
+ | Status code | Description | Response headers |
1969
+ |-------------|-------------|------------------|
1970
+ |**200** | No Response | - |
1971
+ |**400** | Bad Request | - |
1972
+ |**401** | Unauthorised | - |
1973
+ |**403** | Access Denied | - |
1974
+
1975
+ [[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)
1976
+
1977
+ # **postSendWelcomeEmail**
1978
+ > postSendWelcomeEmail()
1979
+
1980
+ Send Account Welcome Email
1981
+
1982
+ ### Example
1983
+
1984
+ ```typescript
1985
+ import {
1986
+ AccountsApi,
1987
+ Configuration,
1988
+ PostSendWelcomeEmailRequest
1989
+ } from 'yellowgrid-api-ts';
1990
+
1991
+ const configuration = new Configuration();
1992
+ const apiInstance = new AccountsApi(configuration);
1993
+
1994
+ let id: string; //Xero ID (default to undefined)
1995
+ let postSendWelcomeEmailRequest: PostSendWelcomeEmailRequest; //Email Request (optional)
1996
+
1997
+ const { status, data } = await apiInstance.postSendWelcomeEmail(
1998
+ id,
1999
+ postSendWelcomeEmailRequest
2000
+ );
2001
+ ```
2002
+
2003
+ ### Parameters
2004
+
2005
+ |Name | Type | Description | Notes|
2006
+ |------------- | ------------- | ------------- | -------------|
2007
+ | **postSendWelcomeEmailRequest** | **PostSendWelcomeEmailRequest**| Email Request | |
2008
+ | **id** | [**string**] | Xero ID | defaults to undefined|
2009
+
2010
+
2011
+ ### Return type
2012
+
2013
+ void (empty response body)
2014
+
2015
+ ### Authorization
2016
+
2017
+ No authorization required
2018
+
2019
+ ### HTTP request headers
2020
+
2021
+ - **Content-Type**: application/json
2022
+ - **Accept**: Not defined
2023
+
2024
+
924
2025
  ### HTTP response details
925
2026
  | Status code | Description | Response headers |
926
2027
  |-------------|-------------|------------------|
@@ -991,6 +2092,67 @@ No authorization required
991
2092
 
992
2093
  [[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)
993
2094
 
2095
+ # **putAdminUpdateAccountContact**
2096
+ > putAdminUpdateAccountContact()
2097
+
2098
+ Update Account Contact
2099
+
2100
+ ### Example
2101
+
2102
+ ```typescript
2103
+ import {
2104
+ AccountsApi,
2105
+ Configuration,
2106
+ AccountContactRequestModel
2107
+ } from 'yellowgrid-api-ts';
2108
+
2109
+ const configuration = new Configuration();
2110
+ const apiInstance = new AccountsApi(configuration);
2111
+
2112
+ let id: string; //Account Xero ID (default to undefined)
2113
+ let contactId: number; //Contact ID (default to undefined)
2114
+ let accountContactRequestModel: AccountContactRequestModel; //Update Account Contact Request (optional)
2115
+
2116
+ const { status, data } = await apiInstance.putAdminUpdateAccountContact(
2117
+ id,
2118
+ contactId,
2119
+ accountContactRequestModel
2120
+ );
2121
+ ```
2122
+
2123
+ ### Parameters
2124
+
2125
+ |Name | Type | Description | Notes|
2126
+ |------------- | ------------- | ------------- | -------------|
2127
+ | **accountContactRequestModel** | **AccountContactRequestModel**| Update Account Contact Request | |
2128
+ | **id** | [**string**] | Account Xero ID | defaults to undefined|
2129
+ | **contactId** | [**number**] | Contact ID | defaults to undefined|
2130
+
2131
+
2132
+ ### Return type
2133
+
2134
+ void (empty response body)
2135
+
2136
+ ### Authorization
2137
+
2138
+ No authorization required
2139
+
2140
+ ### HTTP request headers
2141
+
2142
+ - **Content-Type**: application/json
2143
+ - **Accept**: Not defined
2144
+
2145
+
2146
+ ### HTTP response details
2147
+ | Status code | Description | Response headers |
2148
+ |-------------|-------------|------------------|
2149
+ |**204** | No Response | - |
2150
+ |**400** | Bad Request | - |
2151
+ |**401** | Unauthorised | - |
2152
+ |**403** | Access Denied | - |
2153
+
2154
+ [[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)
2155
+
994
2156
  # **putUpdateAccountContact**
995
2157
  > putUpdateAccountContact()
996
2158
 
@@ -1049,3 +2211,119 @@ No authorization required
1049
2211
 
1050
2212
  [[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)
1051
2213
 
2214
+ # **putUpdateBillingAddress**
2215
+ > putUpdateBillingAddress()
2216
+
2217
+ Update Account Billing Address
2218
+
2219
+ ### Example
2220
+
2221
+ ```typescript
2222
+ import {
2223
+ AccountsApi,
2224
+ Configuration,
2225
+ AddressDTO
2226
+ } from 'yellowgrid-api-ts';
2227
+
2228
+ const configuration = new Configuration();
2229
+ const apiInstance = new AccountsApi(configuration);
2230
+
2231
+ let id: string; //Xero ID (default to undefined)
2232
+ let addressDTO: AddressDTO; //Updated Billing Address (optional)
2233
+
2234
+ const { status, data } = await apiInstance.putUpdateBillingAddress(
2235
+ id,
2236
+ addressDTO
2237
+ );
2238
+ ```
2239
+
2240
+ ### Parameters
2241
+
2242
+ |Name | Type | Description | Notes|
2243
+ |------------- | ------------- | ------------- | -------------|
2244
+ | **addressDTO** | **AddressDTO**| Updated Billing Address | |
2245
+ | **id** | [**string**] | Xero ID | defaults to undefined|
2246
+
2247
+
2248
+ ### Return type
2249
+
2250
+ void (empty response body)
2251
+
2252
+ ### Authorization
2253
+
2254
+ No authorization required
2255
+
2256
+ ### HTTP request headers
2257
+
2258
+ - **Content-Type**: application/json
2259
+ - **Accept**: Not defined
2260
+
2261
+
2262
+ ### HTTP response details
2263
+ | Status code | Description | Response headers |
2264
+ |-------------|-------------|------------------|
2265
+ |**204** | No Response | - |
2266
+ |**400** | Bad Request | - |
2267
+ |**401** | Unauthorised | - |
2268
+ |**403** | Access Denied | - |
2269
+
2270
+ [[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)
2271
+
2272
+ # **putUpdateShippingAddress**
2273
+ > putUpdateShippingAddress()
2274
+
2275
+ Update Account Shipping Address
2276
+
2277
+ ### Example
2278
+
2279
+ ```typescript
2280
+ import {
2281
+ AccountsApi,
2282
+ Configuration,
2283
+ AddressDTO
2284
+ } from 'yellowgrid-api-ts';
2285
+
2286
+ const configuration = new Configuration();
2287
+ const apiInstance = new AccountsApi(configuration);
2288
+
2289
+ let id: string; //Xero ID (default to undefined)
2290
+ let addressDTO: AddressDTO; //Updated Shipping Address (optional)
2291
+
2292
+ const { status, data } = await apiInstance.putUpdateShippingAddress(
2293
+ id,
2294
+ addressDTO
2295
+ );
2296
+ ```
2297
+
2298
+ ### Parameters
2299
+
2300
+ |Name | Type | Description | Notes|
2301
+ |------------- | ------------- | ------------- | -------------|
2302
+ | **addressDTO** | **AddressDTO**| Updated Shipping Address | |
2303
+ | **id** | [**string**] | Xero ID | defaults to undefined|
2304
+
2305
+
2306
+ ### Return type
2307
+
2308
+ void (empty response body)
2309
+
2310
+ ### Authorization
2311
+
2312
+ No authorization required
2313
+
2314
+ ### HTTP request headers
2315
+
2316
+ - **Content-Type**: application/json
2317
+ - **Accept**: Not defined
2318
+
2319
+
2320
+ ### HTTP response details
2321
+ | Status code | Description | Response headers |
2322
+ |-------------|-------------|------------------|
2323
+ |**204** | No Response | - |
2324
+ |**400** | Bad Request | - |
2325
+ |**401** | Unauthorised | - |
2326
+ |**403** | Access Denied | - |
2327
+
2328
+ [[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)
2329
+