yellowgrid-api-ts 3.2.151-dev.0 → 3.2.153-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 (537) hide show
  1. package/.openapi-generator/FILES +2 -21
  2. package/.openapi-generator/VERSION +1 -1
  3. package/README.md +3 -46
  4. package/api.ts +5164 -2604
  5. package/base.ts +26 -2
  6. package/common.ts +39 -16
  7. package/configuration.ts +19 -25
  8. package/dist/api.d.ts +4545 -1210
  9. package/dist/api.js +767 -2523
  10. package/dist/base.d.ts +25 -1
  11. package/dist/base.js +21 -2
  12. package/dist/common.d.ts +36 -5
  13. package/dist/common.js +39 -17
  14. package/dist/configuration.d.ts +18 -25
  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/GroupEnum.d.ts +43 -0
  19. package/dist/models/GroupEnum.js +45 -0
  20. package/dist/models/PaymentMethodEnum.d.ts +13 -0
  21. package/dist/models/PaymentMethodEnum.js +15 -0
  22. package/docs/AccountsApi.md +54 -1332
  23. package/docs/AdminUserModel.md +4 -2
  24. package/docs/CRMApi.md +1 -121
  25. package/docs/Class3CXApi.md +1 -1
  26. package/docs/Class3CXInstallationWizardApi.md +1 -1
  27. package/docs/Class3CXInstallationsApi.md +1 -1
  28. package/docs/Class3CXIntegrationsApi.md +1 -1
  29. package/docs/Class3CXMultiTenantApi.md +1 -1
  30. package/docs/MyPBXToolsApi.md +1 -1
  31. package/docs/NumberPortModel.md +51 -0
  32. package/docs/NumberPortingApi.md +6 -6
  33. package/docs/OAuth20Api.md +1 -1
  34. package/docs/OrdersApi.md +1 -1
  35. package/docs/PricingApi.md +1 -1
  36. package/docs/ProductsApi.md +1 -1
  37. package/docs/ProspectDTO.md +0 -2
  38. package/docs/ProspectsApi.md +1 -1
  39. package/docs/ProvisioningApi.md +1 -1
  40. package/docs/SIPTrunksApi.md +1 -1
  41. package/docs/SMSApi.md +1 -1
  42. package/docs/ServicesApi.md +1 -1
  43. package/docs/ShippingApi.md +1 -1
  44. package/docs/StockManagementApi.md +1 -1
  45. package/docs/SystemApi.md +1 -1
  46. package/docs/TelephonySupportTicketModel.md +41 -0
  47. package/docs/TicketsApi.md +1 -1
  48. package/docs/WebhooksApi.md +1 -1
  49. package/hs_err_pid16044.log +249 -0
  50. package/hs_err_pid44560.log +249 -0
  51. package/hs_err_pid53988.log +249 -0
  52. package/hs_err_pid58728.log +40 -0
  53. package/index.ts +1 -1
  54. package/models/GroupEnum.ts +44 -0
  55. package/models/PaymentMethodEnum.ts +14 -0
  56. package/openapitools.json +1 -1
  57. package/package.json +2 -2
  58. package/dist/models/HostingPriceListEnum.d.ts +0 -28
  59. package/dist/models/HostingPriceListEnum.js +0 -30
  60. package/dist/models/StatusEnum.d.ts +0 -18
  61. package/dist/models/StatusEnum.js +0 -20
  62. package/dist/src/apis/AccountsApi.d.ts +0 -258
  63. package/dist/src/apis/AccountsApi.js +0 -975
  64. package/dist/src/apis/CRMApi.d.ts +0 -26
  65. package/dist/src/apis/CRMApi.js +0 -122
  66. package/dist/src/apis/Class3CXApi.d.ts +0 -44
  67. package/dist/src/apis/Class3CXApi.js +0 -177
  68. package/dist/src/apis/Class3CXInstallationWizardApi.d.ts +0 -446
  69. package/dist/src/apis/Class3CXInstallationWizardApi.js +0 -1740
  70. package/dist/src/apis/Class3CXInstallationsApi.d.ts +0 -253
  71. package/dist/src/apis/Class3CXInstallationsApi.js +0 -806
  72. package/dist/src/apis/Class3CXIntegrationsApi.d.ts +0 -102
  73. package/dist/src/apis/Class3CXIntegrationsApi.js +0 -386
  74. package/dist/src/apis/Class3CXMultiTenantApi.d.ts +0 -122
  75. package/dist/src/apis/Class3CXMultiTenantApi.js +0 -431
  76. package/dist/src/apis/MyPBXToolsApi.d.ts +0 -32
  77. package/dist/src/apis/MyPBXToolsApi.js +0 -136
  78. package/dist/src/apis/OAuth20Api.d.ts +0 -185
  79. package/dist/src/apis/OAuth20Api.js +0 -507
  80. package/dist/src/apis/OrdersApi.d.ts +0 -154
  81. package/dist/src/apis/OrdersApi.js +0 -512
  82. package/dist/src/apis/PricingApi.d.ts +0 -154
  83. package/dist/src/apis/PricingApi.js +0 -308
  84. package/dist/src/apis/ProductsApi.d.ts +0 -135
  85. package/dist/src/apis/ProductsApi.js +0 -531
  86. package/dist/src/apis/ProvisioningApi.d.ts +0 -112
  87. package/dist/src/apis/ProvisioningApi.js +0 -427
  88. package/dist/src/apis/SIPTrunksApi.d.ts +0 -315
  89. package/dist/src/apis/SIPTrunksApi.js +0 -1197
  90. package/dist/src/apis/SMSApi.d.ts +0 -30
  91. package/dist/src/apis/SMSApi.js +0 -130
  92. package/dist/src/apis/ServicesApi.d.ts +0 -81
  93. package/dist/src/apis/ServicesApi.js +0 -386
  94. package/dist/src/apis/ShippingApi.d.ts +0 -45
  95. package/dist/src/apis/ShippingApi.js +0 -179
  96. package/dist/src/apis/StockManagementApi.d.ts +0 -345
  97. package/dist/src/apis/StockManagementApi.js +0 -1293
  98. package/dist/src/apis/SystemApi.d.ts +0 -37
  99. package/dist/src/apis/SystemApi.js +0 -146
  100. package/dist/src/apis/TicketsApi.d.ts +0 -79
  101. package/dist/src/apis/TicketsApi.js +0 -360
  102. package/dist/src/apis/WebhooksApi.d.ts +0 -56
  103. package/dist/src/apis/WebhooksApi.js +0 -189
  104. package/dist/src/apis/index.d.ts +0 -21
  105. package/dist/src/apis/index.js +0 -39
  106. package/dist/src/index.d.ts +0 -3
  107. package/dist/src/index.js +0 -21
  108. package/dist/src/models/AbstractOrderRequestDTO.d.ts +0 -71
  109. package/dist/src/models/AbstractOrderRequestDTO.js +0 -64
  110. package/dist/src/models/AccountContactEntity.d.ts +0 -104
  111. package/dist/src/models/AccountContactEntity.js +0 -73
  112. package/dist/src/models/AccountContactModel.d.ts +0 -104
  113. package/dist/src/models/AccountContactModel.js +0 -73
  114. package/dist/src/models/AccountContactRequestModel.d.ts +0 -80
  115. package/dist/src/models/AccountContactRequestModel.js +0 -65
  116. package/dist/src/models/AccountDetailedSummaryDTO.d.ts +0 -89
  117. package/dist/src/models/AccountDetailedSummaryDTO.js +0 -70
  118. package/dist/src/models/AccountRequestModel.d.ts +0 -128
  119. package/dist/src/models/AccountRequestModel.js +0 -81
  120. package/dist/src/models/AccountSummaryDTO.d.ts +0 -44
  121. package/dist/src/models/AccountSummaryDTO.js +0 -53
  122. package/dist/src/models/AccountsResponseModel.d.ts +0 -51
  123. package/dist/src/models/AccountsResponseModel.js +0 -56
  124. package/dist/src/models/AddressModel.d.ts +0 -110
  125. package/dist/src/models/AddressModel.js +0 -75
  126. package/dist/src/models/AddressRequestModel.d.ts +0 -50
  127. package/dist/src/models/AddressRequestModel.js +0 -55
  128. package/dist/src/models/AdminOrderRequestDTO.d.ts +0 -113
  129. package/dist/src/models/AdminOrderRequestDTO.js +0 -78
  130. package/dist/src/models/AdminUserModel.d.ts +0 -79
  131. package/dist/src/models/AdminUserModel.js +0 -72
  132. package/dist/src/models/AgentHoursGraphModel.d.ts +0 -51
  133. package/dist/src/models/AgentHoursGraphModel.js +0 -56
  134. package/dist/src/models/AgentHoursGraphMonthModel.d.ts +0 -38
  135. package/dist/src/models/AgentHoursGraphMonthModel.js +0 -51
  136. package/dist/src/models/ApiLogEntity.d.ts +0 -98
  137. package/dist/src/models/ApiLogEntity.js +0 -71
  138. package/dist/src/models/AreaCodeModel.d.ts +0 -38
  139. package/dist/src/models/AreaCodeModel.js +0 -51
  140. package/dist/src/models/AttachmentModel.d.ts +0 -56
  141. package/dist/src/models/AttachmentModel.js +0 -57
  142. package/dist/src/models/AttributeSetEnum.d.ts +0 -38
  143. package/dist/src/models/AttributeSetEnum.js +0 -51
  144. package/dist/src/models/AuditLogEntity.d.ts +0 -80
  145. package/dist/src/models/AuditLogEntity.js +0 -65
  146. package/dist/src/models/AuthCodeResponseModel.d.ts +0 -44
  147. package/dist/src/models/AuthCodeResponseModel.js +0 -53
  148. package/dist/src/models/BasicItemDTO.d.ts +0 -38
  149. package/dist/src/models/BasicItemDTO.js +0 -51
  150. package/dist/src/models/BasicProductDTO.d.ts +0 -38
  151. package/dist/src/models/BasicProductDTO.js +0 -51
  152. package/dist/src/models/BatchEntity.d.ts +0 -128
  153. package/dist/src/models/BatchEntity.js +0 -81
  154. package/dist/src/models/CallBarringModel.d.ts +0 -56
  155. package/dist/src/models/CallBarringModel.js +0 -57
  156. package/dist/src/models/ClientDetailsModel.d.ts +0 -68
  157. package/dist/src/models/ClientDetailsModel.js +0 -61
  158. package/dist/src/models/ClientModel.d.ts +0 -50
  159. package/dist/src/models/ClientModel.js +0 -55
  160. package/dist/src/models/CompanyContractModel.d.ts +0 -56
  161. package/dist/src/models/CompanyContractModel.js +0 -57
  162. package/dist/src/models/ContactInfoModel.d.ts +0 -56
  163. package/dist/src/models/ContactInfoModel.js +0 -57
  164. package/dist/src/models/ConversationModel.d.ts +0 -75
  165. package/dist/src/models/ConversationModel.js +0 -64
  166. package/dist/src/models/CourierPriceEntity.d.ts +0 -86
  167. package/dist/src/models/CourierPriceEntity.js +0 -67
  168. package/dist/src/models/CreditAccountEntity.d.ts +0 -152
  169. package/dist/src/models/CreditAccountEntity.js +0 -89
  170. package/dist/src/models/CrmContactDTO.d.ts +0 -68
  171. package/dist/src/models/CrmContactDTO.js +0 -61
  172. package/dist/src/models/CustomerInformationModel.d.ts +0 -68
  173. package/dist/src/models/CustomerInformationModel.js +0 -61
  174. package/dist/src/models/CustomerItemRequestDTO.d.ts +0 -81
  175. package/dist/src/models/CustomerItemRequestDTO.js +0 -66
  176. package/dist/src/models/CustomerOrderRequestDTO.d.ts +0 -71
  177. package/dist/src/models/CustomerOrderRequestDTO.js +0 -64
  178. package/dist/src/models/CustomerPriceListEnum.d.ts +0 -38
  179. package/dist/src/models/CustomerPriceListEnum.js +0 -51
  180. package/dist/src/models/CustomerSummaryReportDTO.d.ts +0 -65
  181. package/dist/src/models/CustomerSummaryReportDTO.js +0 -62
  182. package/dist/src/models/DdiRangeRequestModel.d.ts +0 -44
  183. package/dist/src/models/DdiRangeRequestModel.js +0 -53
  184. package/dist/src/models/DdiRangesRequestModel.d.ts +0 -33
  185. package/dist/src/models/DdiRangesRequestModel.js +0 -50
  186. package/dist/src/models/DetailedItemRequestDTO.d.ts +0 -99
  187. package/dist/src/models/DetailedItemRequestDTO.js +0 -72
  188. package/dist/src/models/DetailedOrderRequestDTO.d.ts +0 -71
  189. package/dist/src/models/DetailedOrderRequestDTO.js +0 -64
  190. package/dist/src/models/DivertRequestModel.d.ts +0 -38
  191. package/dist/src/models/DivertRequestModel.js +0 -51
  192. package/dist/src/models/DivertResponseModel.d.ts +0 -52
  193. package/dist/src/models/DivertResponseModel.js +0 -61
  194. package/dist/src/models/EdTechProClientEntity.d.ts +0 -56
  195. package/dist/src/models/EdTechProClientEntity.js +0 -57
  196. package/dist/src/models/EdTechProSchoolModel.d.ts +0 -104
  197. package/dist/src/models/EdTechProSchoolModel.js +0 -73
  198. package/dist/src/models/EdTechProSchoolsModel.d.ts +0 -51
  199. package/dist/src/models/EdTechProSchoolsModel.js +0 -56
  200. package/dist/src/models/EdTechProSetupModel.d.ts +0 -56
  201. package/dist/src/models/EdTechProSetupModel.js +0 -57
  202. package/dist/src/models/EventDTO.d.ts +0 -84
  203. package/dist/src/models/EventDTO.js +0 -73
  204. package/dist/src/models/EventRequestDTO.d.ts +0 -44
  205. package/dist/src/models/EventRequestDTO.js +0 -53
  206. package/dist/src/models/EventSubscriptionModel.d.ts +0 -38
  207. package/dist/src/models/EventSubscriptionModel.js +0 -51
  208. package/dist/src/models/EventTypeEnum.d.ts +0 -19
  209. package/dist/src/models/EventTypeEnum.js +0 -24
  210. package/dist/src/models/EventUpdateDTO.d.ts +0 -50
  211. package/dist/src/models/EventUpdateDTO.js +0 -55
  212. package/dist/src/models/EventUpdateEntity.d.ts +0 -56
  213. package/dist/src/models/EventUpdateEntity.js +0 -57
  214. package/dist/src/models/EventUpdateRequestDTO.d.ts +0 -44
  215. package/dist/src/models/EventUpdateRequestDTO.js +0 -53
  216. package/dist/src/models/FraudManagementModel.d.ts +0 -38
  217. package/dist/src/models/FraudManagementModel.js +0 -51
  218. package/dist/src/models/FreshdeskCompanyTicketsModel.d.ts +0 -51
  219. package/dist/src/models/FreshdeskCompanyTicketsModel.js +0 -56
  220. package/dist/src/models/FreshdeskTicketEntity.d.ts +0 -68
  221. package/dist/src/models/FreshdeskTicketEntity.js +0 -61
  222. package/dist/src/models/FtpAccountsEntity.d.ts +0 -56
  223. package/dist/src/models/FtpAccountsEntity.js +0 -57
  224. package/dist/src/models/GenericFileModel.d.ts +0 -44
  225. package/dist/src/models/GenericFileModel.js +0 -53
  226. package/dist/src/models/GetGetPrice200Response.d.ts +0 -32
  227. package/dist/src/models/GetGetPrice200Response.js +0 -49
  228. package/dist/src/models/GetGetRecording200Response.d.ts +0 -32
  229. package/dist/src/models/GetGetRecording200Response.js +0 -49
  230. package/dist/src/models/HostingChangeResponseModel.d.ts +0 -64
  231. package/dist/src/models/HostingChangeResponseModel.js +0 -65
  232. package/dist/src/models/HostingRegionDTO.d.ts +0 -59
  233. package/dist/src/models/HostingRegionDTO.js +0 -68
  234. package/dist/src/models/InstanceAutoFailoverEntity.d.ts +0 -56
  235. package/dist/src/models/InstanceAutoFailoverEntity.js +0 -57
  236. package/dist/src/models/InstanceDeletionScheduleEntity.d.ts +0 -50
  237. package/dist/src/models/InstanceDeletionScheduleEntity.js +0 -55
  238. package/dist/src/models/InstanceEntity.d.ts +0 -152
  239. package/dist/src/models/InstanceEntity.js +0 -89
  240. package/dist/src/models/InstanceFailoverEntity.d.ts +0 -92
  241. package/dist/src/models/InstanceFailoverEntity.js +0 -69
  242. package/dist/src/models/InstanceMonitoringEntity.d.ts +0 -44
  243. package/dist/src/models/InstanceMonitoringEntity.js +0 -53
  244. package/dist/src/models/InstanceMonitoringLogEntity.d.ts +0 -62
  245. package/dist/src/models/InstanceMonitoringLogEntity.js +0 -59
  246. package/dist/src/models/InstanceScheduledTasksEntity.d.ts +0 -62
  247. package/dist/src/models/InstanceScheduledTasksEntity.js +0 -59
  248. package/dist/src/models/InstanceTcxDetailsEntity.d.ts +0 -86
  249. package/dist/src/models/InstanceTcxDetailsEntity.js +0 -67
  250. package/dist/src/models/InstanceUserCredentialsEntity.d.ts +0 -56
  251. package/dist/src/models/InstanceUserCredentialsEntity.js +0 -57
  252. package/dist/src/models/ItemDTO.d.ts +0 -117
  253. package/dist/src/models/ItemDTO.js +0 -78
  254. package/dist/src/models/ItemDiscountEntity.d.ts +0 -77
  255. package/dist/src/models/ItemDiscountEntity.js +0 -70
  256. package/dist/src/models/ItemEntity.d.ts +0 -158
  257. package/dist/src/models/ItemEntity.js +0 -91
  258. package/dist/src/models/LinkedOrderEntity.d.ts +0 -38
  259. package/dist/src/models/LinkedOrderEntity.js +0 -51
  260. package/dist/src/models/MFARequiredModel.d.ts +0 -38
  261. package/dist/src/models/MFARequiredModel.js +0 -51
  262. package/dist/src/models/MonthlyUsageModel.d.ts +0 -38
  263. package/dist/src/models/MonthlyUsageModel.js +0 -51
  264. package/dist/src/models/MultiTenantChangeResponseModel.d.ts +0 -70
  265. package/dist/src/models/MultiTenantChangeResponseModel.js +0 -75
  266. package/dist/src/models/NavigationModel.d.ts +0 -50
  267. package/dist/src/models/NavigationModel.js +0 -55
  268. package/dist/src/models/OfflineInstancesEntity.d.ts +0 -56
  269. package/dist/src/models/OfflineInstancesEntity.js +0 -57
  270. package/dist/src/models/OrderEntity.d.ts +0 -374
  271. package/dist/src/models/OrderEntity.js +0 -163
  272. package/dist/src/models/OrderRequestModel.d.ts +0 -120
  273. package/dist/src/models/OrderRequestModel.js +0 -88
  274. package/dist/src/models/OrderSummariesModel.d.ts +0 -51
  275. package/dist/src/models/OrderSummariesModel.js +0 -56
  276. package/dist/src/models/OrderSummaryDTO.d.ts +0 -126
  277. package/dist/src/models/OrderSummaryDTO.js +0 -83
  278. package/dist/src/models/OrderTotalModel.d.ts +0 -111
  279. package/dist/src/models/OrderTotalModel.js +0 -100
  280. package/dist/src/models/OrderedItemEntity.d.ts +0 -110
  281. package/dist/src/models/OrderedItemEntity.js +0 -75
  282. package/dist/src/models/PatchSetTcxWizardCnameRequest.d.ts +0 -32
  283. package/dist/src/models/PatchSetTcxWizardCnameRequest.js +0 -49
  284. package/dist/src/models/PatchUpdateAccountContactPasswordRequest.d.ts +0 -32
  285. package/dist/src/models/PatchUpdateAccountContactPasswordRequest.js +0 -49
  286. package/dist/src/models/PortalAccountModel.d.ts +0 -171
  287. package/dist/src/models/PortalAccountModel.js +0 -96
  288. package/dist/src/models/PortalLoginModel.d.ts +0 -68
  289. package/dist/src/models/PortalLoginModel.js +0 -61
  290. package/dist/src/models/PostAddWebhook200Response.d.ts +0 -32
  291. package/dist/src/models/PostAddWebhook200Response.js +0 -49
  292. package/dist/src/models/PostGetClientCredentialsRequest.d.ts +0 -32
  293. package/dist/src/models/PostGetClientCredentialsRequest.js +0 -49
  294. package/dist/src/models/PostGetProductForCustomerRequest.d.ts +0 -50
  295. package/dist/src/models/PostGetProductForCustomerRequest.js +0 -55
  296. package/dist/src/models/PostGetProductRequest.d.ts +0 -44
  297. package/dist/src/models/PostGetProductRequest.js +0 -53
  298. package/dist/src/models/PriceListItemModel.d.ts +0 -56
  299. package/dist/src/models/PriceListItemModel.js +0 -57
  300. package/dist/src/models/PrizesEntity.d.ts +0 -62
  301. package/dist/src/models/PrizesEntity.js +0 -59
  302. package/dist/src/models/ProductPriceListItemModel.d.ts +0 -62
  303. package/dist/src/models/ProductPriceListItemModel.js +0 -59
  304. package/dist/src/models/ProductSearchResultsModel.d.ts +0 -33
  305. package/dist/src/models/ProductSearchResultsModel.js +0 -50
  306. package/dist/src/models/ProductSerialInfoModel.d.ts +0 -50
  307. package/dist/src/models/ProductSerialInfoModel.js +0 -55
  308. package/dist/src/models/ProductSummaryDTO.d.ts +0 -81
  309. package/dist/src/models/ProductSummaryDTO.js +0 -66
  310. package/dist/src/models/PromoCodesEntity.d.ts +0 -98
  311. package/dist/src/models/PromoCodesEntity.js +0 -71
  312. package/dist/src/models/PromoItemsEntity.d.ts +0 -74
  313. package/dist/src/models/PromoItemsEntity.js +0 -63
  314. package/dist/src/models/ProvisioningModel.d.ts +0 -56
  315. package/dist/src/models/ProvisioningModel.js +0 -57
  316. package/dist/src/models/ProvisioningRequestEntity.d.ts +0 -44
  317. package/dist/src/models/ProvisioningRequestEntity.js +0 -53
  318. package/dist/src/models/RecordingBackupAzureModel.d.ts +0 -50
  319. package/dist/src/models/RecordingBackupAzureModel.js +0 -55
  320. package/dist/src/models/RecordingsBackupInfoDTO.d.ts +0 -40
  321. package/dist/src/models/RecordingsBackupInfoDTO.js +0 -53
  322. package/dist/src/models/ResourceNotReadyException.d.ts +0 -44
  323. package/dist/src/models/ResourceNotReadyException.js +0 -53
  324. package/dist/src/models/RootAccessModel.d.ts +0 -44
  325. package/dist/src/models/RootAccessModel.js +0 -53
  326. package/dist/src/models/S3BucketEntity.d.ts +0 -50
  327. package/dist/src/models/S3BucketEntity.js +0 -55
  328. package/dist/src/models/ScannedItemModel.d.ts +0 -56
  329. package/dist/src/models/ScannedItemModel.js +0 -57
  330. package/dist/src/models/ScopeModel.d.ts +0 -38
  331. package/dist/src/models/ScopeModel.js +0 -51
  332. package/dist/src/models/ServiceEnum.d.ts +0 -14
  333. package/dist/src/models/ServiceEnum.js +0 -19
  334. package/dist/src/models/ServiceHealthDTO.d.ts +0 -48
  335. package/dist/src/models/ServiceHealthDTO.js +0 -61
  336. package/dist/src/models/ServiceHealthEnum.d.ts +0 -19
  337. package/dist/src/models/ServiceHealthEnum.js +0 -24
  338. package/dist/src/models/ServiceStatusDTO.d.ts +0 -60
  339. package/dist/src/models/ServiceStatusDTO.js +0 -65
  340. package/dist/src/models/ServiceStatusEnum.d.ts +0 -19
  341. package/dist/src/models/ServiceStatusEnum.js +0 -24
  342. package/dist/src/models/ShipmentAddressEntity.d.ts +0 -92
  343. package/dist/src/models/ShipmentAddressEntity.js +0 -69
  344. package/dist/src/models/ShipmentEntity.d.ts +0 -98
  345. package/dist/src/models/ShipmentEntity.js +0 -71
  346. package/dist/src/models/ShipmentItemEntity.d.ts +0 -56
  347. package/dist/src/models/ShipmentItemEntity.js +0 -57
  348. package/dist/src/models/ShippingConsignmentModel.d.ts +0 -51
  349. package/dist/src/models/ShippingConsignmentModel.js +0 -56
  350. package/dist/src/models/ShippingInformationDTO.d.ts +0 -45
  351. package/dist/src/models/ShippingInformationDTO.js +0 -54
  352. package/dist/src/models/ShippingServiceDTO.d.ts +0 -47
  353. package/dist/src/models/ShippingServiceDTO.js +0 -60
  354. package/dist/src/models/ShippingServiceModel.d.ts +0 -71
  355. package/dist/src/models/ShippingServiceModel.js +0 -68
  356. package/dist/src/models/ShippingServicesModel.d.ts +0 -33
  357. package/dist/src/models/ShippingServicesModel.js +0 -50
  358. package/dist/src/models/SipTrunkChangeResponseModel.d.ts +0 -77
  359. package/dist/src/models/SipTrunkChangeResponseModel.js +0 -78
  360. package/dist/src/models/SipTrunkCreationRequestModel.d.ts +0 -66
  361. package/dist/src/models/SipTrunkCreationRequestModel.js +0 -63
  362. package/dist/src/models/SipTrunkEntity.d.ts +0 -98
  363. package/dist/src/models/SipTrunkEntity.js +0 -71
  364. package/dist/src/models/SipTrunksResponseModel.d.ts +0 -51
  365. package/dist/src/models/SipTrunksResponseModel.js +0 -56
  366. package/dist/src/models/SmsAccountEntity.d.ts +0 -68
  367. package/dist/src/models/SmsAccountEntity.js +0 -61
  368. package/dist/src/models/SmsDataModel.d.ts +0 -33
  369. package/dist/src/models/SmsDataModel.js +0 -50
  370. package/dist/src/models/SmsMessageModel.d.ts +0 -44
  371. package/dist/src/models/SmsMessageModel.js +0 -53
  372. package/dist/src/models/SmsNumbersEntity.d.ts +0 -38
  373. package/dist/src/models/SmsNumbersEntity.js +0 -51
  374. package/dist/src/models/SmsPayloadModel.d.ts +0 -45
  375. package/dist/src/models/SmsPayloadModel.js +0 -54
  376. package/dist/src/models/SmsPhoneNumberModel.d.ts +0 -53
  377. package/dist/src/models/SmsPhoneNumberModel.js +0 -66
  378. package/dist/src/models/SmsResponseModel.d.ts +0 -67
  379. package/dist/src/models/SmsResponseModel.js +0 -68
  380. package/dist/src/models/SmsWhitelistEntity.d.ts +0 -38
  381. package/dist/src/models/SmsWhitelistEntity.js +0 -51
  382. package/dist/src/models/StockOrderCourierEntity.d.ts +0 -50
  383. package/dist/src/models/StockOrderCourierEntity.js +0 -55
  384. package/dist/src/models/StockOrderDeductionModel.d.ts +0 -50
  385. package/dist/src/models/StockOrderDeductionModel.js +0 -55
  386. package/dist/src/models/StockOrderDeductionRequestModel.d.ts +0 -38
  387. package/dist/src/models/StockOrderDeductionRequestModel.js +0 -51
  388. package/dist/src/models/StockOrderDeductionsEntity.d.ts +0 -50
  389. package/dist/src/models/StockOrderDeductionsEntity.js +0 -55
  390. package/dist/src/models/StockOrderEntity.d.ts +0 -158
  391. package/dist/src/models/StockOrderEntity.js +0 -91
  392. package/dist/src/models/StockOrderItemEntity.d.ts +0 -68
  393. package/dist/src/models/StockOrderItemEntity.js +0 -61
  394. package/dist/src/models/StockOrderItemModel.d.ts +0 -80
  395. package/dist/src/models/StockOrderItemModel.js +0 -65
  396. package/dist/src/models/StockOrderItemRequestModel.d.ts +0 -50
  397. package/dist/src/models/StockOrderItemRequestModel.js +0 -55
  398. package/dist/src/models/StockOrderModel.d.ts +0 -137
  399. package/dist/src/models/StockOrderModel.js +0 -97
  400. package/dist/src/models/StockOrderProductEntity.d.ts +0 -62
  401. package/dist/src/models/StockOrderProductEntity.js +0 -59
  402. package/dist/src/models/StockOrderRequestModel.d.ts +0 -46
  403. package/dist/src/models/StockOrderRequestModel.js +0 -55
  404. package/dist/src/models/StockOrderSupplierEntity.d.ts +0 -80
  405. package/dist/src/models/StockOrderSupplierEntity.js +0 -65
  406. package/dist/src/models/StockOrderSupplierModel.d.ts +0 -80
  407. package/dist/src/models/StockOrderSupplierModel.js +0 -65
  408. package/dist/src/models/StockOrdersModel.d.ts +0 -51
  409. package/dist/src/models/StockOrdersModel.js +0 -56
  410. package/dist/src/models/StockProductModel.d.ts +0 -120
  411. package/dist/src/models/StockProductModel.js +0 -81
  412. package/dist/src/models/StockProductPriceModel.d.ts +0 -39
  413. package/dist/src/models/StockProductPriceModel.js +0 -52
  414. package/dist/src/models/StockProductSummariesModel.d.ts +0 -51
  415. package/dist/src/models/StockProductSummariesModel.js +0 -56
  416. package/dist/src/models/StockProductSummaryModel.d.ts +0 -69
  417. package/dist/src/models/StockProductSummaryModel.js +0 -62
  418. package/dist/src/models/StockTransactionsEntity.d.ts +0 -74
  419. package/dist/src/models/StockTransactionsEntity.js +0 -63
  420. package/dist/src/models/SupplierEntity.d.ts +0 -80
  421. package/dist/src/models/SupplierEntity.js +0 -65
  422. package/dist/src/models/SupplierItemEntity.d.ts +0 -74
  423. package/dist/src/models/SupplierItemEntity.js +0 -63
  424. package/dist/src/models/TcxBackupEntity.d.ts +0 -80
  425. package/dist/src/models/TcxBackupEntity.js +0 -65
  426. package/dist/src/models/TcxBackupModel.d.ts +0 -140
  427. package/dist/src/models/TcxBackupModel.js +0 -85
  428. package/dist/src/models/TcxBillingEntity.d.ts +0 -86
  429. package/dist/src/models/TcxBillingEntity.js +0 -67
  430. package/dist/src/models/TcxBulkLicenceDetailsModel.d.ts +0 -40
  431. package/dist/src/models/TcxBulkLicenceDetailsModel.js +0 -53
  432. package/dist/src/models/TcxDeadLicenceEntity.d.ts +0 -44
  433. package/dist/src/models/TcxDeadLicenceEntity.js +0 -53
  434. package/dist/src/models/TcxExtsEntity.d.ts +0 -74
  435. package/dist/src/models/TcxExtsEntity.js +0 -63
  436. package/dist/src/models/TcxHostingPricingEntity.d.ts +0 -74
  437. package/dist/src/models/TcxHostingPricingEntity.js +0 -63
  438. package/dist/src/models/TcxInstallationDetailsModel.d.ts +0 -106
  439. package/dist/src/models/TcxInstallationDetailsModel.js +0 -75
  440. package/dist/src/models/TcxInstallationModel.d.ts +0 -200
  441. package/dist/src/models/TcxInstallationModel.js +0 -105
  442. package/dist/src/models/TcxInstallationsModel.d.ts +0 -51
  443. package/dist/src/models/TcxInstallationsModel.js +0 -56
  444. package/dist/src/models/TcxKeySummaryDTO.d.ts +0 -56
  445. package/dist/src/models/TcxKeySummaryDTO.js +0 -57
  446. package/dist/src/models/TcxKeysEntity.d.ts +0 -62
  447. package/dist/src/models/TcxKeysEntity.js +0 -59
  448. package/dist/src/models/TcxLicenceDetailsErrorModel.d.ts +0 -50
  449. package/dist/src/models/TcxLicenceDetailsErrorModel.js +0 -55
  450. package/dist/src/models/TcxLicenceDetailsModel.d.ts +0 -92
  451. package/dist/src/models/TcxLicenceDetailsModel.js +0 -69
  452. package/dist/src/models/TcxMacsEntity.d.ts +0 -44
  453. package/dist/src/models/TcxMacsEntity.js +0 -53
  454. package/dist/src/models/TcxMultiTenantModel.d.ts +0 -118
  455. package/dist/src/models/TcxMultiTenantModel.js +0 -83
  456. package/dist/src/models/TcxMultiTenantUserModel.d.ts +0 -44
  457. package/dist/src/models/TcxMultiTenantUserModel.js +0 -53
  458. package/dist/src/models/TcxMultiTenantsModel.d.ts +0 -51
  459. package/dist/src/models/TcxMultiTenantsModel.js +0 -56
  460. package/dist/src/models/TcxNumbersEntity.d.ts +0 -44
  461. package/dist/src/models/TcxNumbersEntity.js +0 -53
  462. package/dist/src/models/TcxOfficeHoursEntity.d.ts +0 -116
  463. package/dist/src/models/TcxOfficeHoursEntity.js +0 -77
  464. package/dist/src/models/TcxPhoneModel.d.ts +0 -68
  465. package/dist/src/models/TcxPhoneModel.js +0 -61
  466. package/dist/src/models/TcxPhonesEntity.d.ts +0 -62
  467. package/dist/src/models/TcxPhonesEntity.js +0 -59
  468. package/dist/src/models/TcxRemoteStorageModel.d.ts +0 -50
  469. package/dist/src/models/TcxRemoteStorageModel.js +0 -55
  470. package/dist/src/models/TcxSbcDTO.d.ts +0 -62
  471. package/dist/src/models/TcxSbcDTO.js +0 -59
  472. package/dist/src/models/TcxSbcEntity.d.ts +0 -122
  473. package/dist/src/models/TcxSbcEntity.js +0 -79
  474. package/dist/src/models/TcxSbcModel.d.ts +0 -122
  475. package/dist/src/models/TcxSbcModel.js +0 -79
  476. package/dist/src/models/TcxSetupEntity.d.ts +0 -207
  477. package/dist/src/models/TcxSetupEntity.js +0 -123
  478. package/dist/src/models/TcxSetupsModel.d.ts +0 -51
  479. package/dist/src/models/TcxSetupsModel.js +0 -56
  480. package/dist/src/models/TcxSipTrunksEntity.d.ts +0 -104
  481. package/dist/src/models/TcxSipTrunksEntity.js +0 -73
  482. package/dist/src/models/TcxTemplateXmlEnum.d.ts +0 -38
  483. package/dist/src/models/TcxTemplateXmlEnum.js +0 -51
  484. package/dist/src/models/TcxUsersEntity.d.ts +0 -62
  485. package/dist/src/models/TcxUsersEntity.js +0 -59
  486. package/dist/src/models/TcxWizardConfigModel.d.ts +0 -39
  487. package/dist/src/models/TcxWizardConfigModel.js +0 -52
  488. package/dist/src/models/TcxWizardModel.d.ts +0 -150
  489. package/dist/src/models/TcxWizardModel.js +0 -114
  490. package/dist/src/models/TechSupportCompanySummaryDTO.d.ts +0 -57
  491. package/dist/src/models/TechSupportCompanySummaryDTO.js +0 -58
  492. package/dist/src/models/TelephonySupportTicketModel.d.ts +0 -94
  493. package/dist/src/models/TelephonySupportTicketModel.js +0 -71
  494. package/dist/src/models/TicketSummaryModel.d.ts +0 -74
  495. package/dist/src/models/TicketSummaryModel.js +0 -63
  496. package/dist/src/models/TicketTimeDTO.d.ts +0 -80
  497. package/dist/src/models/TicketTimeDTO.js +0 -65
  498. package/dist/src/models/TokenResponseModel.d.ts +0 -44
  499. package/dist/src/models/TokenResponseModel.js +0 -53
  500. package/dist/src/models/UpdateTypeEnum.d.ts +0 -19
  501. package/dist/src/models/UpdateTypeEnum.js +0 -24
  502. package/dist/src/models/UpgradeOrderResponseModel.d.ts +0 -38
  503. package/dist/src/models/UpgradeOrderResponseModel.js +0 -51
  504. package/dist/src/models/UpgradeRequestModel.d.ts +0 -66
  505. package/dist/src/models/UpgradeRequestModel.js +0 -70
  506. package/dist/src/models/UserEntity.d.ts +0 -98
  507. package/dist/src/models/UserEntity.js +0 -71
  508. package/dist/src/models/XeroLogEntity.d.ts +0 -86
  509. package/dist/src/models/XeroLogEntity.js +0 -67
  510. package/dist/src/models/index.d.ts +0 -196
  511. package/dist/src/models/index.js +0 -214
  512. package/dist/src/runtime.d.ts +0 -184
  513. package/dist/src/runtime.js +0 -564
  514. package/docs/AccountFinanceDTO.md +0 -37
  515. package/docs/AccountPageDetailsDTO.md +0 -41
  516. package/docs/AddressDTO.md +0 -31
  517. package/docs/CreateCrmNoteBody.md +0 -20
  518. package/docs/CrmActivitiesResponseDto.md +0 -23
  519. package/docs/CrmActivityDto.md +0 -33
  520. package/docs/CrmDateActivitiesDTO.md +0 -23
  521. package/docs/CrmNoteEntity.md +0 -39
  522. package/docs/CrmNoteModel.md +0 -39
  523. package/docs/NumberPortAdminNoteBody.md +0 -20
  524. package/docs/PartnerDTO.md +0 -39
  525. package/docs/PatchSendWelcomeEmailRequest.md +0 -20
  526. package/docs/PatchUpdateAccountCnameRequest.md +0 -20
  527. package/docs/PatchUpdateAccountCompanyNumberRequest.md +0 -20
  528. package/docs/PatchUpdateAccountPhoneRequest.md +0 -20
  529. package/docs/PatchUpdateAccountVatNumberRequest.md +0 -20
  530. package/docs/PatchUpdateCreditLimitRequest.md +0 -20
  531. package/docs/PatchUpdatePriceListRequest.md +0 -20
  532. package/docs/PatchUpdateSipChannelCostRequest.md +0 -20
  533. package/docs/PatchUpdateTcxHostingPriceListRequest.md +0 -20
  534. package/docs/PatchUpdateTcxPartnerIdRequest.md +0 -20
  535. package/docs/PostCreateCrmNoteRequest.md +0 -20
  536. package/docs/PostSendWelcomeEmailRequest.md +0 -20
  537. package/models/HostingPriceListEnum.ts +0 -29
