@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,69 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Candescent DI API
5
+ * 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/)**.
6
+ *
7
+ * The version of the OpenAPI document: 1.4.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ /**
15
+ * Check if a given object implements the ImportJobDTOSingle interface.
16
+ */
17
+ export function instanceOfImportJobDTOSingle(value) {
18
+ return true;
19
+ }
20
+ export function ImportJobDTOSingleFromJSON(json) {
21
+ return ImportJobDTOSingleFromJSONTyped(json, false);
22
+ }
23
+ export function ImportJobDTOSingleFromJSONTyped(json, ignoreDiscriminator) {
24
+ if (json == null) {
25
+ return json;
26
+ }
27
+ return {
28
+ 'jobId': json['jobId'] == null ? undefined : json['jobId'],
29
+ 'groupId': json['groupId'] == null ? undefined : json['groupId'],
30
+ 'groupName': json['groupName'] == null ? undefined : json['groupName'],
31
+ 'groupType': json['groupType'] == null ? undefined : json['groupType'],
32
+ 'inputFileName': json['inputFileName'] == null ? undefined : json['inputFileName'],
33
+ 'workingFileName': json['workingFileName'] == null ? undefined : json['workingFileName'],
34
+ 'type': json['type'] == null ? undefined : json['type'],
35
+ 'totalRecordsCount': json['totalRecordsCount'] == null ? undefined : json['totalRecordsCount'],
36
+ 'successRecordsCount': json['successRecordsCount'] == null ? undefined : json['successRecordsCount'],
37
+ 'failedRecordsCount': json['failedRecordsCount'] == null ? undefined : json['failedRecordsCount'],
38
+ 'jobDetails': json['jobDetails'] == null ? undefined : json['jobDetails'],
39
+ 'jobStatus': json['jobStatus'] == null ? undefined : json['jobStatus'],
40
+ 'jobCreatedBy': json['jobCreatedBy'] == null ? undefined : json['jobCreatedBy'],
41
+ 'createdDateTime': json['createdDateTime'] == null ? undefined : json['createdDateTime'],
42
+ 'lastUpdatedDateTime': json['lastUpdatedDateTime'] == null ? undefined : json['lastUpdatedDateTime'],
43
+ };
44
+ }
45
+ export function ImportJobDTOSingleToJSON(json) {
46
+ return ImportJobDTOSingleToJSONTyped(json, false);
47
+ }
48
+ export function ImportJobDTOSingleToJSONTyped(value, ignoreDiscriminator = false) {
49
+ if (value == null) {
50
+ return value;
51
+ }
52
+ return {
53
+ 'jobId': value['jobId'],
54
+ 'groupId': value['groupId'],
55
+ 'groupName': value['groupName'],
56
+ 'groupType': value['groupType'],
57
+ 'inputFileName': value['inputFileName'],
58
+ 'workingFileName': value['workingFileName'],
59
+ 'type': value['type'],
60
+ 'totalRecordsCount': value['totalRecordsCount'],
61
+ 'successRecordsCount': value['successRecordsCount'],
62
+ 'failedRecordsCount': value['failedRecordsCount'],
63
+ 'jobDetails': value['jobDetails'],
64
+ 'jobStatus': value['jobStatus'],
65
+ 'jobCreatedBy': value['jobCreatedBy'],
66
+ 'createdDateTime': value['createdDateTime'],
67
+ 'lastUpdatedDateTime': value['lastUpdatedDateTime'],
68
+ };
69
+ }
@@ -0,0 +1,45 @@
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 type { Links } from './Links.js';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface ImportJobErrorDTO
17
+ */
18
+ export interface ImportJobErrorDTO {
19
+ /**
20
+ *
21
+ * @type {number}
22
+ * @memberof ImportJobErrorDTO
23
+ */
24
+ lineNbr?: number;
25
+ /**
26
+ *
27
+ * @type {string}
28
+ * @memberof ImportJobErrorDTO
29
+ */
30
+ errorMsg?: string;
31
+ /**
32
+ *
33
+ * @type {Array<Links>}
34
+ * @memberof ImportJobErrorDTO
35
+ */
36
+ links?: Array<Links>;
37
+ }
38
+ /**
39
+ * Check if a given object implements the ImportJobErrorDTO interface.
40
+ */
41
+ export declare function instanceOfImportJobErrorDTO(value: object): value is ImportJobErrorDTO;
42
+ export declare function ImportJobErrorDTOFromJSON(json: any): ImportJobErrorDTO;
43
+ export declare function ImportJobErrorDTOFromJSONTyped(json: any, ignoreDiscriminator: boolean): ImportJobErrorDTO;
44
+ export declare function ImportJobErrorDTOToJSON(json: any): ImportJobErrorDTO;
45
+ export declare function ImportJobErrorDTOToJSONTyped(value?: ImportJobErrorDTO | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,46 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Candescent DI API
5
+ * 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/)**.
6
+ *
7
+ * The version of the OpenAPI document: 1.4.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ import { LinksFromJSON, LinksToJSON, } from './Links.js';
15
+ /**
16
+ * Check if a given object implements the ImportJobErrorDTO interface.
17
+ */
18
+ export function instanceOfImportJobErrorDTO(value) {
19
+ return true;
20
+ }
21
+ export function ImportJobErrorDTOFromJSON(json) {
22
+ return ImportJobErrorDTOFromJSONTyped(json, false);
23
+ }
24
+ export function ImportJobErrorDTOFromJSONTyped(json, ignoreDiscriminator) {
25
+ if (json == null) {
26
+ return json;
27
+ }
28
+ return {
29
+ 'lineNbr': json['lineNbr'] == null ? undefined : json['lineNbr'],
30
+ 'errorMsg': json['errorMsg'] == null ? undefined : json['errorMsg'],
31
+ 'links': json['links'] == null ? undefined : (json['links'].map(LinksFromJSON)),
32
+ };
33
+ }
34
+ export function ImportJobErrorDTOToJSON(json) {
35
+ return ImportJobErrorDTOToJSONTyped(json, false);
36
+ }
37
+ export function ImportJobErrorDTOToJSONTyped(value, ignoreDiscriminator = false) {
38
+ if (value == null) {
39
+ return value;
40
+ }
41
+ return {
42
+ 'lineNbr': value['lineNbr'],
43
+ 'errorMsg': value['errorMsg'],
44
+ 'links': value['links'] == null ? undefined : (value['links'].map(LinksToJSON)),
45
+ };
46
+ }
@@ -0,0 +1,70 @@
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
+ /**
13
+ *
14
+ * @export
15
+ * @interface InstitutionAlertTypeResource
16
+ */
17
+ export interface InstitutionAlertTypeResource {
18
+ /**
19
+ *
20
+ * @type {number}
21
+ * @memberof InstitutionAlertTypeResource
22
+ */
23
+ institutionAlertTypeId?: number;
24
+ /**
25
+ *
26
+ * @type {string}
27
+ * @memberof InstitutionAlertTypeResource
28
+ */
29
+ alertTypeName?: string;
30
+ /**
31
+ *
32
+ * @type {string}
33
+ * @memberof InstitutionAlertTypeResource
34
+ */
35
+ channelsOptd?: string;
36
+ /**
37
+ *
38
+ * @type {string}
39
+ * @memberof InstitutionAlertTypeResource
40
+ */
41
+ reason?: string;
42
+ /**
43
+ *
44
+ * @type {InstitutionAlertTypeResourceStatusOptdEnum}
45
+ * @memberof InstitutionAlertTypeResource
46
+ */
47
+ statusOptd?: InstitutionAlertTypeResourceStatusOptdEnum;
48
+ /**
49
+ *
50
+ * @type {string}
51
+ * @memberof InstitutionAlertTypeResource
52
+ */
53
+ institutionId?: string;
54
+ }
55
+ /**
56
+ * @export
57
+ */
58
+ export declare const InstitutionAlertTypeResourceStatusOptdEnum: {
59
+ readonly ACTIVE: "ACTIVE";
60
+ readonly INACTIVE: "INACTIVE";
61
+ };
62
+ export type InstitutionAlertTypeResourceStatusOptdEnum = typeof InstitutionAlertTypeResourceStatusOptdEnum[keyof typeof InstitutionAlertTypeResourceStatusOptdEnum];
63
+ /**
64
+ * Check if a given object implements the InstitutionAlertTypeResource interface.
65
+ */
66
+ export declare function instanceOfInstitutionAlertTypeResource(value: object): value is InstitutionAlertTypeResource;
67
+ export declare function InstitutionAlertTypeResourceFromJSON(json: any): InstitutionAlertTypeResource;
68
+ export declare function InstitutionAlertTypeResourceFromJSONTyped(json: any, ignoreDiscriminator: boolean): InstitutionAlertTypeResource;
69
+ export declare function InstitutionAlertTypeResourceToJSON(json: any): InstitutionAlertTypeResource;
70
+ export declare function InstitutionAlertTypeResourceToJSONTyped(value?: InstitutionAlertTypeResource | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,58 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Candescent DI API
5
+ * 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/)**.
6
+ *
7
+ * The version of the OpenAPI document: 1.4.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ /**
15
+ * @export
16
+ */
17
+ export const InstitutionAlertTypeResourceStatusOptdEnum = {
18
+ ACTIVE: 'ACTIVE',
19
+ INACTIVE: 'INACTIVE'
20
+ };
21
+ /**
22
+ * Check if a given object implements the InstitutionAlertTypeResource interface.
23
+ */
24
+ export function instanceOfInstitutionAlertTypeResource(value) {
25
+ return true;
26
+ }
27
+ export function InstitutionAlertTypeResourceFromJSON(json) {
28
+ return InstitutionAlertTypeResourceFromJSONTyped(json, false);
29
+ }
30
+ export function InstitutionAlertTypeResourceFromJSONTyped(json, ignoreDiscriminator) {
31
+ if (json == null) {
32
+ return json;
33
+ }
34
+ return {
35
+ 'institutionAlertTypeId': json['institutionAlertTypeId'] == null ? undefined : json['institutionAlertTypeId'],
36
+ 'alertTypeName': json['alertTypeName'] == null ? undefined : json['alertTypeName'],
37
+ 'channelsOptd': json['channelsOptd'] == null ? undefined : json['channelsOptd'],
38
+ 'reason': json['reason'] == null ? undefined : json['reason'],
39
+ 'statusOptd': json['statusOptd'] == null ? undefined : json['statusOptd'],
40
+ 'institutionId': json['institutionId'] == null ? undefined : json['institutionId'],
41
+ };
42
+ }
43
+ export function InstitutionAlertTypeResourceToJSON(json) {
44
+ return InstitutionAlertTypeResourceToJSONTyped(json, false);
45
+ }
46
+ export function InstitutionAlertTypeResourceToJSONTyped(value, ignoreDiscriminator = false) {
47
+ if (value == null) {
48
+ return value;
49
+ }
50
+ return {
51
+ 'institutionAlertTypeId': value['institutionAlertTypeId'],
52
+ 'alertTypeName': value['alertTypeName'],
53
+ 'channelsOptd': value['channelsOptd'],
54
+ 'reason': value['reason'],
55
+ 'statusOptd': value['statusOptd'],
56
+ 'institutionId': value['institutionId'],
57
+ };
58
+ }
@@ -0,0 +1,33 @@
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 type { InstitutionAlertTypeResource } from './InstitutionAlertTypeResource.js';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface InstitutionAlertTypeResources
17
+ */
18
+ export interface InstitutionAlertTypeResources {
19
+ /**
20
+ *
21
+ * @type {Array<InstitutionAlertTypeResource>}
22
+ * @memberof InstitutionAlertTypeResources
23
+ */
24
+ institutionAlertTypes?: Array<InstitutionAlertTypeResource>;
25
+ }
26
+ /**
27
+ * Check if a given object implements the InstitutionAlertTypeResources interface.
28
+ */
29
+ export declare function instanceOfInstitutionAlertTypeResources(value: object): value is InstitutionAlertTypeResources;
30
+ export declare function InstitutionAlertTypeResourcesFromJSON(json: any): InstitutionAlertTypeResources;
31
+ export declare function InstitutionAlertTypeResourcesFromJSONTyped(json: any, ignoreDiscriminator: boolean): InstitutionAlertTypeResources;
32
+ export declare function InstitutionAlertTypeResourcesToJSON(json: any): InstitutionAlertTypeResources;
33
+ export declare function InstitutionAlertTypeResourcesToJSONTyped(value?: InstitutionAlertTypeResources | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,42 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Candescent DI API
5
+ * 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/)**.
6
+ *
7
+ * The version of the OpenAPI document: 1.4.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ import { InstitutionAlertTypeResourceFromJSON, InstitutionAlertTypeResourceToJSON, } from './InstitutionAlertTypeResource.js';
15
+ /**
16
+ * Check if a given object implements the InstitutionAlertTypeResources interface.
17
+ */
18
+ export function instanceOfInstitutionAlertTypeResources(value) {
19
+ return true;
20
+ }
21
+ export function InstitutionAlertTypeResourcesFromJSON(json) {
22
+ return InstitutionAlertTypeResourcesFromJSONTyped(json, false);
23
+ }
24
+ export function InstitutionAlertTypeResourcesFromJSONTyped(json, ignoreDiscriminator) {
25
+ if (json == null) {
26
+ return json;
27
+ }
28
+ return {
29
+ 'institutionAlertTypes': json['institutionAlertTypes'] == null ? undefined : (json['institutionAlertTypes'].map(InstitutionAlertTypeResourceFromJSON)),
30
+ };
31
+ }
32
+ export function InstitutionAlertTypeResourcesToJSON(json) {
33
+ return InstitutionAlertTypeResourcesToJSONTyped(json, false);
34
+ }
35
+ export function InstitutionAlertTypeResourcesToJSONTyped(value, ignoreDiscriminator = false) {
36
+ if (value == null) {
37
+ return value;
38
+ }
39
+ return {
40
+ 'institutionAlertTypes': value['institutionAlertTypes'] == null ? undefined : (value['institutionAlertTypes'].map(InstitutionAlertTypeResourceToJSON)),
41
+ };
42
+ }
@@ -0,0 +1,69 @@
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 type { InstitutionCustomerAdditionalInfo } from './InstitutionCustomerAdditionalInfo.js';
13
+ /**
14
+ * Institution customer details for the user, this is only populated for retail users (primary and subuser)
15
+ * @export
16
+ * @interface InstitutionCustomer
17
+ */
18
+ export interface InstitutionCustomer {
19
+ /**
20
+ * Institution customer id for the user
21
+ * @type {string}
22
+ * @memberof InstitutionCustomer
23
+ */
24
+ institutionCustomerId?: string;
25
+ /**
26
+ * Member number of the user
27
+ * @type {string}
28
+ * @memberof InstitutionCustomer
29
+ */
30
+ memberNumber?: string;
31
+ /**
32
+ * Display name for the member/customer
33
+ * @type {string}
34
+ * @memberof InstitutionCustomer
35
+ */
36
+ memberName?: string;
37
+ /**
38
+ * User login id to connect to host system
39
+ * @type {string}
40
+ * @memberof InstitutionCustomer
41
+ */
42
+ hostLoginId?: string;
43
+ /**
44
+ * Type of the customer (e.g. RETAIL, BUSINESS)
45
+ * @type {string}
46
+ * @memberof InstitutionCustomer
47
+ */
48
+ customerType?: string;
49
+ /**
50
+ * Indicates whether this is the primary institution customer record
51
+ * @type {boolean}
52
+ * @memberof InstitutionCustomer
53
+ */
54
+ primary?: boolean;
55
+ /**
56
+ *
57
+ * @type {InstitutionCustomerAdditionalInfo}
58
+ * @memberof InstitutionCustomer
59
+ */
60
+ additionalInfo?: InstitutionCustomerAdditionalInfo;
61
+ }
62
+ /**
63
+ * Check if a given object implements the InstitutionCustomer interface.
64
+ */
65
+ export declare function instanceOfInstitutionCustomer(value: object): value is InstitutionCustomer;
66
+ export declare function InstitutionCustomerFromJSON(json: any): InstitutionCustomer;
67
+ export declare function InstitutionCustomerFromJSONTyped(json: any, ignoreDiscriminator: boolean): InstitutionCustomer;
68
+ export declare function InstitutionCustomerToJSON(json: any): InstitutionCustomer;
69
+ export declare function InstitutionCustomerToJSONTyped(value?: InstitutionCustomer | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,54 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Candescent DI API
5
+ * 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/)**.
6
+ *
7
+ * The version of the OpenAPI document: 1.4.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ import { InstitutionCustomerAdditionalInfoFromJSON, InstitutionCustomerAdditionalInfoToJSON, } from './InstitutionCustomerAdditionalInfo.js';
15
+ /**
16
+ * Check if a given object implements the InstitutionCustomer interface.
17
+ */
18
+ export function instanceOfInstitutionCustomer(value) {
19
+ return true;
20
+ }
21
+ export function InstitutionCustomerFromJSON(json) {
22
+ return InstitutionCustomerFromJSONTyped(json, false);
23
+ }
24
+ export function InstitutionCustomerFromJSONTyped(json, ignoreDiscriminator) {
25
+ if (json == null) {
26
+ return json;
27
+ }
28
+ return {
29
+ 'institutionCustomerId': json['institutionCustomerId'] == null ? undefined : json['institutionCustomerId'],
30
+ 'memberNumber': json['memberNumber'] == null ? undefined : json['memberNumber'],
31
+ 'memberName': json['memberName'] == null ? undefined : json['memberName'],
32
+ 'hostLoginId': json['hostLoginId'] == null ? undefined : json['hostLoginId'],
33
+ 'customerType': json['customerType'] == null ? undefined : json['customerType'],
34
+ 'primary': json['primary'] == null ? undefined : json['primary'],
35
+ 'additionalInfo': json['additionalInfo'] == null ? undefined : InstitutionCustomerAdditionalInfoFromJSON(json['additionalInfo']),
36
+ };
37
+ }
38
+ export function InstitutionCustomerToJSON(json) {
39
+ return InstitutionCustomerToJSONTyped(json, false);
40
+ }
41
+ export function InstitutionCustomerToJSONTyped(value, ignoreDiscriminator = false) {
42
+ if (value == null) {
43
+ return value;
44
+ }
45
+ return {
46
+ 'institutionCustomerId': value['institutionCustomerId'],
47
+ 'memberNumber': value['memberNumber'],
48
+ 'memberName': value['memberName'],
49
+ 'hostLoginId': value['hostLoginId'],
50
+ 'customerType': value['customerType'],
51
+ 'primary': value['primary'],
52
+ 'additionalInfo': InstitutionCustomerAdditionalInfoToJSON(value['additionalInfo']),
53
+ };
54
+ }
@@ -0,0 +1,33 @@
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 type { MapItem } from './MapItem.js';
13
+ /**
14
+ * Additional info about institution customer
15
+ * @export
16
+ * @interface InstitutionCustomerAdditionalInfo
17
+ */
18
+ export interface InstitutionCustomerAdditionalInfo {
19
+ /**
20
+ *
21
+ * @type {MapItem}
22
+ * @memberof InstitutionCustomerAdditionalInfo
23
+ */
24
+ additionalProperties?: MapItem;
25
+ }
26
+ /**
27
+ * Check if a given object implements the InstitutionCustomerAdditionalInfo interface.
28
+ */
29
+ export declare function instanceOfInstitutionCustomerAdditionalInfo(value: object): value is InstitutionCustomerAdditionalInfo;
30
+ export declare function InstitutionCustomerAdditionalInfoFromJSON(json: any): InstitutionCustomerAdditionalInfo;
31
+ export declare function InstitutionCustomerAdditionalInfoFromJSONTyped(json: any, ignoreDiscriminator: boolean): InstitutionCustomerAdditionalInfo;
32
+ export declare function InstitutionCustomerAdditionalInfoToJSON(json: any): InstitutionCustomerAdditionalInfo;
33
+ export declare function InstitutionCustomerAdditionalInfoToJSONTyped(value?: InstitutionCustomerAdditionalInfo | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,42 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Candescent DI API
5
+ * 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/)**.
6
+ *
7
+ * The version of the OpenAPI document: 1.4.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ import { MapItemFromJSON, MapItemToJSON, } from './MapItem.js';
15
+ /**
16
+ * Check if a given object implements the InstitutionCustomerAdditionalInfo interface.
17
+ */
18
+ export function instanceOfInstitutionCustomerAdditionalInfo(value) {
19
+ return true;
20
+ }
21
+ export function InstitutionCustomerAdditionalInfoFromJSON(json) {
22
+ return InstitutionCustomerAdditionalInfoFromJSONTyped(json, false);
23
+ }
24
+ export function InstitutionCustomerAdditionalInfoFromJSONTyped(json, ignoreDiscriminator) {
25
+ if (json == null) {
26
+ return json;
27
+ }
28
+ return {
29
+ 'additionalProperties': json['additionalProperties'] == null ? undefined : MapItemFromJSON(json['additionalProperties']),
30
+ };
31
+ }
32
+ export function InstitutionCustomerAdditionalInfoToJSON(json) {
33
+ return InstitutionCustomerAdditionalInfoToJSONTyped(json, false);
34
+ }
35
+ export function InstitutionCustomerAdditionalInfoToJSONTyped(value, ignoreDiscriminator = false) {
36
+ if (value == null) {
37
+ return value;
38
+ }
39
+ return {
40
+ 'additionalProperties': MapItemToJSON(value['additionalProperties']),
41
+ };
42
+ }