@cdx-forge/di-typescript-sdk 0.1.0-beta.1

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 (594) hide show
  1. package/README.md +439 -0
  2. package/dist/generated/src/apis/AccountsApi.d.ts +447 -0
  3. package/dist/generated/src/apis/AccountsApi.js +501 -0
  4. package/dist/generated/src/apis/AlertConfigurationApi.d.ts +533 -0
  5. package/dist/generated/src/apis/AlertConfigurationApi.js +572 -0
  6. package/dist/generated/src/apis/AlertDeliveryApi.d.ts +218 -0
  7. package/dist/generated/src/apis/AlertDeliveryApi.js +219 -0
  8. package/dist/generated/src/apis/AlertPreferencesApi.d.ts +437 -0
  9. package/dist/generated/src/apis/AlertPreferencesApi.js +467 -0
  10. package/dist/generated/src/apis/AuthenticationApi.d.ts +277 -0
  11. package/dist/generated/src/apis/AuthenticationApi.js +378 -0
  12. package/dist/generated/src/apis/BusinessBankingApi.d.ts +308 -0
  13. package/dist/generated/src/apis/BusinessBankingApi.js +340 -0
  14. package/dist/generated/src/apis/CustomerCampaignsApi.d.ts +527 -0
  15. package/dist/generated/src/apis/CustomerCampaignsApi.js +596 -0
  16. package/dist/generated/src/apis/CustomerManagementApi.d.ts +452 -0
  17. package/dist/generated/src/apis/CustomerManagementApi.js +486 -0
  18. package/dist/generated/src/apis/DocumentsAndPreferencesApi.d.ts +505 -0
  19. package/dist/generated/src/apis/DocumentsAndPreferencesApi.js +555 -0
  20. package/dist/generated/src/apis/MXApi.d.ts +211 -0
  21. package/dist/generated/src/apis/MXApi.js +252 -0
  22. package/dist/generated/src/apis/MoneyMovementApi.d.ts +299 -0
  23. package/dist/generated/src/apis/MoneyMovementApi.js +317 -0
  24. package/dist/generated/src/apis/NotificationChannelsApi.d.ts +403 -0
  25. package/dist/generated/src/apis/NotificationChannelsApi.js +444 -0
  26. package/dist/generated/src/apis/index.d.ts +12 -0
  27. package/dist/generated/src/apis/index.js +14 -0
  28. package/dist/generated/src/index.d.ts +3 -0
  29. package/dist/generated/src/index.js +5 -0
  30. package/dist/generated/src/models/Account.d.ts +218 -0
  31. package/dist/generated/src/models/Account.js +107 -0
  32. package/dist/generated/src/models/Account1.d.ts +206 -0
  33. package/dist/generated/src/models/Account1.js +103 -0
  34. package/dist/generated/src/models/Account2Inner.d.ts +399 -0
  35. package/dist/generated/src/models/Account2Inner.js +178 -0
  36. package/dist/generated/src/models/Account3.d.ts +636 -0
  37. package/dist/generated/src/models/Account3.js +300 -0
  38. package/dist/generated/src/models/AccountCategory.d.ts +28 -0
  39. package/dist/generated/src/models/AccountCategory.js +46 -0
  40. package/dist/generated/src/models/AccountEntitledFeature.d.ts +35 -0
  41. package/dist/generated/src/models/AccountEntitledFeature.js +44 -0
  42. package/dist/generated/src/models/AccountEvent.d.ts +46 -0
  43. package/dist/generated/src/models/AccountEvent.js +47 -0
  44. package/dist/generated/src/models/AccountId.d.ts +50 -0
  45. package/dist/generated/src/models/AccountId.js +54 -0
  46. package/dist/generated/src/models/AccountNickname.d.ts +38 -0
  47. package/dist/generated/src/models/AccountNickname.js +43 -0
  48. package/dist/generated/src/models/AccountNumber.d.ts +80 -0
  49. package/dist/generated/src/models/AccountNumber.js +57 -0
  50. package/dist/generated/src/models/AccountRefreshStatus.d.ts +77 -0
  51. package/dist/generated/src/models/AccountRefreshStatus.js +61 -0
  52. package/dist/generated/src/models/AccountStatus.d.ts +116 -0
  53. package/dist/generated/src/models/AccountStatus.js +69 -0
  54. package/dist/generated/src/models/AccountStatus1.d.ts +116 -0
  55. package/dist/generated/src/models/AccountStatus1.js +69 -0
  56. package/dist/generated/src/models/AccountStatuses.d.ts +116 -0
  57. package/dist/generated/src/models/AccountStatuses.js +69 -0
  58. package/dist/generated/src/models/AccountTransaction.d.ts +177 -0
  59. package/dist/generated/src/models/AccountTransaction.js +90 -0
  60. package/dist/generated/src/models/AccountTransaction1.d.ts +380 -0
  61. package/dist/generated/src/models/AccountTransaction1.js +203 -0
  62. package/dist/generated/src/models/AccountTransactions.d.ts +168 -0
  63. package/dist/generated/src/models/AccountTransactions.js +96 -0
  64. package/dist/generated/src/models/AccountType.d.ts +51 -0
  65. package/dist/generated/src/models/AccountType.js +48 -0
  66. package/dist/generated/src/models/AccountType1.d.ts +45 -0
  67. package/dist/generated/src/models/AccountType1.js +46 -0
  68. package/dist/generated/src/models/AccountType2.d.ts +80 -0
  69. package/dist/generated/src/models/AccountType2.js +76 -0
  70. package/dist/generated/src/models/AccountsResponse.d.ts +39 -0
  71. package/dist/generated/src/models/AccountsResponse.js +44 -0
  72. package/dist/generated/src/models/Action.d.ts +39 -0
  73. package/dist/generated/src/models/Action.js +44 -0
  74. package/dist/generated/src/models/Actions.d.ts +62 -0
  75. package/dist/generated/src/models/Actions.js +51 -0
  76. package/dist/generated/src/models/Actions1.d.ts +56 -0
  77. package/dist/generated/src/models/Actions1.js +49 -0
  78. package/dist/generated/src/models/AdditionalFilters.d.ts +47 -0
  79. package/dist/generated/src/models/AdditionalFilters.js +52 -0
  80. package/dist/generated/src/models/AlertHistoryContentResource.d.ts +68 -0
  81. package/dist/generated/src/models/AlertHistoryContentResource.js +53 -0
  82. package/dist/generated/src/models/AlertHistorySummaryResource.d.ts +94 -0
  83. package/dist/generated/src/models/AlertHistorySummaryResource.js +61 -0
  84. package/dist/generated/src/models/AlertHistorySummaryResources.d.ts +33 -0
  85. package/dist/generated/src/models/AlertHistorySummaryResources.js +42 -0
  86. package/dist/generated/src/models/AlertPreferenceAccountDetailsModel.d.ts +44 -0
  87. package/dist/generated/src/models/AlertPreferenceAccountDetailsModel.js +45 -0
  88. package/dist/generated/src/models/AlertPreferenceDetailsModel.d.ts +62 -0
  89. package/dist/generated/src/models/AlertPreferenceDetailsModel.js +51 -0
  90. package/dist/generated/src/models/AlertPreferenceResource.d.ts +64 -0
  91. package/dist/generated/src/models/AlertPreferenceResource.js +53 -0
  92. package/dist/generated/src/models/AlertPreferenceResources.d.ts +33 -0
  93. package/dist/generated/src/models/AlertPreferenceResources.js +42 -0
  94. package/dist/generated/src/models/AlertTemplateResource.d.ts +92 -0
  95. package/dist/generated/src/models/AlertTemplateResource.js +66 -0
  96. package/dist/generated/src/models/AlertTemplateResources.d.ts +33 -0
  97. package/dist/generated/src/models/AlertTemplateResources.js +42 -0
  98. package/dist/generated/src/models/AlertTypeResource.d.ts +108 -0
  99. package/dist/generated/src/models/AlertTypeResource.js +70 -0
  100. package/dist/generated/src/models/AlertTypeResources.d.ts +33 -0
  101. package/dist/generated/src/models/AlertTypeResources.js +42 -0
  102. package/dist/generated/src/models/AuthCode.d.ts +38 -0
  103. package/dist/generated/src/models/AuthCode.js +43 -0
  104. package/dist/generated/src/models/AuthorizationCodeResponse.d.ts +56 -0
  105. package/dist/generated/src/models/AuthorizationCodeResponse.js +49 -0
  106. package/dist/generated/src/models/Balance.d.ts +39 -0
  107. package/dist/generated/src/models/Balance.js +44 -0
  108. package/dist/generated/src/models/Balance1.d.ts +105 -0
  109. package/dist/generated/src/models/Balance1.js +66 -0
  110. package/dist/generated/src/models/BankAccount.d.ts +39 -0
  111. package/dist/generated/src/models/BankAccount.js +43 -0
  112. package/dist/generated/src/models/BankingImage.d.ts +120 -0
  113. package/dist/generated/src/models/BankingImage.js +73 -0
  114. package/dist/generated/src/models/BankingImages.d.ts +33 -0
  115. package/dist/generated/src/models/BankingImages.js +42 -0
  116. package/dist/generated/src/models/BaseGroupsWithParticipantsCountDTO.d.ts +47 -0
  117. package/dist/generated/src/models/BaseGroupsWithParticipantsCountDTO.js +48 -0
  118. package/dist/generated/src/models/BasePageDTOListImportJobDTO.d.ts +47 -0
  119. package/dist/generated/src/models/BasePageDTOListImportJobDTO.js +48 -0
  120. package/dist/generated/src/models/BasePageDTOListImportJobErrorDTO.d.ts +47 -0
  121. package/dist/generated/src/models/BasePageDTOListImportJobErrorDTO.js +48 -0
  122. package/dist/generated/src/models/BbRegistration.d.ts +134 -0
  123. package/dist/generated/src/models/BbRegistration.js +69 -0
  124. package/dist/generated/src/models/BbRegistrationStatus.d.ts +27 -0
  125. package/dist/generated/src/models/BbRegistrationStatus.js +45 -0
  126. package/dist/generated/src/models/BbRegistrationUser.d.ts +64 -0
  127. package/dist/generated/src/models/BbRegistrationUser.js +58 -0
  128. package/dist/generated/src/models/BbRegistrationUserType.d.ts +26 -0
  129. package/dist/generated/src/models/BbRegistrationUserType.js +44 -0
  130. package/dist/generated/src/models/BusinessAddress.d.ts +62 -0
  131. package/dist/generated/src/models/BusinessAddress.js +59 -0
  132. package/dist/generated/src/models/BusinessContact.d.ts +64 -0
  133. package/dist/generated/src/models/BusinessContact.js +52 -0
  134. package/dist/generated/src/models/BusinessDetails.d.ts +103 -0
  135. package/dist/generated/src/models/BusinessDetails.js +79 -0
  136. package/dist/generated/src/models/BusinessEntitlementsLimits.d.ts +48 -0
  137. package/dist/generated/src/models/BusinessEntitlementsLimits.js +49 -0
  138. package/dist/generated/src/models/BusinessRegistrationConfig.d.ts +41 -0
  139. package/dist/generated/src/models/BusinessRegistrationConfig.js +45 -0
  140. package/dist/generated/src/models/BusinessTinInfo.d.ts +57 -0
  141. package/dist/generated/src/models/BusinessTinInfo.js +53 -0
  142. package/dist/generated/src/models/BusinessUser.d.ts +94 -0
  143. package/dist/generated/src/models/BusinessUser.js +76 -0
  144. package/dist/generated/src/models/Calendar.d.ts +87 -0
  145. package/dist/generated/src/models/Calendar.js +60 -0
  146. package/dist/generated/src/models/ChallengeQuestionInfo.d.ts +74 -0
  147. package/dist/generated/src/models/ChallengeQuestionInfo.js +55 -0
  148. package/dist/generated/src/models/ChannelContent.d.ts +72 -0
  149. package/dist/generated/src/models/ChannelContent.js +67 -0
  150. package/dist/generated/src/models/ChannelInfo.d.ts +94 -0
  151. package/dist/generated/src/models/ChannelInfo.js +70 -0
  152. package/dist/generated/src/models/ChannelInfos.d.ts +33 -0
  153. package/dist/generated/src/models/ChannelInfos.js +42 -0
  154. package/dist/generated/src/models/ClientAuth.d.ts +45 -0
  155. package/dist/generated/src/models/ClientAuth.js +46 -0
  156. package/dist/generated/src/models/ClientAuthAdditionalInfo.d.ts +44 -0
  157. package/dist/generated/src/models/ClientAuthAdditionalInfo.js +45 -0
  158. package/dist/generated/src/models/ClientCredentialsResponse.d.ts +44 -0
  159. package/dist/generated/src/models/ClientCredentialsResponse.js +45 -0
  160. package/dist/generated/src/models/Condition.d.ts +25 -0
  161. package/dist/generated/src/models/Condition.js +43 -0
  162. package/dist/generated/src/models/ContactInfo.d.ts +61 -0
  163. package/dist/generated/src/models/ContactInfo.js +57 -0
  164. package/dist/generated/src/models/ContactInfo1.d.ts +38 -0
  165. package/dist/generated/src/models/ContactInfo1.js +43 -0
  166. package/dist/generated/src/models/ContactInfoEmail.d.ts +32 -0
  167. package/dist/generated/src/models/ContactInfoEmail.js +41 -0
  168. package/dist/generated/src/models/ContactInfoPhoneNumber.d.ts +50 -0
  169. package/dist/generated/src/models/ContactInfoPhoneNumber.js +47 -0
  170. package/dist/generated/src/models/ContactMethod.d.ts +83 -0
  171. package/dist/generated/src/models/ContactMethod.js +63 -0
  172. package/dist/generated/src/models/ContactMethod1.d.ts +53 -0
  173. package/dist/generated/src/models/ContactMethod1.js +52 -0
  174. package/dist/generated/src/models/ContactMethodResponse.d.ts +39 -0
  175. package/dist/generated/src/models/ContactMethodResponse.js +44 -0
  176. package/dist/generated/src/models/Controls.d.ts +39 -0
  177. package/dist/generated/src/models/Controls.js +44 -0
  178. package/dist/generated/src/models/CreateToken200Response.d.ts +25 -0
  179. package/dist/generated/src/models/CreateToken200Response.js +65 -0
  180. package/dist/generated/src/models/Credential.d.ts +71 -0
  181. package/dist/generated/src/models/Credential.js +59 -0
  182. package/dist/generated/src/models/CurrencyCode.d.ts +212 -0
  183. package/dist/generated/src/models/CurrencyCode.js +230 -0
  184. package/dist/generated/src/models/Customer.d.ts +58 -0
  185. package/dist/generated/src/models/Customer.js +54 -0
  186. package/dist/generated/src/models/CustomerAccountsResponse.d.ts +51 -0
  187. package/dist/generated/src/models/CustomerAccountsResponse.js +48 -0
  188. package/dist/generated/src/models/CustomerInformation.d.ts +172 -0
  189. package/dist/generated/src/models/CustomerInformation.js +99 -0
  190. package/dist/generated/src/models/CustomerRequest.d.ts +152 -0
  191. package/dist/generated/src/models/CustomerRequest.js +119 -0
  192. package/dist/generated/src/models/DIAccountType.d.ts +47 -0
  193. package/dist/generated/src/models/DIAccountType.js +65 -0
  194. package/dist/generated/src/models/DIAccountType1.d.ts +48 -0
  195. package/dist/generated/src/models/DIAccountType1.js +66 -0
  196. package/dist/generated/src/models/DataMap.d.ts +33 -0
  197. package/dist/generated/src/models/DataMap.js +42 -0
  198. package/dist/generated/src/models/Destination.d.ts +71 -0
  199. package/dist/generated/src/models/Destination.js +59 -0
  200. package/dist/generated/src/models/DisplayFlag.d.ts +62 -0
  201. package/dist/generated/src/models/DisplayFlag.js +51 -0
  202. package/dist/generated/src/models/DownloadTransactionLogs404Response.d.ts +32 -0
  203. package/dist/generated/src/models/DownloadTransactionLogs404Response.js +41 -0
  204. package/dist/generated/src/models/EStatementDisclosure.d.ts +71 -0
  205. package/dist/generated/src/models/EStatementDisclosure.js +59 -0
  206. package/dist/generated/src/models/EStatementDisclosureResponse.d.ts +33 -0
  207. package/dist/generated/src/models/EStatementDisclosureResponse.js +42 -0
  208. package/dist/generated/src/models/EStatementPreferencesRequest.d.ts +32 -0
  209. package/dist/generated/src/models/EStatementPreferencesRequest.js +43 -0
  210. package/dist/generated/src/models/EStatementPreferencesResponse.d.ts +38 -0
  211. package/dist/generated/src/models/EStatementPreferencesResponse.js +47 -0
  212. package/dist/generated/src/models/EStatementReport.d.ts +68 -0
  213. package/dist/generated/src/models/EStatementReport.js +53 -0
  214. package/dist/generated/src/models/EStatementReportRequest.d.ts +38 -0
  215. package/dist/generated/src/models/EStatementReportRequest.js +43 -0
  216. package/dist/generated/src/models/EStatementReportResponse.d.ts +39 -0
  217. package/dist/generated/src/models/EStatementReportResponse.js +44 -0
  218. package/dist/generated/src/models/EStatementRequest.d.ts +44 -0
  219. package/dist/generated/src/models/EStatementRequest.js +47 -0
  220. package/dist/generated/src/models/EntitledFeature.d.ts +39 -0
  221. package/dist/generated/src/models/EntitledFeature.js +46 -0
  222. package/dist/generated/src/models/EntitledTins.d.ts +54 -0
  223. package/dist/generated/src/models/EntitledTins.js +53 -0
  224. package/dist/generated/src/models/Entitlement.d.ts +61 -0
  225. package/dist/generated/src/models/Entitlement.js +54 -0
  226. package/dist/generated/src/models/Entitlements.d.ts +33 -0
  227. package/dist/generated/src/models/Entitlements.js +42 -0
  228. package/dist/generated/src/models/Entry.d.ts +38 -0
  229. package/dist/generated/src/models/Entry.js +43 -0
  230. package/dist/generated/src/models/Error1.d.ts +44 -0
  231. package/dist/generated/src/models/Error1.js +45 -0
  232. package/dist/generated/src/models/Error2.d.ts +32 -0
  233. package/dist/generated/src/models/Error2.js +41 -0
  234. package/dist/generated/src/models/Error3.d.ts +38 -0
  235. package/dist/generated/src/models/Error3.js +43 -0
  236. package/dist/generated/src/models/Error4.d.ts +38 -0
  237. package/dist/generated/src/models/Error4.js +43 -0
  238. package/dist/generated/src/models/Error5.d.ts +38 -0
  239. package/dist/generated/src/models/Error5.js +43 -0
  240. package/dist/generated/src/models/ErrorInfo.d.ts +38 -0
  241. package/dist/generated/src/models/ErrorInfo.js +43 -0
  242. package/dist/generated/src/models/ErrorInfo1.d.ts +38 -0
  243. package/dist/generated/src/models/ErrorInfo1.js +43 -0
  244. package/dist/generated/src/models/ErrorInfo2.d.ts +38 -0
  245. package/dist/generated/src/models/ErrorInfo2.js +43 -0
  246. package/dist/generated/src/models/ErrorInfo3.d.ts +54 -0
  247. package/dist/generated/src/models/ErrorInfo3.js +54 -0
  248. package/dist/generated/src/models/ErrorInfo4.d.ts +38 -0
  249. package/dist/generated/src/models/ErrorInfo4.js +47 -0
  250. package/dist/generated/src/models/ErrorInfo5.d.ts +38 -0
  251. package/dist/generated/src/models/ErrorInfo5.js +47 -0
  252. package/dist/generated/src/models/Event.d.ts +39 -0
  253. package/dist/generated/src/models/Event.js +44 -0
  254. package/dist/generated/src/models/Event1.d.ts +51 -0
  255. package/dist/generated/src/models/Event1.js +48 -0
  256. package/dist/generated/src/models/EventDetails.d.ts +80 -0
  257. package/dist/generated/src/models/EventDetails.js +57 -0
  258. package/dist/generated/src/models/Events.d.ts +33 -0
  259. package/dist/generated/src/models/Events.js +42 -0
  260. package/dist/generated/src/models/FIAccountType.d.ts +44 -0
  261. package/dist/generated/src/models/FIAccountType.js +45 -0
  262. package/dist/generated/src/models/FICustomer.d.ts +167 -0
  263. package/dist/generated/src/models/FICustomer.js +92 -0
  264. package/dist/generated/src/models/FICustomerId.d.ts +54 -0
  265. package/dist/generated/src/models/FICustomerId.js +58 -0
  266. package/dist/generated/src/models/FICustomerRequest.d.ts +91 -0
  267. package/dist/generated/src/models/FICustomerRequest.js +64 -0
  268. package/dist/generated/src/models/FICustomerRequestChannelInfos.d.ts +33 -0
  269. package/dist/generated/src/models/FICustomerRequestChannelInfos.js +42 -0
  270. package/dist/generated/src/models/FICustomerRequestChannelInfosChannelInfoInner.d.ts +39 -0
  271. package/dist/generated/src/models/FICustomerRequestChannelInfosChannelInfoInner.js +44 -0
  272. package/dist/generated/src/models/FICustomerRequestChannelInfosChannelInfoInnerCredential.d.ts +38 -0
  273. package/dist/generated/src/models/FICustomerRequestChannelInfosChannelInfoInnerCredential.js +43 -0
  274. package/dist/generated/src/models/FICustomerRequestFiId.d.ts +32 -0
  275. package/dist/generated/src/models/FICustomerRequestFiId.js +41 -0
  276. package/dist/generated/src/models/FICustomerRequestHostCredential.d.ts +32 -0
  277. package/dist/generated/src/models/FICustomerRequestHostCredential.js +41 -0
  278. package/dist/generated/src/models/FICustomerRequestId.d.ts +38 -0
  279. package/dist/generated/src/models/FICustomerRequestId.js +43 -0
  280. package/dist/generated/src/models/FICustomerRequestPerson.d.ts +46 -0
  281. package/dist/generated/src/models/FICustomerRequestPerson.js +47 -0
  282. package/dist/generated/src/models/FICustomerRequestPersonContactInfo.d.ts +46 -0
  283. package/dist/generated/src/models/FICustomerRequestPersonContactInfo.js +47 -0
  284. package/dist/generated/src/models/FICustomerRequestPersonContactInfoPhoneNumberInner.d.ts +38 -0
  285. package/dist/generated/src/models/FICustomerRequestPersonContactInfoPhoneNumberInner.js +43 -0
  286. package/dist/generated/src/models/FICustomerRequestPersonContactInfoPostalAddressInner.d.ts +68 -0
  287. package/dist/generated/src/models/FICustomerRequestPersonContactInfoPostalAddressInner.js +53 -0
  288. package/dist/generated/src/models/FICustomerRequestPersonPersonName.d.ts +38 -0
  289. package/dist/generated/src/models/FICustomerRequestPersonPersonName.js +43 -0
  290. package/dist/generated/src/models/FICustomerResponse.d.ts +110 -0
  291. package/dist/generated/src/models/FICustomerResponse.js +71 -0
  292. package/dist/generated/src/models/FICustomerResponseChannelInfos.d.ts +33 -0
  293. package/dist/generated/src/models/FICustomerResponseChannelInfos.js +42 -0
  294. package/dist/generated/src/models/FICustomerResponseChannelInfosChannelInfoInner.d.ts +39 -0
  295. package/dist/generated/src/models/FICustomerResponseChannelInfosChannelInfoInner.js +44 -0
  296. package/dist/generated/src/models/FICustomerResponseChannelInfosChannelInfoInnerCredential.d.ts +32 -0
  297. package/dist/generated/src/models/FICustomerResponseChannelInfosChannelInfoInnerCredential.js +41 -0
  298. package/dist/generated/src/models/FICustomerResponseDestinations.d.ts +33 -0
  299. package/dist/generated/src/models/FICustomerResponseDestinations.js +42 -0
  300. package/dist/generated/src/models/FICustomerResponseDestinationsDestinationInner.d.ts +44 -0
  301. package/dist/generated/src/models/FICustomerResponseDestinationsDestinationInner.js +45 -0
  302. package/dist/generated/src/models/FICustomerResponseFiId.d.ts +32 -0
  303. package/dist/generated/src/models/FICustomerResponseFiId.js +41 -0
  304. package/dist/generated/src/models/FICustomerResponseHostCredential.d.ts +32 -0
  305. package/dist/generated/src/models/FICustomerResponseHostCredential.js +41 -0
  306. package/dist/generated/src/models/FICustomerResponseId.d.ts +38 -0
  307. package/dist/generated/src/models/FICustomerResponseId.js +43 -0
  308. package/dist/generated/src/models/FICustomerResponsePerson.d.ts +46 -0
  309. package/dist/generated/src/models/FICustomerResponsePerson.js +47 -0
  310. package/dist/generated/src/models/FICustomerResponsePersonContactInfo.d.ts +46 -0
  311. package/dist/generated/src/models/FICustomerResponsePersonContactInfo.js +47 -0
  312. package/dist/generated/src/models/FICustomerResponsePersonContactInfoPhoneNumberInner.d.ts +38 -0
  313. package/dist/generated/src/models/FICustomerResponsePersonContactInfoPhoneNumberInner.js +43 -0
  314. package/dist/generated/src/models/FICustomerResponsePersonContactInfoPostalAddressInner.d.ts +68 -0
  315. package/dist/generated/src/models/FICustomerResponsePersonContactInfoPostalAddressInner.js +53 -0
  316. package/dist/generated/src/models/FICustomerResponsePersonPersonName.d.ts +56 -0
  317. package/dist/generated/src/models/FICustomerResponsePersonPersonName.js +49 -0
  318. package/dist/generated/src/models/FeatureLimits.d.ts +62 -0
  319. package/dist/generated/src/models/FeatureLimits.js +53 -0
  320. package/dist/generated/src/models/FiAlertPreferenceResource.d.ts +62 -0
  321. package/dist/generated/src/models/FiAlertPreferenceResource.js +51 -0
  322. package/dist/generated/src/models/FiAlertPreferenceResources.d.ts +33 -0
  323. package/dist/generated/src/models/FiAlertPreferenceResources.js +42 -0
  324. package/dist/generated/src/models/FileErrorReport.d.ts +32 -0
  325. package/dist/generated/src/models/FileErrorReport.js +41 -0
  326. package/dist/generated/src/models/FileMetadata.d.ts +50 -0
  327. package/dist/generated/src/models/FileMetadata.js +53 -0
  328. package/dist/generated/src/models/FileStatus.d.ts +50 -0
  329. package/dist/generated/src/models/FileStatus.js +47 -0
  330. package/dist/generated/src/models/Filter.d.ts +57 -0
  331. package/dist/generated/src/models/Filter.js +57 -0
  332. package/dist/generated/src/models/Frequency.d.ts +34 -0
  333. package/dist/generated/src/models/Frequency.js +52 -0
  334. package/dist/generated/src/models/GetUser404Response.d.ts +39 -0
  335. package/dist/generated/src/models/GetUser404Response.js +45 -0
  336. package/dist/generated/src/models/GetWidgetUrl200Response.d.ts +45 -0
  337. package/dist/generated/src/models/GetWidgetUrl200Response.js +47 -0
  338. package/dist/generated/src/models/GroupBaseRequestDTO.d.ts +64 -0
  339. package/dist/generated/src/models/GroupBaseRequestDTO.js +61 -0
  340. package/dist/generated/src/models/GroupBaseResponseDTO.d.ts +109 -0
  341. package/dist/generated/src/models/GroupBaseResponseDTO.js +79 -0
  342. package/dist/generated/src/models/GroupExperienceDTO.d.ts +50 -0
  343. package/dist/generated/src/models/GroupExperienceDTO.js +47 -0
  344. package/dist/generated/src/models/GroupsWithParticipantsCount.d.ts +57 -0
  345. package/dist/generated/src/models/GroupsWithParticipantsCount.js +50 -0
  346. package/dist/generated/src/models/HealthStatus.d.ts +32 -0
  347. package/dist/generated/src/models/HealthStatus.js +41 -0
  348. package/dist/generated/src/models/HostTransactionType.d.ts +86 -0
  349. package/dist/generated/src/models/HostTransactionType.js +59 -0
  350. package/dist/generated/src/models/IdType.d.ts +32 -0
  351. package/dist/generated/src/models/IdType.js +41 -0
  352. package/dist/generated/src/models/ImageInfo.d.ts +52 -0
  353. package/dist/generated/src/models/ImageInfo.js +49 -0
  354. package/dist/generated/src/models/ImageInfoType.d.ts +26 -0
  355. package/dist/generated/src/models/ImageInfoType.js +44 -0
  356. package/dist/generated/src/models/ImageType.d.ts +26 -0
  357. package/dist/generated/src/models/ImageType.js +44 -0
  358. package/dist/generated/src/models/ImageView.d.ts +27 -0
  359. package/dist/generated/src/models/ImageView.js +45 -0
  360. package/dist/generated/src/models/ImportJobDTO.d.ts +123 -0
  361. package/dist/generated/src/models/ImportJobDTO.js +72 -0
  362. package/dist/generated/src/models/ImportJobDTOSingle.d.ts +116 -0
  363. package/dist/generated/src/models/ImportJobDTOSingle.js +69 -0
  364. package/dist/generated/src/models/ImportJobErrorDTO.d.ts +45 -0
  365. package/dist/generated/src/models/ImportJobErrorDTO.js +46 -0
  366. package/dist/generated/src/models/InstitutionAlertTypeResource.d.ts +70 -0
  367. package/dist/generated/src/models/InstitutionAlertTypeResource.js +58 -0
  368. package/dist/generated/src/models/InstitutionAlertTypeResources.d.ts +33 -0
  369. package/dist/generated/src/models/InstitutionAlertTypeResources.js +42 -0
  370. package/dist/generated/src/models/InstitutionCustomer.d.ts +69 -0
  371. package/dist/generated/src/models/InstitutionCustomer.js +54 -0
  372. package/dist/generated/src/models/InstitutionCustomerAdditionalInfo.d.ts +33 -0
  373. package/dist/generated/src/models/InstitutionCustomerAdditionalInfo.js +42 -0
  374. package/dist/generated/src/models/InstitutionDisclosure.d.ts +63 -0
  375. package/dist/generated/src/models/InstitutionDisclosure.js +52 -0
  376. package/dist/generated/src/models/InstitutionDisclosureDataType.d.ts +24 -0
  377. package/dist/generated/src/models/InstitutionDisclosureDataType.js +42 -0
  378. package/dist/generated/src/models/InstitutionDisclosures.d.ts +33 -0
  379. package/dist/generated/src/models/InstitutionDisclosures.js +42 -0
  380. package/dist/generated/src/models/InstitutionUser.d.ts +149 -0
  381. package/dist/generated/src/models/InstitutionUser.js +92 -0
  382. package/dist/generated/src/models/InstitutionUserAdditionalInfo.d.ts +39 -0
  383. package/dist/generated/src/models/InstitutionUserAdditionalInfo.js +44 -0
  384. package/dist/generated/src/models/InstitutionUserDisclosure.d.ts +75 -0
  385. package/dist/generated/src/models/InstitutionUserDisclosure.js +56 -0
  386. package/dist/generated/src/models/InstitutionUserDisclosureStatus.d.ts +27 -0
  387. package/dist/generated/src/models/InstitutionUserDisclosureStatus.js +45 -0
  388. package/dist/generated/src/models/InstitutionUserDisclosures.d.ts +33 -0
  389. package/dist/generated/src/models/InstitutionUserDisclosures.js +42 -0
  390. package/dist/generated/src/models/JobUploadStatus.d.ts +63 -0
  391. package/dist/generated/src/models/JobUploadStatus.js +52 -0
  392. package/dist/generated/src/models/JobUploadStatusStatus.d.ts +50 -0
  393. package/dist/generated/src/models/JobUploadStatusStatus.js +47 -0
  394. package/dist/generated/src/models/LifeType.d.ts +26 -0
  395. package/dist/generated/src/models/LifeType.js +44 -0
  396. package/dist/generated/src/models/Limit.d.ts +113 -0
  397. package/dist/generated/src/models/Limit.js +90 -0
  398. package/dist/generated/src/models/Limits.d.ts +33 -0
  399. package/dist/generated/src/models/Limits.js +42 -0
  400. package/dist/generated/src/models/Links.d.ts +38 -0
  401. package/dist/generated/src/models/Links.js +43 -0
  402. package/dist/generated/src/models/ListUsers400Response.d.ts +46 -0
  403. package/dist/generated/src/models/ListUsers400Response.js +48 -0
  404. package/dist/generated/src/models/ListUsers400ResponseErrorsInner.d.ts +38 -0
  405. package/dist/generated/src/models/ListUsers400ResponseErrorsInner.js +43 -0
  406. package/dist/generated/src/models/ListUsers401Response.d.ts +39 -0
  407. package/dist/generated/src/models/ListUsers401Response.js +45 -0
  408. package/dist/generated/src/models/MapEntryInner.d.ts +38 -0
  409. package/dist/generated/src/models/MapEntryInner.js +43 -0
  410. package/dist/generated/src/models/MapItem.d.ts +38 -0
  411. package/dist/generated/src/models/MapItem.js +43 -0
  412. package/dist/generated/src/models/MfaCookie.d.ts +87 -0
  413. package/dist/generated/src/models/MfaCookie.js +60 -0
  414. package/dist/generated/src/models/ModelError.d.ts +38 -0
  415. package/dist/generated/src/models/ModelError.js +43 -0
  416. package/dist/generated/src/models/ModelMap.d.ts +33 -0
  417. package/dist/generated/src/models/ModelMap.js +42 -0
  418. package/dist/generated/src/models/Money.d.ts +39 -0
  419. package/dist/generated/src/models/Money.js +44 -0
  420. package/dist/generated/src/models/Money1.d.ts +48 -0
  421. package/dist/generated/src/models/Money1.js +52 -0
  422. package/dist/generated/src/models/Money2.d.ts +233 -0
  423. package/dist/generated/src/models/Money2.js +237 -0
  424. package/dist/generated/src/models/NonSubscriptionEvent.d.ts +45 -0
  425. package/dist/generated/src/models/NonSubscriptionEvent.js +46 -0
  426. package/dist/generated/src/models/Notification.d.ts +50 -0
  427. package/dist/generated/src/models/Notification.js +47 -0
  428. package/dist/generated/src/models/NotificationEvent.d.ts +46 -0
  429. package/dist/generated/src/models/NotificationEvent.js +47 -0
  430. package/dist/generated/src/models/Page.d.ts +50 -0
  431. package/dist/generated/src/models/Page.js +47 -0
  432. package/dist/generated/src/models/Pageable.d.ts +44 -0
  433. package/dist/generated/src/models/Pageable.js +45 -0
  434. package/dist/generated/src/models/PasswordResponse.d.ts +56 -0
  435. package/dist/generated/src/models/PasswordResponse.js +49 -0
  436. package/dist/generated/src/models/PaymentOptionType.d.ts +31 -0
  437. package/dist/generated/src/models/PaymentOptionType.js +49 -0
  438. package/dist/generated/src/models/Person.d.ts +33 -0
  439. package/dist/generated/src/models/Person.js +42 -0
  440. package/dist/generated/src/models/PhoneNumber.d.ts +66 -0
  441. package/dist/generated/src/models/PhoneNumber.js +58 -0
  442. package/dist/generated/src/models/PostalAddress.d.ts +68 -0
  443. package/dist/generated/src/models/PostalAddress.js +53 -0
  444. package/dist/generated/src/models/PostalAddress1.d.ts +94 -0
  445. package/dist/generated/src/models/PostalAddress1.js +76 -0
  446. package/dist/generated/src/models/ProductAppUserInfo.d.ts +98 -0
  447. package/dist/generated/src/models/ProductAppUserInfo.js +63 -0
  448. package/dist/generated/src/models/ProductAppUserInfos.d.ts +33 -0
  449. package/dist/generated/src/models/ProductAppUserInfos.js +42 -0
  450. package/dist/generated/src/models/ProductUserInfo.d.ts +32 -0
  451. package/dist/generated/src/models/ProductUserInfo.js +41 -0
  452. package/dist/generated/src/models/Protocol.d.ts +27 -0
  453. package/dist/generated/src/models/Protocol.js +45 -0
  454. package/dist/generated/src/models/Recipient.d.ts +87 -0
  455. package/dist/generated/src/models/Recipient.js +60 -0
  456. package/dist/generated/src/models/Recipients.d.ts +33 -0
  457. package/dist/generated/src/models/Recipients.js +42 -0
  458. package/dist/generated/src/models/RefreshTokenResponse.d.ts +56 -0
  459. package/dist/generated/src/models/RefreshTokenResponse.js +49 -0
  460. package/dist/generated/src/models/RegDLimits.d.ts +56 -0
  461. package/dist/generated/src/models/RegDLimits.js +49 -0
  462. package/dist/generated/src/models/RegDLimits1.d.ts +50 -0
  463. package/dist/generated/src/models/RegDLimits1.js +47 -0
  464. package/dist/generated/src/models/RegisterCustomerRequest.d.ts +33 -0
  465. package/dist/generated/src/models/RegisterCustomerRequest.js +44 -0
  466. package/dist/generated/src/models/RegisterCustomerResponse.d.ts +33 -0
  467. package/dist/generated/src/models/RegisterCustomerResponse.js +42 -0
  468. package/dist/generated/src/models/ResetPasswordRequest.d.ts +46 -0
  469. package/dist/generated/src/models/ResetPasswordRequest.js +52 -0
  470. package/dist/generated/src/models/Resource.d.ts +46 -0
  471. package/dist/generated/src/models/Resource.js +47 -0
  472. package/dist/generated/src/models/ResponseDTO.d.ts +38 -0
  473. package/dist/generated/src/models/ResponseDTO.js +43 -0
  474. package/dist/generated/src/models/Schedule.d.ts +88 -0
  475. package/dist/generated/src/models/Schedule.js +61 -0
  476. package/dist/generated/src/models/SearchCriteriaRequestBody.d.ts +112 -0
  477. package/dist/generated/src/models/SearchCriteriaRequestBody.js +78 -0
  478. package/dist/generated/src/models/SearchResultResponse.d.ts +40 -0
  479. package/dist/generated/src/models/SearchResultResponse.js +43 -0
  480. package/dist/generated/src/models/StatementType.d.ts +45 -0
  481. package/dist/generated/src/models/StatementType.js +63 -0
  482. package/dist/generated/src/models/Status.d.ts +39 -0
  483. package/dist/generated/src/models/Status.js +44 -0
  484. package/dist/generated/src/models/Status1.d.ts +39 -0
  485. package/dist/generated/src/models/Status1.js +44 -0
  486. package/dist/generated/src/models/Status1ErrorInfo.d.ts +53 -0
  487. package/dist/generated/src/models/Status1ErrorInfo.js +53 -0
  488. package/dist/generated/src/models/Status2.d.ts +39 -0
  489. package/dist/generated/src/models/Status2.js +44 -0
  490. package/dist/generated/src/models/Status2ErrorInfo.d.ts +53 -0
  491. package/dist/generated/src/models/Status2ErrorInfo.js +53 -0
  492. package/dist/generated/src/models/StatusAdditionalInfo.d.ts +62 -0
  493. package/dist/generated/src/models/StatusAdditionalInfo.js +51 -0
  494. package/dist/generated/src/models/SubFilter.d.ts +40 -0
  495. package/dist/generated/src/models/SubFilter.js +49 -0
  496. package/dist/generated/src/models/SubUserStatus.d.ts +93 -0
  497. package/dist/generated/src/models/SubUserStatus.js +62 -0
  498. package/dist/generated/src/models/Subscription.d.ts +74 -0
  499. package/dist/generated/src/models/Subscription.js +56 -0
  500. package/dist/generated/src/models/SubscriptionAction.d.ts +41 -0
  501. package/dist/generated/src/models/SubscriptionAction.js +45 -0
  502. package/dist/generated/src/models/SubscriptionActionAttributesMap.d.ts +33 -0
  503. package/dist/generated/src/models/SubscriptionActionAttributesMap.js +42 -0
  504. package/dist/generated/src/models/SubscriptionActions.d.ts +33 -0
  505. package/dist/generated/src/models/SubscriptionActions.js +42 -0
  506. package/dist/generated/src/models/SubscriptionEventConditionsMap.d.ts +33 -0
  507. package/dist/generated/src/models/SubscriptionEventConditionsMap.js +42 -0
  508. package/dist/generated/src/models/Term.d.ts +39 -0
  509. package/dist/generated/src/models/Term.js +44 -0
  510. package/dist/generated/src/models/TermType.d.ts +27 -0
  511. package/dist/generated/src/models/TermType.js +45 -0
  512. package/dist/generated/src/models/TimeZone.d.ts +50 -0
  513. package/dist/generated/src/models/TimeZone.js +47 -0
  514. package/dist/generated/src/models/Token.d.ts +68 -0
  515. package/dist/generated/src/models/Token.js +53 -0
  516. package/dist/generated/src/models/Transaction.d.ts +167 -0
  517. package/dist/generated/src/models/Transaction.js +88 -0
  518. package/dist/generated/src/models/TransactionCategory.d.ts +55 -0
  519. package/dist/generated/src/models/TransactionCategory.js +55 -0
  520. package/dist/generated/src/models/TransactionEvent.d.ts +46 -0
  521. package/dist/generated/src/models/TransactionEvent.js +47 -0
  522. package/dist/generated/src/models/TransactionList.d.ts +33 -0
  523. package/dist/generated/src/models/TransactionList.js +42 -0
  524. package/dist/generated/src/models/TransactionRange.d.ts +39 -0
  525. package/dist/generated/src/models/TransactionRange.js +44 -0
  526. package/dist/generated/src/models/TransactionStatus.d.ts +25 -0
  527. package/dist/generated/src/models/TransactionStatus.js +43 -0
  528. package/dist/generated/src/models/TransactionTransactionImage.d.ts +45 -0
  529. package/dist/generated/src/models/TransactionTransactionImage.js +46 -0
  530. package/dist/generated/src/models/TransactionType.d.ts +73 -0
  531. package/dist/generated/src/models/TransactionType.js +91 -0
  532. package/dist/generated/src/models/Transfer.d.ts +120 -0
  533. package/dist/generated/src/models/Transfer.js +73 -0
  534. package/dist/generated/src/models/TransferStatus.d.ts +25 -0
  535. package/dist/generated/src/models/TransferStatus.js +43 -0
  536. package/dist/generated/src/models/UpdateContactInfoPostalAddress.d.ts +62 -0
  537. package/dist/generated/src/models/UpdateContactInfoPostalAddress.js +51 -0
  538. package/dist/generated/src/models/UploadResponse.d.ts +32 -0
  539. package/dist/generated/src/models/UploadResponse.js +41 -0
  540. package/dist/generated/src/models/UploadResponseDTO.d.ts +50 -0
  541. package/dist/generated/src/models/UploadResponseDTO.js +47 -0
  542. package/dist/generated/src/models/User.d.ts +134 -0
  543. package/dist/generated/src/models/User.js +89 -0
  544. package/dist/generated/src/models/UserEntitlementsLimits.d.ts +48 -0
  545. package/dist/generated/src/models/UserEntitlementsLimits.js +49 -0
  546. package/dist/generated/src/models/UserEvent.d.ts +45 -0
  547. package/dist/generated/src/models/UserEvent.js +46 -0
  548. package/dist/generated/src/models/UserList.d.ts +38 -0
  549. package/dist/generated/src/models/UserList.js +47 -0
  550. package/dist/generated/src/models/UserListFileDTO.d.ts +47 -0
  551. package/dist/generated/src/models/UserListFileDTO.js +48 -0
  552. package/dist/generated/src/models/UserListsDTO.d.ts +33 -0
  553. package/dist/generated/src/models/UserListsDTO.js +42 -0
  554. package/dist/generated/src/models/UserListsFileResponse.d.ts +33 -0
  555. package/dist/generated/src/models/UserListsFileResponse.js +42 -0
  556. package/dist/generated/src/models/UserListsWithFileMetadata.d.ts +33 -0
  557. package/dist/generated/src/models/UserListsWithFileMetadata.js +42 -0
  558. package/dist/generated/src/models/UserStatus.d.ts +80 -0
  559. package/dist/generated/src/models/UserStatus.js +57 -0
  560. package/dist/generated/src/models/UserStatus1.d.ts +284 -0
  561. package/dist/generated/src/models/UserStatus1.js +125 -0
  562. package/dist/generated/src/models/UserStatus2.d.ts +94 -0
  563. package/dist/generated/src/models/UserStatus2.js +63 -0
  564. package/dist/generated/src/models/UsersList.d.ts +33 -0
  565. package/dist/generated/src/models/UsersList.js +44 -0
  566. package/dist/generated/src/models/index.d.ts +266 -0
  567. package/dist/generated/src/models/index.js +268 -0
  568. package/dist/generated/src/runtime.d.ts +184 -0
  569. package/dist/generated/src/runtime.js +348 -0
  570. package/dist/src/auth.d.ts +71 -0
  571. package/dist/src/auth.js +226 -0
  572. package/dist/src/client.d.ts +86 -0
  573. package/dist/src/client.js +399 -0
  574. package/dist/src/completions.d.ts +4 -0
  575. package/dist/src/completions.js +5 -0
  576. package/dist/src/errors.d.ts +49 -0
  577. package/dist/src/errors.js +119 -0
  578. package/dist/src/index.d.ts +26 -0
  579. package/dist/src/index.js +29 -0
  580. package/dist/src/operations.d.ts +31 -0
  581. package/dist/src/operations.js +45 -0
  582. package/dist/src/pagination.d.ts +31 -0
  583. package/dist/src/pagination.js +67 -0
  584. package/dist/src/registry.d.ts +69 -0
  585. package/dist/src/registry.js +4820 -0
  586. package/dist/src/result.d.ts +29 -0
  587. package/dist/src/result.js +26 -0
  588. package/dist/src/retry.d.ts +12 -0
  589. package/dist/src/retry.js +51 -0
  590. package/dist/src/transport.d.ts +53 -0
  591. package/dist/src/transport.js +115 -0
  592. package/dist/src/validate.d.ts +27 -0
  593. package/dist/src/validate.js +68 -0
  594. package/package.json +58 -0