@@ -1,161 +1,28 @@
1
1
  # AccountsApi
2
2
 
3
- All URIs are relative to *https://localhost*
3
+ All URIs are relative to *https://api.local.yellowgrid.co.uk*
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 | |
9
7
  |[**deleteDeleteClientCredentials**](#deletedeleteclientcredentials) | **DELETE** /accounts/me/contacts/credentials/{id} | Delete client credentials|
10
8
  |[**deleteUpdateAccountContact**](#deleteupdateaccountcontact) | **DELETE** /accounts/me/contacts/{email} | Delete Account Contact|
11
- |[**getAdminCreateAccountContact**](#getadmincreateaccountcontact) | **GET** /admin/accounts/{id}/contacts | |
12
9
  |[**getGetAccount**](#getgetaccount) | **GET** /accounts/me | Get Account|
13
10
  |[**getGetAccountContacts**](#getgetaccountcontacts) | **GET** /accounts/me/contacts | Get Account Contacts|
14
11
  |[**getGetAccountDetailedSummary**](#getgetaccountdetailedsummary) | **GET** /accounts/{id}/summary | Get Account Detailed Summary|
15
- |[**getGetAccountPageInfo**](#getgetaccountpageinfo) | **GET** /admin/accounts/{id} | |
16
12
  |[**getGetAccounts**](#getgetaccounts) | **GET** /accounts | Get Accounts|
17
13
  |[**getGetClientCredentials**](#getgetclientcredentials) | **GET** /accounts/me/contacts/credentials | Get user\'s client credentials|
18
14
  |[**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 | |
21
15
  |[**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} | |
24
16
  |[**patchSetTcxWizardCname**](#patchsettcxwizardcname) | **PATCH** /accounts/me/cname | |
25
- |[**patchUpdateAccountCname**](#patchupdateaccountcname) | **PATCH** /admin/accounts/{id}/cname | |
26
- |[**patchUpdateAccountCompanyNumber**](#patchupdateaccountcompanynumber) | **PATCH** /admin/accounts/{id}/companyNumber | |
27
17
  |[**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 | |
36
18
  |[**postGetAccountContacts**](#postgetaccountcontacts) | **POST** /accounts/me/contacts | Add Account Contact|
37
19
  |[**postGetAccounts**](#postgetaccounts) | **POST** /accounts | Create a new customer account|
38
20
  |[**postGetAdminAccount**](#postgetadminaccount) | **POST** /admin/me | Get Admin Account|
39
21
  |[**postGetClientCredentials**](#postgetclientcredentials) | **POST** /accounts/me/contacts/credentials | Create client credentials|
40
22
  |[**postSendEmailVerificationEmail**](#postsendemailverificationemail) | **POST** /accounts/contacts/verify/{email} | Send email verification email|
41
23
  |[**postSendPasswordReset**](#postsendpasswordreset) | **POST** /accounts/contacts/password/reset | Send password reset email|
42
- |[**postSendWelcomeEmail**](#postsendwelcomeemail) | **POST** /admin/accounts/{id}/email/welcome | |
43
24
  |[**postSubmitResellerApplication**](#postsubmitresellerapplication) | **POST** /accounts/reseller | Submit reseller application|
44
- |[**putAdminUpdateAccountContact**](#putadminupdateaccountcontact) | **PUT** /admin/accounts/{id}/contacts/{contact_id} | |
45
25
  |[**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)
159
26
 
160
27
  # **deleteDeleteClientCredentials**
161
28
  > deleteDeleteClientCredentials()
@@ -265,60 +132,6 @@ No authorization required
265
132
 
266
133
  [[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)
267
134
 
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
-
322
135
  # **getGetAccount**
323
136
  > PortalAccountModel getGetAccount()
324
137
 
@@ -474,60 +287,6 @@ No authorization required
474
287
 
475
288
  [[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)
476
289
 
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
-
531
290
  # **getGetAccounts**
532
291
  > AccountsResponseModel getGetAccounts()
533
292
 
@@ -591,816 +350,32 @@ No authorization required
591
350
 
592
351
  [[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)
593
352
 
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()
353
+ # **getGetClientCredentials**
354
+ > Array<ClientModel> getGetClientCredentials()
1369
355
 
1370
- Set Account Price List
356
+ Get user\'s client credentials
1371
357
 
1372
358
  ### Example
1373
359
 
1374
360
  ```typescript
1375
361
  import {
1376
362
  AccountsApi,
1377
- Configuration,
1378
- PatchUpdatePriceListRequest
363
+ Configuration
1379
364
  } from 'yellowgrid-api-ts';
1380
365
 
1381
366
  const configuration = new Configuration();
1382
367
  const apiInstance = new AccountsApi(configuration);
1383
368
 
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
- );
369
+ const { status, data } = await apiInstance.getGetClientCredentials();
1391
370
  ```
1392
371
 
1393
372
  ### Parameters
1394
-
1395
- |Name | Type | Description | Notes|
1396
- |------------- | ------------- | ------------- | -------------|
1397
- | **patchUpdatePriceListRequest** | **PatchUpdatePriceListRequest**| Price List Request | |
1398
- | **id** | [**string**] | Xero ID | defaults to undefined|
373
+ This endpoint does not have any parameters.
1399
374
 
1400
375
 
1401
376
  ### Return type
1402
377
 
1403
- **AccountFinanceDTO**
378
+ **Array<ClientModel>**
1404
379
 
1405
380
  ### Authorization
1406
381
 
@@ -1408,57 +383,46 @@ No authorization required
1408
383
 
1409
384
  ### HTTP request headers
1410
385
 
1411
- - **Content-Type**: application/json
386
+ - **Content-Type**: Not defined
1412
387
  - **Accept**: application/json
1413
388
 
1414
389
 
1415
390
  ### HTTP response details
1416
391
  | Status code | Description | Response headers |
1417
392
  |-------------|-------------|------------------|
1418
- |**200** | Accounts Finance Details | - |
393
+ |**200** | List of client credentials | - |
1419
394
  |**400** | Bad Request | - |
1420
395
  |**401** | Unauthorised | - |
1421
396
  |**403** | Access Denied | - |
1422
397
 
1423
398
  [[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)
1424
399
 
1425
- # **patchUpdateSipChannelCost**
1426
- > AccountFinanceDTO patchUpdateSipChannelCost()
400
+ # **getGetCustomerKeys**
401
+ > Array<TcxKeySummaryDTO> getGetCustomerKeys()
1427
402
 
1428
- Set Account SIP Channel Cost
403
+ Get 3CX Keys
1429
404
 
1430
405
  ### Example
1431
406
 
1432
407
  ```typescript
1433
408
  import {
1434
409
  AccountsApi,
1435
- Configuration,
1436
- PatchUpdateSipChannelCostRequest
410
+ Configuration
1437
411
  } from 'yellowgrid-api-ts';
1438
412
 
1439
413
  const configuration = new Configuration();
1440
414
  const apiInstance = new AccountsApi(configuration);
1441
415
 
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
- );
416
+ const { status, data } = await apiInstance.getGetCustomerKeys();
1449
417
  ```
1450
418
 
1451
419
  ### Parameters
1452
-
1453
- |Name | Type | Description | Notes|
1454
- |------------- | ------------- | ------------- | -------------|
1455
- | **patchUpdateSipChannelCostRequest** | **PatchUpdateSipChannelCostRequest**| SIP Channel Cost Request | |
1456
- | **id** | [**string**] | Xero ID | defaults to undefined|
420
+ This endpoint does not have any parameters.
1457
421
 
1458
422
 
1459
423
  ### Return type
1460
424
 
1461
- **AccountFinanceDTO**
425
+ **Array<TcxKeySummaryDTO>**
1462
426
 
1463
427
  ### Authorization
1464
428
 
@@ -1466,43 +430,40 @@ No authorization required
1466
430
 
1467
431
  ### HTTP request headers
1468
432
 
1469
- - **Content-Type**: application/json
433
+ - **Content-Type**: Not defined
1470
434
  - **Accept**: application/json
1471
435
 
1472
436
 
1473
437
  ### HTTP response details
1474
438
  | Status code | Description | Response headers |
1475
439
  |-------------|-------------|------------------|
1476
- |**200** | Accounts Finance Details | - |
440
+ |**200** | 3CX Key Summaries | - |
1477
441
  |**400** | Bad Request | - |
1478
442
  |**401** | Unauthorised | - |
1479
443
  |**403** | Access Denied | - |
1480
444
 
1481
445
  [[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)
1482
446
 
1483
- # **patchUpdateTcxHostingPriceList**
1484
- > PartnerDTO patchUpdateTcxHostingPriceList()
447
+ # **getVerifyEmailAddress**
448
+ > getVerifyEmailAddress()
1485
449
 
1486
- Set Account 3CX Hosting Price List
450
+ Verify account email address
1487
451
 
1488
452
  ### Example
1489
453
 
1490
454
  ```typescript
1491
455
  import {
1492
456
  AccountsApi,
1493
- Configuration,
1494
- PatchUpdateTcxHostingPriceListRequest
457
+ Configuration
1495
458
  } from 'yellowgrid-api-ts';
1496
459
 
1497
460
  const configuration = new Configuration();
1498
461
  const apiInstance = new AccountsApi(configuration);
1499
462
 
1500
- let id: string; //Xero ID (default to undefined)
1501
- let patchUpdateTcxHostingPriceListRequest: PatchUpdateTcxHostingPriceListRequest; //3CX Hosting Price List Request (optional)
463
+ let token: string; //Verification Token (default to undefined)
1502
464
 
1503
- const { status, data } = await apiInstance.patchUpdateTcxHostingPriceList(
1504
- id,
1505
- patchUpdateTcxHostingPriceListRequest
465
+ const { status, data } = await apiInstance.getVerifyEmailAddress(
466
+ token
1506
467
  );
1507
468
  ```
1508
469
 
@@ -1510,13 +471,12 @@ const { status, data } = await apiInstance.patchUpdateTcxHostingPriceList(
1510
471
 
1511
472
  |Name | Type | Description | Notes|
1512
473
  |------------- | ------------- | ------------- | -------------|
1513
- | **patchUpdateTcxHostingPriceListRequest** | **PatchUpdateTcxHostingPriceListRequest**| 3CX Hosting Price List Request | |
1514
- | **id** | [**string**] | Xero ID | defaults to undefined|
474
+ | **token** | [**string**] | Verification Token | defaults to undefined|
1515
475
 
1516
476
 
1517
477
  ### Return type
1518
478
 
1519
- **PartnerDTO**
479
+ void (empty response body)
1520
480
 
1521
481
  ### Authorization
1522
482
 
@@ -1524,24 +484,24 @@ No authorization required
1524
484
 
1525
485
  ### HTTP request headers
1526
486
 
1527
- - **Content-Type**: application/json
1528
- - **Accept**: application/json
487
+ - **Content-Type**: Not defined
488
+ - **Accept**: Not defined
1529
489
 
1530
490
 
1531
491
  ### HTTP response details
1532
492
  | Status code | Description | Response headers |
1533
493
  |-------------|-------------|------------------|
1534
- |**200** | Account 3CX Partner Details | - |
494
+ |**200** | No Response | - |
1535
495
  |**400** | Bad Request | - |
1536
496
  |**401** | Unauthorised | - |
1537
497
  |**403** | Access Denied | - |
1538
498
 
1539
499
  [[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)
1540
500
 
1541
- # **patchUpdateTcxPartnerId**
1542
- > PartnerDTO patchUpdateTcxPartnerId()
501
+ # **patchSetTcxWizardCname**
502
+ > patchSetTcxWizardCname()
1543
503
 
1544
- Set Account 3CX Partner ID
504
+ Set 3CX Wizard CNAME
1545
505
 
1546
506
  ### Example
1547
507
 
@@ -1549,18 +509,16 @@ Set Account 3CX Partner ID
1549
509
  import {
1550
510
  AccountsApi,
1551
511
  Configuration,
1552
- PatchUpdateTcxPartnerIdRequest
512
+ PatchSetTcxWizardCnameRequest
1553
513
  } from 'yellowgrid-api-ts';
1554
514
 
1555
515
  const configuration = new Configuration();
1556
516
  const apiInstance = new AccountsApi(configuration);
1557
517
 
1558
- let id: string; //Xero ID (default to undefined)
1559
- let patchUpdateTcxPartnerIdRequest: PatchUpdateTcxPartnerIdRequest; //Set Account 3CX Partner ID (optional)
518
+ let patchSetTcxWizardCnameRequest: PatchSetTcxWizardCnameRequest; //CNAME Request (optional)
1560
519
 
1561
- const { status, data } = await apiInstance.patchUpdateTcxPartnerId(
1562
- id,
1563
- patchUpdateTcxPartnerIdRequest
520
+ const { status, data } = await apiInstance.patchSetTcxWizardCname(
521
+ patchSetTcxWizardCnameRequest
1564
522
  );
1565
523
  ```
1566
524
 
@@ -1568,13 +526,12 @@ const { status, data } = await apiInstance.patchUpdateTcxPartnerId(
1568
526
 
1569
527
  |Name | Type | Description | Notes|
1570
528
  |------------- | ------------- | ------------- | -------------|
1571
- | **patchUpdateTcxPartnerIdRequest** | **PatchUpdateTcxPartnerIdRequest**| Set Account 3CX Partner ID | |
1572
- | **id** | [**string**] | Xero ID | defaults to undefined|
529
+ | **patchSetTcxWizardCnameRequest** | **PatchSetTcxWizardCnameRequest**| CNAME Request | |
1573
530
 
1574
531
 
1575
532
  ### Return type
1576
533
 
1577
- **PartnerDTO**
534
+ void (empty response body)
1578
535
 
1579
536
  ### Authorization
1580
537
 
@@ -1583,23 +540,23 @@ No authorization required
1583
540
  ### HTTP request headers
1584
541
 
1585
542
  - **Content-Type**: application/json
1586
- - **Accept**: application/json
543
+ - **Accept**: Not defined
1587
544
 
1588
545
 
1589
546
  ### HTTP response details
1590
547
  | Status code | Description | Response headers |
1591
548
  |-------------|-------------|------------------|
1592
- |**200** | Account 3CX Partner Details | - |
549
+ |**200** | No Response | - |
1593
550
  |**400** | Bad Request | - |
1594
551
  |**401** | Unauthorised | - |
1595
552
  |**403** | Access Denied | - |
1596
553
 
1597
554
  [[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)
1598
555
 
1599
- # **postAdminCreateAccountContact**
1600
- > postAdminCreateAccountContact()
556
+ # **patchUpdateAccountContactPassword**
557
+ > patchUpdateAccountContactPassword()
1601
558
 
1602
- Create Account Contact
559
+ Update Account Password
1603
560
 
1604
561
  ### Example
1605
562
 
@@ -1607,18 +564,18 @@ Create Account Contact
1607
564
  import {
1608
565
  AccountsApi,
1609
566
  Configuration,
1610
- AccountContactRequestModel
567
+ PatchUpdateAccountContactPasswordRequest
1611
568
  } from 'yellowgrid-api-ts';
1612
569
 
1613
570
  const configuration = new Configuration();
1614
571
  const apiInstance = new AccountsApi(configuration);
1615
572
 
1616
- let id: string; //Account Xero ID (default to undefined)
1617
- let accountContactRequestModel: AccountContactRequestModel; //Create Account Contact Request (optional)
573
+ let token: string; //Verification Token (default to undefined)
574
+ let patchUpdateAccountContactPasswordRequest: PatchUpdateAccountContactPasswordRequest; //New account request (optional)
1618
575
 
1619
- const { status, data } = await apiInstance.postAdminCreateAccountContact(
1620
- id,
1621
- accountContactRequestModel
576
+ const { status, data } = await apiInstance.patchUpdateAccountContactPassword(
577
+ token,
578
+ patchUpdateAccountContactPasswordRequest
1622
579
  );
1623
580
  ```
1624
581
 
@@ -1626,8 +583,8 @@ const { status, data } = await apiInstance.postAdminCreateAccountContact(
1626
583
 
1627
584
  |Name | Type | Description | Notes|
1628
585
  |------------- | ------------- | ------------- | -------------|
1629
- | **accountContactRequestModel** | **AccountContactRequestModel**| Create Account Contact Request | |
1630
- | **id** | [**string**] | Account Xero ID | defaults to undefined|
586
+ | **patchUpdateAccountContactPasswordRequest** | **PatchUpdateAccountContactPasswordRequest**| New account request | |
587
+ | **token** | [**string**] | Verification Token | defaults to undefined|
1631
588
 
1632
589
 
1633
590
  ### Return type
@@ -1647,7 +604,7 @@ No authorization required
1647
604
  ### HTTP response details
1648
605
  | Status code | Description | Response headers |
1649
606
  |-------------|-------------|------------------|
1650
- |**201** | No Response | - |
607
+ |**200** | No Response | - |
1651
608
  |**400** | Bad Request | - |
1652
609
  |**401** | Unauthorised | - |
1653
610
  |**403** | Access Denied | - |
@@ -1964,64 +921,6 @@ No authorization required
1964
921
  - **Accept**: Not defined
1965
922
 
1966
923
 
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
-
2025
924
  ### HTTP response details
2026
925
  | Status code | Description | Response headers |
2027
926
  |-------------|-------------|------------------|
@@ -2092,67 +991,6 @@ No authorization required
2092
991
 
2093
992
  [[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)
2094
993
 
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
-
2156
994
  # **putUpdateAccountContact**
2157
995
  > putUpdateAccountContact()
2158
996
 
@@ -2211,119 +1049,3 @@ No authorization required
2211
1049
 
2212
1050
  [[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)
2213
1051
 
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
-