@@ -0,0 +1,505 @@
1
+ /**
2
+ * Candescent DI API
3
+ * Welcome to the **Candescent Digital Insight API** documentation. This comprehensive API platform enables financial institutions, Marketplace Partners, and developers to build powerful digital banking experiences. ## Getting Started New to the Candescent API? Start here: - **[Quick Start Guide](/guides/getting-started/quickstart/)** - Make your first API call in minutes - **[API Categories Overview](/guides/getting-started/api-overview/)** - Explore all available API categories - **[Error Codes Reference](/guides/getting-started/error-codes/)** - Handle errors effectively ## API Categories | Category | Description | |----------|-------------| | **[Accounts](/api/generated/accounts/)** | Account information, transactions, and banking images | | **[Alert Configuration](/api/generated/alert-configuration/)** | Alert types and templates | | **[Alert Delivery](/api/generated/alert-delivery/)** | Alert delivery history | | **[Alert Preferences](/api/generated/alert-preferences/)** | End-user notification preferences | | **[Authentication](/api/generated/authentication/)** | OAuth 2.0 token management and authorization | | **[Business Banking](/api/generated/business-banking/)** | Business banking services | | **[Customer Campaigns](/api/generated/customer-campaigns/)** | User segmentation and promotions | | **[Customer Management](/api/generated/customer-management/)** | Customer profiles, registration, and self-service | | **[Documents and Preferences](/api/generated/documents-and-preferences/)** | Disclosures and e-statement preferences | | **[Money Movement](/api/generated/money-movement/)** | Recipients and fund transfers | | **[MX](/api/generated/mx/)** | Account aggregation and financial insights | | **[Notification Channels](/api/generated/notification-channels/)** | Notification channels for alert delivery | ## Base URLs | Environment | Base URL | |-------------|----------| | Stage | `https://api.candescent.com/digitalbanking/stage` | | Production | `https://api.candescent.com/digitalbanking` | > **Note:** This documentation primarily references the **Stage** environment for examples. ## Authentication Overview Candescent APIs use OAuth 2.0 with JWT Bearer tokens. Follow these steps: ### Step 1: Obtain Client Credentials Get your `Client ID` and `Client Secret` from the Candescent Developer Console. ### Step 2: Generate an Access Token ```bash curl -X POST \'https://api.candescent.com/digitalbanking/stage/oauth2/v1/token\' \\ -H \'Authorization: Basic <BASE64_ENCODED(CLIENT_ID:CLIENT_SECRET)>\' \\ -H \'Content-Type: application/x-www-form-urlencoded\' \\ -H \'transactionid: <YOUR_UNIQUE_UUID>\' \\ -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\ -d \'grant_type=client_credentials\' ``` ### Step 3: Make Authenticated Requests Include the token in the `Authorization` header: ```bash curl \'https://api.candescent.com/digitalbanking/stage/accounts/v1/accounts\' \\ -H \'Authorization: Bearer <YOUR_ACCESS_TOKEN>\' \\ -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\ -H \'transactionid: <YOUR_UNIQUE_UUID>\' ``` > **Tip:** Access tokens expire in ~1 hour. Implement token refresh logic for uninterrupted access. For detailed authentication flows, see the **[Authentication API Reference](/api/generated/authentication/)**.
4
+ *
5
+ * The version of the OpenAPI document: 1.4.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import * as runtime from '../runtime.js';
13
+ import type { EStatementDisclosureResponse, EStatementPreferencesRequest, EStatementReportRequest, EStatementReportResponse, EStatementRequest, InstitutionDisclosure, InstitutionDisclosures, InstitutionUserDisclosure, InstitutionUserDisclosures } from '../models/index.js';
14
+ export interface DocumentsAndPreferencesApiCreateInstitutionDisclosureRequest {
15
+ institutionDisclosure: InstitutionDisclosure;
16
+ }
17
+ export interface DocumentsAndPreferencesApiCreateUserDisclosureRequest {
18
+ institutionUserDisclosure: InstitutionUserDisclosure;
19
+ hostUserId?: string;
20
+ loginId?: string;
21
+ institutionCustomerId?: string;
22
+ accountType?: string;
23
+ }
24
+ export interface DocumentsAndPreferencesApiDeleteUserDisclosureRequest {
25
+ accountType: string;
26
+ institutionUserDisclosure: InstitutionUserDisclosure;
27
+ hostUserId?: string;
28
+ loginId?: string;
29
+ institutionCustomerId?: string;
30
+ }
31
+ export interface DocumentsAndPreferencesApiGetDisclosuresByAccountRequest {
32
+ accountId: string;
33
+ hostUserId?: string;
34
+ loginId?: string;
35
+ }
36
+ export interface DocumentsAndPreferencesApiGetEstatementsReportRequest {
37
+ eStatementReportRequest: EStatementReportRequest;
38
+ hostUserId?: string;
39
+ loginId?: string;
40
+ }
41
+ export interface DocumentsAndPreferencesApiListUserDisclosuresRequest {
42
+ hostUserId?: string;
43
+ loginId?: string;
44
+ institutionCustomerId?: string;
45
+ }
46
+ export interface DocumentsAndPreferencesApiUpdateEStatementPreferencesRequest {
47
+ eStatementPreferencesRequest: EStatementPreferencesRequest;
48
+ hostUserId?: string;
49
+ loginId?: string;
50
+ }
51
+ export interface DocumentsAndPreferencesApiUpdateInstitutionDisclosureRequest {
52
+ institutionDisclosureId: string;
53
+ institutionDisclosure: InstitutionDisclosure;
54
+ }
55
+ export interface DocumentsAndPreferencesApiUpdateStatementDeliveryPreferenceRequest {
56
+ eStatementRequest: EStatementRequest;
57
+ hostUserId?: string;
58
+ loginId?: string;
59
+ }
60
+ export interface DocumentsAndPreferencesApiUpdateUserDisclosureRequest {
61
+ hostUserId?: string;
62
+ loginId?: string;
63
+ institutionCustomerId?: string;
64
+ institutionUserDisclosure?: InstitutionUserDisclosure;
65
+ }
66
+ /**
67
+ * DocumentsAndPreferencesApi - interface
68
+ *
69
+ * @export
70
+ * @interface DocumentsAndPreferencesApiInterface
71
+ */
72
+ export interface DocumentsAndPreferencesApiInterface {
73
+ /**
74
+ * Creates request options for createInstitutionDisclosure without sending the request
75
+ * @param {InstitutionDisclosure} institutionDisclosure
76
+ * @throws {RequiredError}
77
+ * @memberof DocumentsAndPreferencesApiInterface
78
+ */
79
+ createInstitutionDisclosureRequestOpts(requestParameters: DocumentsAndPreferencesApiCreateInstitutionDisclosureRequest): Promise<runtime.RequestOpts>;
80
+ /**
81
+ * Creates a new disclosure definition for the financial institution. The disclosure can contain content as a URL reference or agreement for online statement. **Scope Required:** `disclosures:write`
82
+ * @summary Create institution disclosure
83
+ * @param {InstitutionDisclosure} institutionDisclosure
84
+ * @param {*} [options] Override http request option.
85
+ * @throws {RequiredError}
86
+ * @memberof DocumentsAndPreferencesApiInterface
87
+ */
88
+ createInstitutionDisclosureRaw(requestParameters: DocumentsAndPreferencesApiCreateInstitutionDisclosureRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<InstitutionDisclosure>>;
89
+ /**
90
+ * Creates a new disclosure definition for the financial institution. The disclosure can contain content as a URL reference or agreement for online statement. **Scope Required:** `disclosures:write`
91
+ * Create institution disclosure
92
+ */
93
+ createInstitutionDisclosure(requestParameters: DocumentsAndPreferencesApiCreateInstitutionDisclosureRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<InstitutionDisclosure>;
94
+ /**
95
+ * Creates request options for createUserDisclosure without sending the request
96
+ * @param {InstitutionUserDisclosure} institutionUserDisclosure
97
+ * @param {string} [hostUserId] Identifier for the user associated with the financial institution. This parameter is **required** when the access token was issued using the &#x60;client_credentials&#x60; grant type; otherwise, it is optional. Cannot be used with &#x60;loginId&#x60; query parameter.
98
+ * @param {string} [loginId] Login identifier for the user associated with the financial institution. This parameter is **required** when the access token was issued using the &#x60;client_credentials&#x60; grant type; otherwise, it is optional. Cannot be used with &#x60;hostUserId&#x60; query parameter.
99
+ * @param {string} [institutionCustomerId] The id of the user that this recipient is associated with. (mandatory for Business banking requests)
100
+ * @param {string} [accountType] A valid DIAccountType value (mandatory for multi statement disclosures)
101
+ * @throws {RequiredError}
102
+ * @memberof DocumentsAndPreferencesApiInterface
103
+ */
104
+ createUserDisclosureRequestOpts(requestParameters: DocumentsAndPreferencesApiCreateUserDisclosureRequest): Promise<runtime.RequestOpts>;
105
+ /**
106
+ * Creates a new user disclosure acceptance record. Use this to record when a user accepts or enrolls in a disclosure during onboarding or account updates. **Scope Required:** `disclosures:write` For multi-statement disclosures (e.g., e-statement consent), the `accountType` parameter specifies which account type the disclosure applies to. This API can also be used to update online statement disclosure.
107
+ * @summary Create user disclosure
108
+ * @param {InstitutionUserDisclosure} institutionUserDisclosure
109
+ * @param {string} [hostUserId] Identifier for the user associated with the financial institution. This parameter is **required** when the access token was issued using the &#x60;client_credentials&#x60; grant type; otherwise, it is optional. Cannot be used with &#x60;loginId&#x60; query parameter.
110
+ * @param {string} [loginId] Login identifier for the user associated with the financial institution. This parameter is **required** when the access token was issued using the &#x60;client_credentials&#x60; grant type; otherwise, it is optional. Cannot be used with &#x60;hostUserId&#x60; query parameter.
111
+ * @param {string} [institutionCustomerId] The id of the user that this recipient is associated with. (mandatory for Business banking requests)
112
+ * @param {string} [accountType] A valid DIAccountType value (mandatory for multi statement disclosures)
113
+ * @param {*} [options] Override http request option.
114
+ * @throws {RequiredError}
115
+ * @memberof DocumentsAndPreferencesApiInterface
116
+ */
117
+ createUserDisclosureRaw(requestParameters: DocumentsAndPreferencesApiCreateUserDisclosureRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<InstitutionUserDisclosures>>;
118
+ /**
119
+ * Creates a new user disclosure acceptance record. Use this to record when a user accepts or enrolls in a disclosure during onboarding or account updates. **Scope Required:** `disclosures:write` For multi-statement disclosures (e.g., e-statement consent), the `accountType` parameter specifies which account type the disclosure applies to. This API can also be used to update online statement disclosure.
120
+ * Create user disclosure
121
+ */
122
+ createUserDisclosure(requestParameters: DocumentsAndPreferencesApiCreateUserDisclosureRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<InstitutionUserDisclosures | null | undefined>;
123
+ /**
124
+ * Creates request options for deleteUserDisclosure without sending the request
125
+ * @param {string} accountType A valid DIAccountType value (mandatory for multi statement disclosures)
126
+ * @param {InstitutionUserDisclosure} institutionUserDisclosure
127
+ * @param {string} [hostUserId] Identifier for the user associated with the financial institution. This parameter is **required** when the access token was issued using the &#x60;client_credentials&#x60; grant type; otherwise, it is optional. Cannot be used with &#x60;loginId&#x60; query parameter.
128
+ * @param {string} [loginId] Login identifier for the user associated with the financial institution. This parameter is **required** when the access token was issued using the &#x60;client_credentials&#x60; grant type; otherwise, it is optional. Cannot be used with &#x60;hostUserId&#x60; query parameter.
129
+ * @param {string} [institutionCustomerId] The id of the user that this recipient is associated with. (mandatory for Business banking requests)
130
+ * @throws {RequiredError}
131
+ * @memberof DocumentsAndPreferencesApiInterface
132
+ */
133
+ deleteUserDisclosureRequestOpts(requestParameters: DocumentsAndPreferencesApiDeleteUserDisclosureRequest): Promise<runtime.RequestOpts>;
134
+ /**
135
+ * Deletes a user disclosure acceptance record. Use this to remove a user\'s disclosure enrollment or acceptance status. **Scope Required:** `disclosures:write` **Note:** This permanently removes the disclosure record. The user may need to re-accept the disclosure if required by the institution.
136
+ * @summary Delete user disclosure for online statement
137
+ * @param {string} accountType A valid DIAccountType value (mandatory for multi statement disclosures)
138
+ * @param {InstitutionUserDisclosure} institutionUserDisclosure
139
+ * @param {string} [hostUserId] Identifier for the user associated with the financial institution. This parameter is **required** when the access token was issued using the &#x60;client_credentials&#x60; grant type; otherwise, it is optional. Cannot be used with &#x60;loginId&#x60; query parameter.
140
+ * @param {string} [loginId] Login identifier for the user associated with the financial institution. This parameter is **required** when the access token was issued using the &#x60;client_credentials&#x60; grant type; otherwise, it is optional. Cannot be used with &#x60;hostUserId&#x60; query parameter.
141
+ * @param {string} [institutionCustomerId] The id of the user that this recipient is associated with. (mandatory for Business banking requests)
142
+ * @param {*} [options] Override http request option.
143
+ * @throws {RequiredError}
144
+ * @memberof DocumentsAndPreferencesApiInterface
145
+ */
146
+ deleteUserDisclosureRaw(requestParameters: DocumentsAndPreferencesApiDeleteUserDisclosureRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
147
+ /**
148
+ * Deletes a user disclosure acceptance record. Use this to remove a user\'s disclosure enrollment or acceptance status. **Scope Required:** `disclosures:write` **Note:** This permanently removes the disclosure record. The user may need to re-accept the disclosure if required by the institution.
149
+ * Delete user disclosure for online statement
150
+ */
151
+ deleteUserDisclosure(requestParameters: DocumentsAndPreferencesApiDeleteUserDisclosureRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
152
+ /**
153
+ * Creates request options for getDisclosuresByAccount without sending the request
154
+ * @param {string} accountId Unique identifier of financial institution customer account
155
+ * @param {string} [hostUserId] Unique identifier for the user associated with the financial institution. This is used to provide context for the account’s e-statement preference. This parameter is **required** when the access token is issued using the **client_credentials** **grant type**; otherwise, it is optional. This parameter cannot be used together with the **loginId** query parameter.
156
+ * @param {string} [loginId] Login identifier for the user associated with the financial institution, used to provide context for the account\&#39;s e-statement preference. This parameter is **required** when the access token was issued using the &#x60;client_credentials&#x60; grant type; otherwise, it is optional. This parameter cannot be used together with the **hostUserId** query parameter.
157
+ * @throws {RequiredError}
158
+ * @memberof DocumentsAndPreferencesApiInterface
159
+ */
160
+ getDisclosuresByAccountRequestOpts(requestParameters: DocumentsAndPreferencesApiGetDisclosuresByAccountRequest): Promise<runtime.RequestOpts>;
161
+ /**
162
+ * API to fetch disclosure information for the particular account Id
163
+ * @summary To fetch disclosure information for the particular account Id
164
+ * @param {string} accountId Unique identifier of financial institution customer account
165
+ * @param {string} [hostUserId] Unique identifier for the user associated with the financial institution. This is used to provide context for the account’s e-statement preference. This parameter is **required** when the access token is issued using the **client_credentials** **grant type**; otherwise, it is optional. This parameter cannot be used together with the **loginId** query parameter.
166
+ * @param {string} [loginId] Login identifier for the user associated with the financial institution, used to provide context for the account\&#39;s e-statement preference. This parameter is **required** when the access token was issued using the &#x60;client_credentials&#x60; grant type; otherwise, it is optional. This parameter cannot be used together with the **hostUserId** query parameter.
167
+ * @param {*} [options] Override http request option.
168
+ * @throws {RequiredError}
169
+ * @memberof DocumentsAndPreferencesApiInterface
170
+ */
171
+ getDisclosuresByAccountRaw(requestParameters: DocumentsAndPreferencesApiGetDisclosuresByAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EStatementDisclosureResponse>>;
172
+ /**
173
+ * API to fetch disclosure information for the particular account Id
174
+ * To fetch disclosure information for the particular account Id
175
+ */
176
+ getDisclosuresByAccount(requestParameters: DocumentsAndPreferencesApiGetDisclosuresByAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EStatementDisclosureResponse>;
177
+ /**
178
+ * Creates request options for getEstatementsReport without sending the request
179
+ * @param {EStatementReportRequest} eStatementReportRequest Information needed for generating eStatement opt-in report
180
+ * @param {string} [hostUserId] Unique identifier for the user associated with the financial institution. This is used to provide context for the account’s e-statement preference. This parameter is **required** when the access token is issued using the **client_credentials** **grant type**; otherwise, it is optional. This parameter cannot be used together with the **loginId** query parameter.
181
+ * @param {string} [loginId] Login identifier for the user associated with the financial institution, used to provide context for the account\&#39;s e-statement preference. This parameter is **required** when the access token was issued using the &#x60;client_credentials&#x60; grant type; otherwise, it is optional. This parameter cannot be used together with the **hostUserId** query parameter.
182
+ * @throws {RequiredError}
183
+ * @memberof DocumentsAndPreferencesApiInterface
184
+ */
185
+ getEstatementsReportRequestOpts(requestParameters: DocumentsAndPreferencesApiGetEstatementsReportRequest): Promise<runtime.RequestOpts>;
186
+ /**
187
+ * Retrieves opt-in preferences for all accounts associated with a specified customer. Supports filtering by account type.
188
+ * @summary API to fetch the opt-in data
189
+ * @param {EStatementReportRequest} eStatementReportRequest Information needed for generating eStatement opt-in report
190
+ * @param {string} [hostUserId] Unique identifier for the user associated with the financial institution. This is used to provide context for the account’s e-statement preference. This parameter is **required** when the access token is issued using the **client_credentials** **grant type**; otherwise, it is optional. This parameter cannot be used together with the **loginId** query parameter.
191
+ * @param {string} [loginId] Login identifier for the user associated with the financial institution, used to provide context for the account\&#39;s e-statement preference. This parameter is **required** when the access token was issued using the &#x60;client_credentials&#x60; grant type; otherwise, it is optional. This parameter cannot be used together with the **hostUserId** query parameter.
192
+ * @param {*} [options] Override http request option.
193
+ * @throws {RequiredError}
194
+ * @memberof DocumentsAndPreferencesApiInterface
195
+ */
196
+ getEstatementsReportRaw(requestParameters: DocumentsAndPreferencesApiGetEstatementsReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EStatementReportResponse>>;
197
+ /**
198
+ * Retrieves opt-in preferences for all accounts associated with a specified customer. Supports filtering by account type.
199
+ * API to fetch the opt-in data
200
+ */
201
+ getEstatementsReport(requestParameters: DocumentsAndPreferencesApiGetEstatementsReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EStatementReportResponse>;
202
+ /**
203
+ * Creates request options for listInstitutionDisclosures without sending the request
204
+ * @throws {RequiredError}
205
+ * @memberof DocumentsAndPreferencesApiInterface
206
+ */
207
+ listInstitutionDisclosuresRequestOpts(): Promise<runtime.RequestOpts>;
208
+ /**
209
+ * Retrieves all disclosures configured for the financial institution. Returns all disclosure definitions regardless of their enabled/disabled status. Use this endpoint to display available disclosures to users or to audit the institution\'s disclosure configuration.
210
+ * @summary List institution disclosures
211
+ * @param {*} [options] Override http request option.
212
+ * @throws {RequiredError}
213
+ * @memberof DocumentsAndPreferencesApiInterface
214
+ */
215
+ listInstitutionDisclosuresRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<InstitutionDisclosures>>;
216
+ /**
217
+ * Retrieves all disclosures configured for the financial institution. Returns all disclosure definitions regardless of their enabled/disabled status. Use this endpoint to display available disclosures to users or to audit the institution\'s disclosure configuration.
218
+ * List institution disclosures
219
+ */
220
+ listInstitutionDisclosures(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<InstitutionDisclosures>;
221
+ /**
222
+ * Creates request options for listUserDisclosures without sending the request
223
+ * @param {string} [hostUserId] Identifier for the user associated with the financial institution. This parameter is **required** when the access token was issued using the &#x60;client_credentials&#x60; grant type; otherwise, it is optional. Cannot be used with &#x60;loginId&#x60; query parameter.
224
+ * @param {string} [loginId] Login identifier for the user associated with the financial institution. This parameter is **required** when the access token was issued using the &#x60;client_credentials&#x60; grant type; otherwise, it is optional. Cannot be used with &#x60;hostUserId&#x60; query parameter.
225
+ * @param {string} [institutionCustomerId] The id of the user that this recipient is associated with. (mandatory for Business banking requests)
226
+ * @throws {RequiredError}
227
+ * @memberof DocumentsAndPreferencesApiInterface
228
+ */
229
+ listUserDisclosuresRequestOpts(requestParameters: DocumentsAndPreferencesApiListUserDisclosuresRequest): Promise<runtime.RequestOpts>;
230
+ /**
231
+ * Retrieves all disclosure acceptance records for the authenticated user. Returns the status of each disclosure (ACCEPTED, NOT_ACCEPTED, ENROLLED, NOT_ENROLLED) along with the acceptance/rejection timestamp. For Business Banking users, the `institutionCustomerId` query parameter is required to specify the customer context.
232
+ * @summary List user disclosures
233
+ * @param {string} [hostUserId] Identifier for the user associated with the financial institution. This parameter is **required** when the access token was issued using the &#x60;client_credentials&#x60; grant type; otherwise, it is optional. Cannot be used with &#x60;loginId&#x60; query parameter.
234
+ * @param {string} [loginId] Login identifier for the user associated with the financial institution. This parameter is **required** when the access token was issued using the &#x60;client_credentials&#x60; grant type; otherwise, it is optional. Cannot be used with &#x60;hostUserId&#x60; query parameter.
235
+ * @param {string} [institutionCustomerId] The id of the user that this recipient is associated with. (mandatory for Business banking requests)
236
+ * @param {*} [options] Override http request option.
237
+ * @throws {RequiredError}
238
+ * @memberof DocumentsAndPreferencesApiInterface
239
+ */
240
+ listUserDisclosuresRaw(requestParameters: DocumentsAndPreferencesApiListUserDisclosuresRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<InstitutionUserDisclosures>>;
241
+ /**
242
+ * Retrieves all disclosure acceptance records for the authenticated user. Returns the status of each disclosure (ACCEPTED, NOT_ACCEPTED, ENROLLED, NOT_ENROLLED) along with the acceptance/rejection timestamp. For Business Banking users, the `institutionCustomerId` query parameter is required to specify the customer context.
243
+ * List user disclosures
244
+ */
245
+ listUserDisclosures(requestParameters: DocumentsAndPreferencesApiListUserDisclosuresRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<InstitutionUserDisclosures>;
246
+ /**
247
+ * Creates request options for updateEStatementPreferences without sending the request
248
+ * @param {EStatementPreferencesRequest} eStatementPreferencesRequest Payload specifying the user\&#39;s preferred e-statement delivery method for all accounts.
249
+ * @param {string} [hostUserId] Unique identifier for the user associated with the financial institution. This is used to provide context for the account’s e-statement preference. This parameter is **required** when the access token is issued using the **client_credentials** **grant type**; otherwise, it is optional. This parameter cannot be used together with the **loginId** query parameter.
250
+ * @param {string} [loginId] Login identifier for the user associated with the financial institution, used to provide context for the account\&#39;s e-statement preference. This parameter is **required** when the access token was issued using the &#x60;client_credentials&#x60; grant type; otherwise, it is optional. This parameter cannot be used together with the **hostUserId** query parameter.
251
+ * @throws {RequiredError}
252
+ * @memberof DocumentsAndPreferencesApiInterface
253
+ */
254
+ updateEStatementPreferencesRequestOpts(requestParameters: DocumentsAndPreferencesApiUpdateEStatementPreferencesRequest): Promise<runtime.RequestOpts>;
255
+ /**
256
+ * ### Before you call - **MultiStatement** — This API is available only when the **MultiStatement** feature configured to `false` for the financial institution during the onboarding process. - **Disclosure** — The preference applies only where the applicable e-statement disclosure has been approved for the user. - **Access token** — Obtain a **V2** OAuth 2.0 access token by calling **`POST /oauth2/v1/token`** (Authentication API — **Create V2 access token**). Grant types, required headers (for example `institutionId`, `transactionid`), and form body are defined in that operation. Then pass the token in the `Authorization` header as `Bearer <access_token>`. For full details, see the [Authentication API reference](/api/generated/authentication/). ### Behavior Enables users to apply a unified statement delivery preference (online or mail) to **all** of their accounts.
257
+ * @summary Update user e-statement preferences
258
+ * @param {EStatementPreferencesRequest} eStatementPreferencesRequest Payload specifying the user\&#39;s preferred e-statement delivery method for all accounts.
259
+ * @param {string} [hostUserId] Unique identifier for the user associated with the financial institution. This is used to provide context for the account’s e-statement preference. This parameter is **required** when the access token is issued using the **client_credentials** **grant type**; otherwise, it is optional. This parameter cannot be used together with the **loginId** query parameter.
260
+ * @param {string} [loginId] Login identifier for the user associated with the financial institution, used to provide context for the account\&#39;s e-statement preference. This parameter is **required** when the access token was issued using the &#x60;client_credentials&#x60; grant type; otherwise, it is optional. This parameter cannot be used together with the **hostUserId** query parameter.
261
+ * @param {*} [options] Override http request option.
262
+ * @throws {RequiredError}
263
+ * @memberof DocumentsAndPreferencesApiInterface
264
+ */
265
+ updateEStatementPreferencesRaw(requestParameters: DocumentsAndPreferencesApiUpdateEStatementPreferencesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
266
+ /**
267
+ * ### Before you call - **MultiStatement** — This API is available only when the **MultiStatement** feature configured to `false` for the financial institution during the onboarding process. - **Disclosure** — The preference applies only where the applicable e-statement disclosure has been approved for the user. - **Access token** — Obtain a **V2** OAuth 2.0 access token by calling **`POST /oauth2/v1/token`** (Authentication API — **Create V2 access token**). Grant types, required headers (for example `institutionId`, `transactionid`), and form body are defined in that operation. Then pass the token in the `Authorization` header as `Bearer <access_token>`. For full details, see the [Authentication API reference](/api/generated/authentication/). ### Behavior Enables users to apply a unified statement delivery preference (online or mail) to **all** of their accounts.
268
+ * Update user e-statement preferences
269
+ */
270
+ updateEStatementPreferences(requestParameters: DocumentsAndPreferencesApiUpdateEStatementPreferencesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
271
+ /**
272
+ * Creates request options for updateInstitutionDisclosure without sending the request
273
+ * @param {string} institutionDisclosureId Unique Institution Disclosure Identifier.
274
+ * @param {InstitutionDisclosure} institutionDisclosure
275
+ * @throws {RequiredError}
276
+ * @memberof DocumentsAndPreferencesApiInterface
277
+ */
278
+ updateInstitutionDisclosureRequestOpts(requestParameters: DocumentsAndPreferencesApiUpdateInstitutionDisclosureRequest): Promise<runtime.RequestOpts>;
279
+ /**
280
+ * Updates an existing institution disclosure definition. Use this to modify disclosure content, change the data type, or enable/disable the disclosure. **Scope Required:** `disclosures:write` **Note:** The disclosure ID in the URL must match the ID in the request body.
281
+ * @summary Update institution disclosure
282
+ * @param {string} institutionDisclosureId Unique Institution Disclosure Identifier.
283
+ * @param {InstitutionDisclosure} institutionDisclosure
284
+ * @param {*} [options] Override http request option.
285
+ * @throws {RequiredError}
286
+ * @memberof DocumentsAndPreferencesApiInterface
287
+ */
288
+ updateInstitutionDisclosureRaw(requestParameters: DocumentsAndPreferencesApiUpdateInstitutionDisclosureRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<InstitutionDisclosure>>;
289
+ /**
290
+ * Updates an existing institution disclosure definition. Use this to modify disclosure content, change the data type, or enable/disable the disclosure. **Scope Required:** `disclosures:write` **Note:** The disclosure ID in the URL must match the ID in the request body.
291
+ * Update institution disclosure
292
+ */
293
+ updateInstitutionDisclosure(requestParameters: DocumentsAndPreferencesApiUpdateInstitutionDisclosureRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<InstitutionDisclosure>;
294
+ /**
295
+ * Creates request options for updateStatementDeliveryPreference without sending the request
296
+ * @param {EStatementRequest} eStatementRequest Payload specifying the user\&#39;s preferred account statement delivery method (e-statement or mail) for a given account.
297
+ * @param {string} [hostUserId] Unique identifier for the user associated with the financial institution. This is used to provide context for the account’s e-statement preference. This parameter is **required** when the access token is issued using the **client_credentials** **grant type**; otherwise, it is optional. This parameter cannot be used together with the **loginId** query parameter.
298
+ * @param {string} [loginId] Login identifier for the user associated with the financial institution, used to provide context for the account\&#39;s e-statement preference. This parameter is **required** when the access token was issued using the &#x60;client_credentials&#x60; grant type; otherwise, it is optional. This parameter cannot be used together with the **hostUserId** query parameter.
299
+ * @throws {RequiredError}
300
+ * @memberof DocumentsAndPreferencesApiInterface
301
+ */
302
+ updateStatementDeliveryPreferenceRequestOpts(requestParameters: DocumentsAndPreferencesApiUpdateStatementDeliveryPreferenceRequest): Promise<runtime.RequestOpts>;
303
+ /**
304
+ * ### Before you call - **MultiStatement** — This API is available only when **MultiStatement** is configured **`true`** for the financial institution during the onboarding process (account-level statement preference). - **Disclosure** — The preference applies only when the required e-statement disclosure agreement exists for the **account** in the request (for example Multi-OLS where configured). If no disclosure is available for that account, the call may fail (for example **404**). - **Access token** — Obtain a **V2** OAuth 2.0 access token by calling **`POST /oauth2/v1/token`** (Authentication API — **Create V2 access token**). Grant types, required headers (for example `institutionId`, `transactionid`), and form body are defined on that operation. Send the token in the `Authorization` header as `Bearer <access_token>`. See the [Authentication API reference](/api/generated/authentication/). ### Behavior Updates whether account statements are delivered electronically or by mail for a **single** account. This preference is set per account, not for all accounts at once.
305
+ * @summary Update account e-statement preference
306
+ * @param {EStatementRequest} eStatementRequest Payload specifying the user\&#39;s preferred account statement delivery method (e-statement or mail) for a given account.
307
+ * @param {string} [hostUserId] Unique identifier for the user associated with the financial institution. This is used to provide context for the account’s e-statement preference. This parameter is **required** when the access token is issued using the **client_credentials** **grant type**; otherwise, it is optional. This parameter cannot be used together with the **loginId** query parameter.
308
+ * @param {string} [loginId] Login identifier for the user associated with the financial institution, used to provide context for the account\&#39;s e-statement preference. This parameter is **required** when the access token was issued using the &#x60;client_credentials&#x60; grant type; otherwise, it is optional. This parameter cannot be used together with the **hostUserId** query parameter.
309
+ * @param {*} [options] Override http request option.
310
+ * @throws {RequiredError}
311
+ * @memberof DocumentsAndPreferencesApiInterface
312
+ */
313
+ updateStatementDeliveryPreferenceRaw(requestParameters: DocumentsAndPreferencesApiUpdateStatementDeliveryPreferenceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
314
+ /**
315
+ * ### Before you call - **MultiStatement** — This API is available only when **MultiStatement** is configured **`true`** for the financial institution during the onboarding process (account-level statement preference). - **Disclosure** — The preference applies only when the required e-statement disclosure agreement exists for the **account** in the request (for example Multi-OLS where configured). If no disclosure is available for that account, the call may fail (for example **404**). - **Access token** — Obtain a **V2** OAuth 2.0 access token by calling **`POST /oauth2/v1/token`** (Authentication API — **Create V2 access token**). Grant types, required headers (for example `institutionId`, `transactionid`), and form body are defined on that operation. Send the token in the `Authorization` header as `Bearer <access_token>`. See the [Authentication API reference](/api/generated/authentication/). ### Behavior Updates whether account statements are delivered electronically or by mail for a **single** account. This preference is set per account, not for all accounts at once.
316
+ * Update account e-statement preference
317
+ */
318
+ updateStatementDeliveryPreference(requestParameters: DocumentsAndPreferencesApiUpdateStatementDeliveryPreferenceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
319
+ /**
320
+ * Creates request options for updateUserDisclosure without sending the request
321
+ * @param {string} [hostUserId] Identifier for the user associated with the financial institution. This parameter is **required** when the access token was issued using the &#x60;client_credentials&#x60; grant type; otherwise, it is optional. Cannot be used with &#x60;loginId&#x60; query parameter.
322
+ * @param {string} [loginId] Login identifier for the user associated with the financial institution. This parameter is **required** when the access token was issued using the &#x60;client_credentials&#x60; grant type; otherwise, it is optional. Cannot be used with &#x60;hostUserId&#x60; query parameter.
323
+ * @param {string} [institutionCustomerId] The id of the user that this recipient is associated with. (mandatory for Business banking requests)
324
+ * @param {InstitutionUserDisclosure} [institutionUserDisclosure]
325
+ * @throws {RequiredError}
326
+ * @memberof DocumentsAndPreferencesApiInterface
327
+ */
328
+ updateUserDisclosureRequestOpts(requestParameters: DocumentsAndPreferencesApiUpdateUserDisclosureRequest): Promise<runtime.RequestOpts>;
329
+ /**
330
+ * Updates an existing user disclosure record. Use this to change the user\'s acceptance status for a disclosure (e.g., from NOT_ACCEPTED to ACCEPTED). **Scope Required:** `disclosures:write` For Business Banking users, the `institutionCustomerId` query parameter is required.
331
+ * @summary Update user disclosure for a custom disclosure
332
+ * @param {string} [hostUserId] Identifier for the user associated with the financial institution. This parameter is **required** when the access token was issued using the &#x60;client_credentials&#x60; grant type; otherwise, it is optional. Cannot be used with &#x60;loginId&#x60; query parameter.
333
+ * @param {string} [loginId] Login identifier for the user associated with the financial institution. This parameter is **required** when the access token was issued using the &#x60;client_credentials&#x60; grant type; otherwise, it is optional. Cannot be used with &#x60;hostUserId&#x60; query parameter.
334
+ * @param {string} [institutionCustomerId] The id of the user that this recipient is associated with. (mandatory for Business banking requests)
335
+ * @param {InstitutionUserDisclosure} [institutionUserDisclosure]
336
+ * @param {*} [options] Override http request option.
337
+ * @throws {RequiredError}
338
+ * @memberof DocumentsAndPreferencesApiInterface
339
+ */
340
+ updateUserDisclosureRaw(requestParameters: DocumentsAndPreferencesApiUpdateUserDisclosureRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
341
+ /**
342
+ * Updates an existing user disclosure record. Use this to change the user\'s acceptance status for a disclosure (e.g., from NOT_ACCEPTED to ACCEPTED). **Scope Required:** `disclosures:write` For Business Banking users, the `institutionCustomerId` query parameter is required.
343
+ * Update user disclosure for a custom disclosure
344
+ */
345
+ updateUserDisclosure(requestParameters: DocumentsAndPreferencesApiUpdateUserDisclosureRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
346
+ }
347
+ /**
348
+ *
349
+ */
350
+ export declare class DocumentsAndPreferencesApi extends runtime.BaseAPI implements DocumentsAndPreferencesApiInterface {
351
+ /**
352
+ * Creates request options for createInstitutionDisclosure without sending the request
353
+ */
354
+ createInstitutionDisclosureRequestOpts(requestParameters: DocumentsAndPreferencesApiCreateInstitutionDisclosureRequest): Promise<runtime.RequestOpts>;
355
+ /**
356
+ * Creates a new disclosure definition for the financial institution. The disclosure can contain content as a URL reference or agreement for online statement. **Scope Required:** `disclosures:write`
357
+ * Create institution disclosure
358
+ */
359
+ createInstitutionDisclosureRaw(requestParameters: DocumentsAndPreferencesApiCreateInstitutionDisclosureRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<InstitutionDisclosure>>;
360
+ /**
361
+ * Creates a new disclosure definition for the financial institution. The disclosure can contain content as a URL reference or agreement for online statement. **Scope Required:** `disclosures:write`
362
+ * Create institution disclosure
363
+ */
364
+ createInstitutionDisclosure(requestParameters: DocumentsAndPreferencesApiCreateInstitutionDisclosureRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<InstitutionDisclosure>;
365
+ /**
366
+ * Creates request options for createUserDisclosure without sending the request
367
+ */
368
+ createUserDisclosureRequestOpts(requestParameters: DocumentsAndPreferencesApiCreateUserDisclosureRequest): Promise<runtime.RequestOpts>;
369
+ /**
370
+ * Creates a new user disclosure acceptance record. Use this to record when a user accepts or enrolls in a disclosure during onboarding or account updates. **Scope Required:** `disclosures:write` For multi-statement disclosures (e.g., e-statement consent), the `accountType` parameter specifies which account type the disclosure applies to. This API can also be used to update online statement disclosure.
371
+ * Create user disclosure
372
+ */
373
+ createUserDisclosureRaw(requestParameters: DocumentsAndPreferencesApiCreateUserDisclosureRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<InstitutionUserDisclosures>>;
374
+ /**
375
+ * Creates a new user disclosure acceptance record. Use this to record when a user accepts or enrolls in a disclosure during onboarding or account updates. **Scope Required:** `disclosures:write` For multi-statement disclosures (e.g., e-statement consent), the `accountType` parameter specifies which account type the disclosure applies to. This API can also be used to update online statement disclosure.
376
+ * Create user disclosure
377
+ */
378
+ createUserDisclosure(requestParameters: DocumentsAndPreferencesApiCreateUserDisclosureRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<InstitutionUserDisclosures | null | undefined>;
379
+ /**
380
+ * Creates request options for deleteUserDisclosure without sending the request
381
+ */
382
+ deleteUserDisclosureRequestOpts(requestParameters: DocumentsAndPreferencesApiDeleteUserDisclosureRequest): Promise<runtime.RequestOpts>;
383
+ /**
384
+ * Deletes a user disclosure acceptance record. Use this to remove a user\'s disclosure enrollment or acceptance status. **Scope Required:** `disclosures:write` **Note:** This permanently removes the disclosure record. The user may need to re-accept the disclosure if required by the institution.
385
+ * Delete user disclosure for online statement
386
+ */
387
+ deleteUserDisclosureRaw(requestParameters: DocumentsAndPreferencesApiDeleteUserDisclosureRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
388
+ /**
389
+ * Deletes a user disclosure acceptance record. Use this to remove a user\'s disclosure enrollment or acceptance status. **Scope Required:** `disclosures:write` **Note:** This permanently removes the disclosure record. The user may need to re-accept the disclosure if required by the institution.
390
+ * Delete user disclosure for online statement
391
+ */
392
+ deleteUserDisclosure(requestParameters: DocumentsAndPreferencesApiDeleteUserDisclosureRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
393
+ /**
394
+ * Creates request options for getDisclosuresByAccount without sending the request
395
+ */
396
+ getDisclosuresByAccountRequestOpts(requestParameters: DocumentsAndPreferencesApiGetDisclosuresByAccountRequest): Promise<runtime.RequestOpts>;
397
+ /**
398
+ * API to fetch disclosure information for the particular account Id
399
+ * To fetch disclosure information for the particular account Id
400
+ */
401
+ getDisclosuresByAccountRaw(requestParameters: DocumentsAndPreferencesApiGetDisclosuresByAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EStatementDisclosureResponse>>;
402
+ /**
403
+ * API to fetch disclosure information for the particular account Id
404
+ * To fetch disclosure information for the particular account Id
405
+ */
406
+ getDisclosuresByAccount(requestParameters: DocumentsAndPreferencesApiGetDisclosuresByAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EStatementDisclosureResponse>;
407
+ /**
408
+ * Creates request options for getEstatementsReport without sending the request
409
+ */
410
+ getEstatementsReportRequestOpts(requestParameters: DocumentsAndPreferencesApiGetEstatementsReportRequest): Promise<runtime.RequestOpts>;
411
+ /**
412
+ * Retrieves opt-in preferences for all accounts associated with a specified customer. Supports filtering by account type.
413
+ * API to fetch the opt-in data
414
+ */
415
+ getEstatementsReportRaw(requestParameters: DocumentsAndPreferencesApiGetEstatementsReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EStatementReportResponse>>;
416
+ /**
417
+ * Retrieves opt-in preferences for all accounts associated with a specified customer. Supports filtering by account type.
418
+ * API to fetch the opt-in data
419
+ */
420
+ getEstatementsReport(requestParameters: DocumentsAndPreferencesApiGetEstatementsReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EStatementReportResponse>;
421
+ /**
422
+ * Creates request options for listInstitutionDisclosures without sending the request
423
+ */
424
+ listInstitutionDisclosuresRequestOpts(): Promise<runtime.RequestOpts>;
425
+ /**
426
+ * Retrieves all disclosures configured for the financial institution. Returns all disclosure definitions regardless of their enabled/disabled status. Use this endpoint to display available disclosures to users or to audit the institution\'s disclosure configuration.
427
+ * List institution disclosures
428
+ */
429
+ listInstitutionDisclosuresRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<InstitutionDisclosures>>;
430
+ /**
431
+ * Retrieves all disclosures configured for the financial institution. Returns all disclosure definitions regardless of their enabled/disabled status. Use this endpoint to display available disclosures to users or to audit the institution\'s disclosure configuration.
432
+ * List institution disclosures
433
+ */
434
+ listInstitutionDisclosures(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<InstitutionDisclosures>;
435
+ /**
436
+ * Creates request options for listUserDisclosures without sending the request
437
+ */
438
+ listUserDisclosuresRequestOpts(requestParameters: DocumentsAndPreferencesApiListUserDisclosuresRequest): Promise<runtime.RequestOpts>;
439
+ /**
440
+ * Retrieves all disclosure acceptance records for the authenticated user. Returns the status of each disclosure (ACCEPTED, NOT_ACCEPTED, ENROLLED, NOT_ENROLLED) along with the acceptance/rejection timestamp. For Business Banking users, the `institutionCustomerId` query parameter is required to specify the customer context.
441
+ * List user disclosures
442
+ */
443
+ listUserDisclosuresRaw(requestParameters: DocumentsAndPreferencesApiListUserDisclosuresRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<InstitutionUserDisclosures>>;
444
+ /**
445
+ * Retrieves all disclosure acceptance records for the authenticated user. Returns the status of each disclosure (ACCEPTED, NOT_ACCEPTED, ENROLLED, NOT_ENROLLED) along with the acceptance/rejection timestamp. For Business Banking users, the `institutionCustomerId` query parameter is required to specify the customer context.
446
+ * List user disclosures
447
+ */
448
+ listUserDisclosures(requestParameters?: DocumentsAndPreferencesApiListUserDisclosuresRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<InstitutionUserDisclosures>;
449
+ /**
450
+ * Creates request options for updateEStatementPreferences without sending the request
451
+ */
452
+ updateEStatementPreferencesRequestOpts(requestParameters: DocumentsAndPreferencesApiUpdateEStatementPreferencesRequest): Promise<runtime.RequestOpts>;
453
+ /**
454
+ * ### Before you call - **MultiStatement** — This API is available only when the **MultiStatement** feature configured to `false` for the financial institution during the onboarding process. - **Disclosure** — The preference applies only where the applicable e-statement disclosure has been approved for the user. - **Access token** — Obtain a **V2** OAuth 2.0 access token by calling **`POST /oauth2/v1/token`** (Authentication API — **Create V2 access token**). Grant types, required headers (for example `institutionId`, `transactionid`), and form body are defined in that operation. Then pass the token in the `Authorization` header as `Bearer <access_token>`. For full details, see the [Authentication API reference](/api/generated/authentication/). ### Behavior Enables users to apply a unified statement delivery preference (online or mail) to **all** of their accounts.
455
+ * Update user e-statement preferences
456
+ */
457
+ updateEStatementPreferencesRaw(requestParameters: DocumentsAndPreferencesApiUpdateEStatementPreferencesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
458
+ /**
459
+ * ### Before you call - **MultiStatement** — This API is available only when the **MultiStatement** feature configured to `false` for the financial institution during the onboarding process. - **Disclosure** — The preference applies only where the applicable e-statement disclosure has been approved for the user. - **Access token** — Obtain a **V2** OAuth 2.0 access token by calling **`POST /oauth2/v1/token`** (Authentication API — **Create V2 access token**). Grant types, required headers (for example `institutionId`, `transactionid`), and form body are defined in that operation. Then pass the token in the `Authorization` header as `Bearer <access_token>`. For full details, see the [Authentication API reference](/api/generated/authentication/). ### Behavior Enables users to apply a unified statement delivery preference (online or mail) to **all** of their accounts.
460
+ * Update user e-statement preferences
461
+ */
462
+ updateEStatementPreferences(requestParameters: DocumentsAndPreferencesApiUpdateEStatementPreferencesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
463
+ /**
464
+ * Creates request options for updateInstitutionDisclosure without sending the request
465
+ */
466
+ updateInstitutionDisclosureRequestOpts(requestParameters: DocumentsAndPreferencesApiUpdateInstitutionDisclosureRequest): Promise<runtime.RequestOpts>;
467
+ /**
468
+ * Updates an existing institution disclosure definition. Use this to modify disclosure content, change the data type, or enable/disable the disclosure. **Scope Required:** `disclosures:write` **Note:** The disclosure ID in the URL must match the ID in the request body.
469
+ * Update institution disclosure
470
+ */
471
+ updateInstitutionDisclosureRaw(requestParameters: DocumentsAndPreferencesApiUpdateInstitutionDisclosureRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<InstitutionDisclosure>>;
472
+ /**
473
+ * Updates an existing institution disclosure definition. Use this to modify disclosure content, change the data type, or enable/disable the disclosure. **Scope Required:** `disclosures:write` **Note:** The disclosure ID in the URL must match the ID in the request body.
474
+ * Update institution disclosure
475
+ */
476
+ updateInstitutionDisclosure(requestParameters: DocumentsAndPreferencesApiUpdateInstitutionDisclosureRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<InstitutionDisclosure>;
477
+ /**
478
+ * Creates request options for updateStatementDeliveryPreference without sending the request
479
+ */
480
+ updateStatementDeliveryPreferenceRequestOpts(requestParameters: DocumentsAndPreferencesApiUpdateStatementDeliveryPreferenceRequest): Promise<runtime.RequestOpts>;
481
+ /**
482
+ * ### Before you call - **MultiStatement** — This API is available only when **MultiStatement** is configured **`true`** for the financial institution during the onboarding process (account-level statement preference). - **Disclosure** — The preference applies only when the required e-statement disclosure agreement exists for the **account** in the request (for example Multi-OLS where configured). If no disclosure is available for that account, the call may fail (for example **404**). - **Access token** — Obtain a **V2** OAuth 2.0 access token by calling **`POST /oauth2/v1/token`** (Authentication API — **Create V2 access token**). Grant types, required headers (for example `institutionId`, `transactionid`), and form body are defined on that operation. Send the token in the `Authorization` header as `Bearer <access_token>`. See the [Authentication API reference](/api/generated/authentication/). ### Behavior Updates whether account statements are delivered electronically or by mail for a **single** account. This preference is set per account, not for all accounts at once.
483
+ * Update account e-statement preference
484
+ */
485
+ updateStatementDeliveryPreferenceRaw(requestParameters: DocumentsAndPreferencesApiUpdateStatementDeliveryPreferenceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
486
+ /**
487
+ * ### Before you call - **MultiStatement** — This API is available only when **MultiStatement** is configured **`true`** for the financial institution during the onboarding process (account-level statement preference). - **Disclosure** — The preference applies only when the required e-statement disclosure agreement exists for the **account** in the request (for example Multi-OLS where configured). If no disclosure is available for that account, the call may fail (for example **404**). - **Access token** — Obtain a **V2** OAuth 2.0 access token by calling **`POST /oauth2/v1/token`** (Authentication API — **Create V2 access token**). Grant types, required headers (for example `institutionId`, `transactionid`), and form body are defined on that operation. Send the token in the `Authorization` header as `Bearer <access_token>`. See the [Authentication API reference](/api/generated/authentication/). ### Behavior Updates whether account statements are delivered electronically or by mail for a **single** account. This preference is set per account, not for all accounts at once.
488
+ * Update account e-statement preference
489
+ */
490
+ updateStatementDeliveryPreference(requestParameters: DocumentsAndPreferencesApiUpdateStatementDeliveryPreferenceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
491
+ /**
492
+ * Creates request options for updateUserDisclosure without sending the request
493
+ */
494
+ updateUserDisclosureRequestOpts(requestParameters: DocumentsAndPreferencesApiUpdateUserDisclosureRequest): Promise<runtime.RequestOpts>;
495
+ /**
496
+ * Updates an existing user disclosure record. Use this to change the user\'s acceptance status for a disclosure (e.g., from NOT_ACCEPTED to ACCEPTED). **Scope Required:** `disclosures:write` For Business Banking users, the `institutionCustomerId` query parameter is required.
497
+ * Update user disclosure for a custom disclosure
498
+ */
499
+ updateUserDisclosureRaw(requestParameters: DocumentsAndPreferencesApiUpdateUserDisclosureRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
500
+ /**
501
+ * Updates an existing user disclosure record. Use this to change the user\'s acceptance status for a disclosure (e.g., from NOT_ACCEPTED to ACCEPTED). **Scope Required:** `disclosures:write` For Business Banking users, the `institutionCustomerId` query parameter is required.
502
+ * Update user disclosure for a custom disclosure
503
+ */
504
+ updateUserDisclosure(requestParameters?: DocumentsAndPreferencesApiUpdateUserDisclosureRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
505
+ }