@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.
- package/README.md +439 -0
- package/dist/generated/src/apis/AccountsApi.d.ts +447 -0
- package/dist/generated/src/apis/AccountsApi.js +501 -0
- package/dist/generated/src/apis/AlertConfigurationApi.d.ts +533 -0
- package/dist/generated/src/apis/AlertConfigurationApi.js +572 -0
- package/dist/generated/src/apis/AlertDeliveryApi.d.ts +218 -0
- package/dist/generated/src/apis/AlertDeliveryApi.js +219 -0
- package/dist/generated/src/apis/AlertPreferencesApi.d.ts +437 -0
- package/dist/generated/src/apis/AlertPreferencesApi.js +467 -0
- package/dist/generated/src/apis/AuthenticationApi.d.ts +277 -0
- package/dist/generated/src/apis/AuthenticationApi.js +378 -0
- package/dist/generated/src/apis/BusinessBankingApi.d.ts +308 -0
- package/dist/generated/src/apis/BusinessBankingApi.js +340 -0
- package/dist/generated/src/apis/CustomerCampaignsApi.d.ts +527 -0
- package/dist/generated/src/apis/CustomerCampaignsApi.js +596 -0
- package/dist/generated/src/apis/CustomerManagementApi.d.ts +452 -0
- package/dist/generated/src/apis/CustomerManagementApi.js +486 -0
- package/dist/generated/src/apis/DocumentsAndPreferencesApi.d.ts +505 -0
- package/dist/generated/src/apis/DocumentsAndPreferencesApi.js +555 -0
- package/dist/generated/src/apis/MXApi.d.ts +211 -0
- package/dist/generated/src/apis/MXApi.js +252 -0
- package/dist/generated/src/apis/MoneyMovementApi.d.ts +299 -0
- package/dist/generated/src/apis/MoneyMovementApi.js +317 -0
- package/dist/generated/src/apis/NotificationChannelsApi.d.ts +403 -0
- package/dist/generated/src/apis/NotificationChannelsApi.js +444 -0
- package/dist/generated/src/apis/index.d.ts +12 -0
- package/dist/generated/src/apis/index.js +14 -0
- package/dist/generated/src/index.d.ts +3 -0
- package/dist/generated/src/index.js +5 -0
- package/dist/generated/src/models/Account.d.ts +218 -0
- package/dist/generated/src/models/Account.js +107 -0
- package/dist/generated/src/models/Account1.d.ts +206 -0
- package/dist/generated/src/models/Account1.js +103 -0
- package/dist/generated/src/models/Account2Inner.d.ts +399 -0
- package/dist/generated/src/models/Account2Inner.js +178 -0
- package/dist/generated/src/models/Account3.d.ts +636 -0
- package/dist/generated/src/models/Account3.js +300 -0
- package/dist/generated/src/models/AccountCategory.d.ts +28 -0
- package/dist/generated/src/models/AccountCategory.js +46 -0
- package/dist/generated/src/models/AccountEntitledFeature.d.ts +35 -0
- package/dist/generated/src/models/AccountEntitledFeature.js +44 -0
- package/dist/generated/src/models/AccountEvent.d.ts +46 -0
- package/dist/generated/src/models/AccountEvent.js +47 -0
- package/dist/generated/src/models/AccountId.d.ts +50 -0
- package/dist/generated/src/models/AccountId.js +54 -0
- package/dist/generated/src/models/AccountNickname.d.ts +38 -0
- package/dist/generated/src/models/AccountNickname.js +43 -0
- package/dist/generated/src/models/AccountNumber.d.ts +80 -0
- package/dist/generated/src/models/AccountNumber.js +57 -0
- package/dist/generated/src/models/AccountRefreshStatus.d.ts +77 -0
- package/dist/generated/src/models/AccountRefreshStatus.js +61 -0
- package/dist/generated/src/models/AccountStatus.d.ts +116 -0
- package/dist/generated/src/models/AccountStatus.js +69 -0
- package/dist/generated/src/models/AccountStatus1.d.ts +116 -0
- package/dist/generated/src/models/AccountStatus1.js +69 -0
- package/dist/generated/src/models/AccountStatuses.d.ts +116 -0
- package/dist/generated/src/models/AccountStatuses.js +69 -0
- package/dist/generated/src/models/AccountTransaction.d.ts +177 -0
- package/dist/generated/src/models/AccountTransaction.js +90 -0
- package/dist/generated/src/models/AccountTransaction1.d.ts +380 -0
- package/dist/generated/src/models/AccountTransaction1.js +203 -0
- package/dist/generated/src/models/AccountTransactions.d.ts +168 -0
- package/dist/generated/src/models/AccountTransactions.js +96 -0
- package/dist/generated/src/models/AccountType.d.ts +51 -0
- package/dist/generated/src/models/AccountType.js +48 -0
- package/dist/generated/src/models/AccountType1.d.ts +45 -0
- package/dist/generated/src/models/AccountType1.js +46 -0
- package/dist/generated/src/models/AccountType2.d.ts +80 -0
- package/dist/generated/src/models/AccountType2.js +76 -0
- package/dist/generated/src/models/AccountsResponse.d.ts +39 -0
- package/dist/generated/src/models/AccountsResponse.js +44 -0
- package/dist/generated/src/models/Action.d.ts +39 -0
- package/dist/generated/src/models/Action.js +44 -0
- package/dist/generated/src/models/Actions.d.ts +62 -0
- package/dist/generated/src/models/Actions.js +51 -0
- package/dist/generated/src/models/Actions1.d.ts +56 -0
- package/dist/generated/src/models/Actions1.js +49 -0
- package/dist/generated/src/models/AdditionalFilters.d.ts +47 -0
- package/dist/generated/src/models/AdditionalFilters.js +52 -0
- package/dist/generated/src/models/AlertHistoryContentResource.d.ts +68 -0
- package/dist/generated/src/models/AlertHistoryContentResource.js +53 -0
- package/dist/generated/src/models/AlertHistorySummaryResource.d.ts +94 -0
- package/dist/generated/src/models/AlertHistorySummaryResource.js +61 -0
- package/dist/generated/src/models/AlertHistorySummaryResources.d.ts +33 -0
- package/dist/generated/src/models/AlertHistorySummaryResources.js +42 -0
- package/dist/generated/src/models/AlertPreferenceAccountDetailsModel.d.ts +44 -0
- package/dist/generated/src/models/AlertPreferenceAccountDetailsModel.js +45 -0
- package/dist/generated/src/models/AlertPreferenceDetailsModel.d.ts +62 -0
- package/dist/generated/src/models/AlertPreferenceDetailsModel.js +51 -0
- package/dist/generated/src/models/AlertPreferenceResource.d.ts +64 -0
- package/dist/generated/src/models/AlertPreferenceResource.js +53 -0
- package/dist/generated/src/models/AlertPreferenceResources.d.ts +33 -0
- package/dist/generated/src/models/AlertPreferenceResources.js +42 -0
- package/dist/generated/src/models/AlertTemplateResource.d.ts +92 -0
- package/dist/generated/src/models/AlertTemplateResource.js +66 -0
- package/dist/generated/src/models/AlertTemplateResources.d.ts +33 -0
- package/dist/generated/src/models/AlertTemplateResources.js +42 -0
- package/dist/generated/src/models/AlertTypeResource.d.ts +108 -0
- package/dist/generated/src/models/AlertTypeResource.js +70 -0
- package/dist/generated/src/models/AlertTypeResources.d.ts +33 -0
- package/dist/generated/src/models/AlertTypeResources.js +42 -0
- package/dist/generated/src/models/AuthCode.d.ts +38 -0
- package/dist/generated/src/models/AuthCode.js +43 -0
- package/dist/generated/src/models/AuthorizationCodeResponse.d.ts +56 -0
- package/dist/generated/src/models/AuthorizationCodeResponse.js +49 -0
- package/dist/generated/src/models/Balance.d.ts +39 -0
- package/dist/generated/src/models/Balance.js +44 -0
- package/dist/generated/src/models/Balance1.d.ts +105 -0
- package/dist/generated/src/models/Balance1.js +66 -0
- package/dist/generated/src/models/BankAccount.d.ts +39 -0
- package/dist/generated/src/models/BankAccount.js +43 -0
- package/dist/generated/src/models/BankingImage.d.ts +120 -0
- package/dist/generated/src/models/BankingImage.js +73 -0
- package/dist/generated/src/models/BankingImages.d.ts +33 -0
- package/dist/generated/src/models/BankingImages.js +42 -0
- package/dist/generated/src/models/BaseGroupsWithParticipantsCountDTO.d.ts +47 -0
- package/dist/generated/src/models/BaseGroupsWithParticipantsCountDTO.js +48 -0
- package/dist/generated/src/models/BasePageDTOListImportJobDTO.d.ts +47 -0
- package/dist/generated/src/models/BasePageDTOListImportJobDTO.js +48 -0
- package/dist/generated/src/models/BasePageDTOListImportJobErrorDTO.d.ts +47 -0
- package/dist/generated/src/models/BasePageDTOListImportJobErrorDTO.js +48 -0
- package/dist/generated/src/models/BbRegistration.d.ts +134 -0
- package/dist/generated/src/models/BbRegistration.js +69 -0
- package/dist/generated/src/models/BbRegistrationStatus.d.ts +27 -0
- package/dist/generated/src/models/BbRegistrationStatus.js +45 -0
- package/dist/generated/src/models/BbRegistrationUser.d.ts +64 -0
- package/dist/generated/src/models/BbRegistrationUser.js +58 -0
- package/dist/generated/src/models/BbRegistrationUserType.d.ts +26 -0
- package/dist/generated/src/models/BbRegistrationUserType.js +44 -0
- package/dist/generated/src/models/BusinessAddress.d.ts +62 -0
- package/dist/generated/src/models/BusinessAddress.js +59 -0
- package/dist/generated/src/models/BusinessContact.d.ts +64 -0
- package/dist/generated/src/models/BusinessContact.js +52 -0
- package/dist/generated/src/models/BusinessDetails.d.ts +103 -0
- package/dist/generated/src/models/BusinessDetails.js +79 -0
- package/dist/generated/src/models/BusinessEntitlementsLimits.d.ts +48 -0
- package/dist/generated/src/models/BusinessEntitlementsLimits.js +49 -0
- package/dist/generated/src/models/BusinessRegistrationConfig.d.ts +41 -0
- package/dist/generated/src/models/BusinessRegistrationConfig.js +45 -0
- package/dist/generated/src/models/BusinessTinInfo.d.ts +57 -0
- package/dist/generated/src/models/BusinessTinInfo.js +53 -0
- package/dist/generated/src/models/BusinessUser.d.ts +94 -0
- package/dist/generated/src/models/BusinessUser.js +76 -0
- package/dist/generated/src/models/Calendar.d.ts +87 -0
- package/dist/generated/src/models/Calendar.js +60 -0
- package/dist/generated/src/models/ChallengeQuestionInfo.d.ts +74 -0
- package/dist/generated/src/models/ChallengeQuestionInfo.js +55 -0
- package/dist/generated/src/models/ChannelContent.d.ts +72 -0
- package/dist/generated/src/models/ChannelContent.js +67 -0
- package/dist/generated/src/models/ChannelInfo.d.ts +94 -0
- package/dist/generated/src/models/ChannelInfo.js +70 -0
- package/dist/generated/src/models/ChannelInfos.d.ts +33 -0
- package/dist/generated/src/models/ChannelInfos.js +42 -0
- package/dist/generated/src/models/ClientAuth.d.ts +45 -0
- package/dist/generated/src/models/ClientAuth.js +46 -0
- package/dist/generated/src/models/ClientAuthAdditionalInfo.d.ts +44 -0
- package/dist/generated/src/models/ClientAuthAdditionalInfo.js +45 -0
- package/dist/generated/src/models/ClientCredentialsResponse.d.ts +44 -0
- package/dist/generated/src/models/ClientCredentialsResponse.js +45 -0
- package/dist/generated/src/models/Condition.d.ts +25 -0
- package/dist/generated/src/models/Condition.js +43 -0
- package/dist/generated/src/models/ContactInfo.d.ts +61 -0
- package/dist/generated/src/models/ContactInfo.js +57 -0
- package/dist/generated/src/models/ContactInfo1.d.ts +38 -0
- package/dist/generated/src/models/ContactInfo1.js +43 -0
- package/dist/generated/src/models/ContactInfoEmail.d.ts +32 -0
- package/dist/generated/src/models/ContactInfoEmail.js +41 -0
- package/dist/generated/src/models/ContactInfoPhoneNumber.d.ts +50 -0
- package/dist/generated/src/models/ContactInfoPhoneNumber.js +47 -0
- package/dist/generated/src/models/ContactMethod.d.ts +83 -0
- package/dist/generated/src/models/ContactMethod.js +63 -0
- package/dist/generated/src/models/ContactMethod1.d.ts +53 -0
- package/dist/generated/src/models/ContactMethod1.js +52 -0
- package/dist/generated/src/models/ContactMethodResponse.d.ts +39 -0
- package/dist/generated/src/models/ContactMethodResponse.js +44 -0
- package/dist/generated/src/models/Controls.d.ts +39 -0
- package/dist/generated/src/models/Controls.js +44 -0
- package/dist/generated/src/models/CreateToken200Response.d.ts +25 -0
- package/dist/generated/src/models/CreateToken200Response.js +65 -0
- package/dist/generated/src/models/Credential.d.ts +71 -0
- package/dist/generated/src/models/Credential.js +59 -0
- package/dist/generated/src/models/CurrencyCode.d.ts +212 -0
- package/dist/generated/src/models/CurrencyCode.js +230 -0
- package/dist/generated/src/models/Customer.d.ts +58 -0
- package/dist/generated/src/models/Customer.js +54 -0
- package/dist/generated/src/models/CustomerAccountsResponse.d.ts +51 -0
- package/dist/generated/src/models/CustomerAccountsResponse.js +48 -0
- package/dist/generated/src/models/CustomerInformation.d.ts +172 -0
- package/dist/generated/src/models/CustomerInformation.js +99 -0
- package/dist/generated/src/models/CustomerRequest.d.ts +152 -0
- package/dist/generated/src/models/CustomerRequest.js +119 -0
- package/dist/generated/src/models/DIAccountType.d.ts +47 -0
- package/dist/generated/src/models/DIAccountType.js +65 -0
- package/dist/generated/src/models/DIAccountType1.d.ts +48 -0
- package/dist/generated/src/models/DIAccountType1.js +66 -0
- package/dist/generated/src/models/DataMap.d.ts +33 -0
- package/dist/generated/src/models/DataMap.js +42 -0
- package/dist/generated/src/models/Destination.d.ts +71 -0
- package/dist/generated/src/models/Destination.js +59 -0
- package/dist/generated/src/models/DisplayFlag.d.ts +62 -0
- package/dist/generated/src/models/DisplayFlag.js +51 -0
- package/dist/generated/src/models/DownloadTransactionLogs404Response.d.ts +32 -0
- package/dist/generated/src/models/DownloadTransactionLogs404Response.js +41 -0
- package/dist/generated/src/models/EStatementDisclosure.d.ts +71 -0
- package/dist/generated/src/models/EStatementDisclosure.js +59 -0
- package/dist/generated/src/models/EStatementDisclosureResponse.d.ts +33 -0
- package/dist/generated/src/models/EStatementDisclosureResponse.js +42 -0
- package/dist/generated/src/models/EStatementPreferencesRequest.d.ts +32 -0
- package/dist/generated/src/models/EStatementPreferencesRequest.js +43 -0
- package/dist/generated/src/models/EStatementPreferencesResponse.d.ts +38 -0
- package/dist/generated/src/models/EStatementPreferencesResponse.js +47 -0
- package/dist/generated/src/models/EStatementReport.d.ts +68 -0
- package/dist/generated/src/models/EStatementReport.js +53 -0
- package/dist/generated/src/models/EStatementReportRequest.d.ts +38 -0
- package/dist/generated/src/models/EStatementReportRequest.js +43 -0
- package/dist/generated/src/models/EStatementReportResponse.d.ts +39 -0
- package/dist/generated/src/models/EStatementReportResponse.js +44 -0
- package/dist/generated/src/models/EStatementRequest.d.ts +44 -0
- package/dist/generated/src/models/EStatementRequest.js +47 -0
- package/dist/generated/src/models/EntitledFeature.d.ts +39 -0
- package/dist/generated/src/models/EntitledFeature.js +46 -0
- package/dist/generated/src/models/EntitledTins.d.ts +54 -0
- package/dist/generated/src/models/EntitledTins.js +53 -0
- package/dist/generated/src/models/Entitlement.d.ts +61 -0
- package/dist/generated/src/models/Entitlement.js +54 -0
- package/dist/generated/src/models/Entitlements.d.ts +33 -0
- package/dist/generated/src/models/Entitlements.js +42 -0
- package/dist/generated/src/models/Entry.d.ts +38 -0
- package/dist/generated/src/models/Entry.js +43 -0
- package/dist/generated/src/models/Error1.d.ts +44 -0
- package/dist/generated/src/models/Error1.js +45 -0
- package/dist/generated/src/models/Error2.d.ts +32 -0
- package/dist/generated/src/models/Error2.js +41 -0
- package/dist/generated/src/models/Error3.d.ts +38 -0
- package/dist/generated/src/models/Error3.js +43 -0
- package/dist/generated/src/models/Error4.d.ts +38 -0
- package/dist/generated/src/models/Error4.js +43 -0
- package/dist/generated/src/models/Error5.d.ts +38 -0
- package/dist/generated/src/models/Error5.js +43 -0
- package/dist/generated/src/models/ErrorInfo.d.ts +38 -0
- package/dist/generated/src/models/ErrorInfo.js +43 -0
- package/dist/generated/src/models/ErrorInfo1.d.ts +38 -0
- package/dist/generated/src/models/ErrorInfo1.js +43 -0
- package/dist/generated/src/models/ErrorInfo2.d.ts +38 -0
- package/dist/generated/src/models/ErrorInfo2.js +43 -0
- package/dist/generated/src/models/ErrorInfo3.d.ts +54 -0
- package/dist/generated/src/models/ErrorInfo3.js +54 -0
- package/dist/generated/src/models/ErrorInfo4.d.ts +38 -0
- package/dist/generated/src/models/ErrorInfo4.js +47 -0
- package/dist/generated/src/models/ErrorInfo5.d.ts +38 -0
- package/dist/generated/src/models/ErrorInfo5.js +47 -0
- package/dist/generated/src/models/Event.d.ts +39 -0
- package/dist/generated/src/models/Event.js +44 -0
- package/dist/generated/src/models/Event1.d.ts +51 -0
- package/dist/generated/src/models/Event1.js +48 -0
- package/dist/generated/src/models/EventDetails.d.ts +80 -0
- package/dist/generated/src/models/EventDetails.js +57 -0
- package/dist/generated/src/models/Events.d.ts +33 -0
- package/dist/generated/src/models/Events.js +42 -0
- package/dist/generated/src/models/FIAccountType.d.ts +44 -0
- package/dist/generated/src/models/FIAccountType.js +45 -0
- package/dist/generated/src/models/FICustomer.d.ts +167 -0
- package/dist/generated/src/models/FICustomer.js +92 -0
- package/dist/generated/src/models/FICustomerId.d.ts +54 -0
- package/dist/generated/src/models/FICustomerId.js +58 -0
- package/dist/generated/src/models/FICustomerRequest.d.ts +91 -0
- package/dist/generated/src/models/FICustomerRequest.js +64 -0
- package/dist/generated/src/models/FICustomerRequestChannelInfos.d.ts +33 -0
- package/dist/generated/src/models/FICustomerRequestChannelInfos.js +42 -0
- package/dist/generated/src/models/FICustomerRequestChannelInfosChannelInfoInner.d.ts +39 -0
- package/dist/generated/src/models/FICustomerRequestChannelInfosChannelInfoInner.js +44 -0
- package/dist/generated/src/models/FICustomerRequestChannelInfosChannelInfoInnerCredential.d.ts +38 -0
- package/dist/generated/src/models/FICustomerRequestChannelInfosChannelInfoInnerCredential.js +43 -0
- package/dist/generated/src/models/FICustomerRequestFiId.d.ts +32 -0
- package/dist/generated/src/models/FICustomerRequestFiId.js +41 -0
- package/dist/generated/src/models/FICustomerRequestHostCredential.d.ts +32 -0
- package/dist/generated/src/models/FICustomerRequestHostCredential.js +41 -0
- package/dist/generated/src/models/FICustomerRequestId.d.ts +38 -0
- package/dist/generated/src/models/FICustomerRequestId.js +43 -0
- package/dist/generated/src/models/FICustomerRequestPerson.d.ts +46 -0
- package/dist/generated/src/models/FICustomerRequestPerson.js +47 -0
- package/dist/generated/src/models/FICustomerRequestPersonContactInfo.d.ts +46 -0
- package/dist/generated/src/models/FICustomerRequestPersonContactInfo.js +47 -0
- package/dist/generated/src/models/FICustomerRequestPersonContactInfoPhoneNumberInner.d.ts +38 -0
- package/dist/generated/src/models/FICustomerRequestPersonContactInfoPhoneNumberInner.js +43 -0
- package/dist/generated/src/models/FICustomerRequestPersonContactInfoPostalAddressInner.d.ts +68 -0
- package/dist/generated/src/models/FICustomerRequestPersonContactInfoPostalAddressInner.js +53 -0
- package/dist/generated/src/models/FICustomerRequestPersonPersonName.d.ts +38 -0
- package/dist/generated/src/models/FICustomerRequestPersonPersonName.js +43 -0
- package/dist/generated/src/models/FICustomerResponse.d.ts +110 -0
- package/dist/generated/src/models/FICustomerResponse.js +71 -0
- package/dist/generated/src/models/FICustomerResponseChannelInfos.d.ts +33 -0
- package/dist/generated/src/models/FICustomerResponseChannelInfos.js +42 -0
- package/dist/generated/src/models/FICustomerResponseChannelInfosChannelInfoInner.d.ts +39 -0
- package/dist/generated/src/models/FICustomerResponseChannelInfosChannelInfoInner.js +44 -0
- package/dist/generated/src/models/FICustomerResponseChannelInfosChannelInfoInnerCredential.d.ts +32 -0
- package/dist/generated/src/models/FICustomerResponseChannelInfosChannelInfoInnerCredential.js +41 -0
- package/dist/generated/src/models/FICustomerResponseDestinations.d.ts +33 -0
- package/dist/generated/src/models/FICustomerResponseDestinations.js +42 -0
- package/dist/generated/src/models/FICustomerResponseDestinationsDestinationInner.d.ts +44 -0
- package/dist/generated/src/models/FICustomerResponseDestinationsDestinationInner.js +45 -0
- package/dist/generated/src/models/FICustomerResponseFiId.d.ts +32 -0
- package/dist/generated/src/models/FICustomerResponseFiId.js +41 -0
- package/dist/generated/src/models/FICustomerResponseHostCredential.d.ts +32 -0
- package/dist/generated/src/models/FICustomerResponseHostCredential.js +41 -0
- package/dist/generated/src/models/FICustomerResponseId.d.ts +38 -0
- package/dist/generated/src/models/FICustomerResponseId.js +43 -0
- package/dist/generated/src/models/FICustomerResponsePerson.d.ts +46 -0
- package/dist/generated/src/models/FICustomerResponsePerson.js +47 -0
- package/dist/generated/src/models/FICustomerResponsePersonContactInfo.d.ts +46 -0
- package/dist/generated/src/models/FICustomerResponsePersonContactInfo.js +47 -0
- package/dist/generated/src/models/FICustomerResponsePersonContactInfoPhoneNumberInner.d.ts +38 -0
- package/dist/generated/src/models/FICustomerResponsePersonContactInfoPhoneNumberInner.js +43 -0
- package/dist/generated/src/models/FICustomerResponsePersonContactInfoPostalAddressInner.d.ts +68 -0
- package/dist/generated/src/models/FICustomerResponsePersonContactInfoPostalAddressInner.js +53 -0
- package/dist/generated/src/models/FICustomerResponsePersonPersonName.d.ts +56 -0
- package/dist/generated/src/models/FICustomerResponsePersonPersonName.js +49 -0
- package/dist/generated/src/models/FeatureLimits.d.ts +62 -0
- package/dist/generated/src/models/FeatureLimits.js +53 -0
- package/dist/generated/src/models/FiAlertPreferenceResource.d.ts +62 -0
- package/dist/generated/src/models/FiAlertPreferenceResource.js +51 -0
- package/dist/generated/src/models/FiAlertPreferenceResources.d.ts +33 -0
- package/dist/generated/src/models/FiAlertPreferenceResources.js +42 -0
- package/dist/generated/src/models/FileErrorReport.d.ts +32 -0
- package/dist/generated/src/models/FileErrorReport.js +41 -0
- package/dist/generated/src/models/FileMetadata.d.ts +50 -0
- package/dist/generated/src/models/FileMetadata.js +53 -0
- package/dist/generated/src/models/FileStatus.d.ts +50 -0
- package/dist/generated/src/models/FileStatus.js +47 -0
- package/dist/generated/src/models/Filter.d.ts +57 -0
- package/dist/generated/src/models/Filter.js +57 -0
- package/dist/generated/src/models/Frequency.d.ts +34 -0
- package/dist/generated/src/models/Frequency.js +52 -0
- package/dist/generated/src/models/GetUser404Response.d.ts +39 -0
- package/dist/generated/src/models/GetUser404Response.js +45 -0
- package/dist/generated/src/models/GetWidgetUrl200Response.d.ts +45 -0
- package/dist/generated/src/models/GetWidgetUrl200Response.js +47 -0
- package/dist/generated/src/models/GroupBaseRequestDTO.d.ts +64 -0
- package/dist/generated/src/models/GroupBaseRequestDTO.js +61 -0
- package/dist/generated/src/models/GroupBaseResponseDTO.d.ts +109 -0
- package/dist/generated/src/models/GroupBaseResponseDTO.js +79 -0
- package/dist/generated/src/models/GroupExperienceDTO.d.ts +50 -0
- package/dist/generated/src/models/GroupExperienceDTO.js +47 -0
- package/dist/generated/src/models/GroupsWithParticipantsCount.d.ts +57 -0
- package/dist/generated/src/models/GroupsWithParticipantsCount.js +50 -0
- package/dist/generated/src/models/HealthStatus.d.ts +32 -0
- package/dist/generated/src/models/HealthStatus.js +41 -0
- package/dist/generated/src/models/HostTransactionType.d.ts +86 -0
- package/dist/generated/src/models/HostTransactionType.js +59 -0
- package/dist/generated/src/models/IdType.d.ts +32 -0
- package/dist/generated/src/models/IdType.js +41 -0
- package/dist/generated/src/models/ImageInfo.d.ts +52 -0
- package/dist/generated/src/models/ImageInfo.js +49 -0
- package/dist/generated/src/models/ImageInfoType.d.ts +26 -0
- package/dist/generated/src/models/ImageInfoType.js +44 -0
- package/dist/generated/src/models/ImageType.d.ts +26 -0
- package/dist/generated/src/models/ImageType.js +44 -0
- package/dist/generated/src/models/ImageView.d.ts +27 -0
- package/dist/generated/src/models/ImageView.js +45 -0
- package/dist/generated/src/models/ImportJobDTO.d.ts +123 -0
- package/dist/generated/src/models/ImportJobDTO.js +72 -0
- package/dist/generated/src/models/ImportJobDTOSingle.d.ts +116 -0
- package/dist/generated/src/models/ImportJobDTOSingle.js +69 -0
- package/dist/generated/src/models/ImportJobErrorDTO.d.ts +45 -0
- package/dist/generated/src/models/ImportJobErrorDTO.js +46 -0
- package/dist/generated/src/models/InstitutionAlertTypeResource.d.ts +70 -0
- package/dist/generated/src/models/InstitutionAlertTypeResource.js +58 -0
- package/dist/generated/src/models/InstitutionAlertTypeResources.d.ts +33 -0
- package/dist/generated/src/models/InstitutionAlertTypeResources.js +42 -0
- package/dist/generated/src/models/InstitutionCustomer.d.ts +69 -0
- package/dist/generated/src/models/InstitutionCustomer.js +54 -0
- package/dist/generated/src/models/InstitutionCustomerAdditionalInfo.d.ts +33 -0
- package/dist/generated/src/models/InstitutionCustomerAdditionalInfo.js +42 -0
- package/dist/generated/src/models/InstitutionDisclosure.d.ts +63 -0
- package/dist/generated/src/models/InstitutionDisclosure.js +52 -0
- package/dist/generated/src/models/InstitutionDisclosureDataType.d.ts +24 -0
- package/dist/generated/src/models/InstitutionDisclosureDataType.js +42 -0
- package/dist/generated/src/models/InstitutionDisclosures.d.ts +33 -0
- package/dist/generated/src/models/InstitutionDisclosures.js +42 -0
- package/dist/generated/src/models/InstitutionUser.d.ts +149 -0
- package/dist/generated/src/models/InstitutionUser.js +92 -0
- package/dist/generated/src/models/InstitutionUserAdditionalInfo.d.ts +39 -0
- package/dist/generated/src/models/InstitutionUserAdditionalInfo.js +44 -0
- package/dist/generated/src/models/InstitutionUserDisclosure.d.ts +75 -0
- package/dist/generated/src/models/InstitutionUserDisclosure.js +56 -0
- package/dist/generated/src/models/InstitutionUserDisclosureStatus.d.ts +27 -0
- package/dist/generated/src/models/InstitutionUserDisclosureStatus.js +45 -0
- package/dist/generated/src/models/InstitutionUserDisclosures.d.ts +33 -0
- package/dist/generated/src/models/InstitutionUserDisclosures.js +42 -0
- package/dist/generated/src/models/JobUploadStatus.d.ts +63 -0
- package/dist/generated/src/models/JobUploadStatus.js +52 -0
- package/dist/generated/src/models/JobUploadStatusStatus.d.ts +50 -0
- package/dist/generated/src/models/JobUploadStatusStatus.js +47 -0
- package/dist/generated/src/models/LifeType.d.ts +26 -0
- package/dist/generated/src/models/LifeType.js +44 -0
- package/dist/generated/src/models/Limit.d.ts +113 -0
- package/dist/generated/src/models/Limit.js +90 -0
- package/dist/generated/src/models/Limits.d.ts +33 -0
- package/dist/generated/src/models/Limits.js +42 -0
- package/dist/generated/src/models/Links.d.ts +38 -0
- package/dist/generated/src/models/Links.js +43 -0
- package/dist/generated/src/models/ListUsers400Response.d.ts +46 -0
- package/dist/generated/src/models/ListUsers400Response.js +48 -0
- package/dist/generated/src/models/ListUsers400ResponseErrorsInner.d.ts +38 -0
- package/dist/generated/src/models/ListUsers400ResponseErrorsInner.js +43 -0
- package/dist/generated/src/models/ListUsers401Response.d.ts +39 -0
- package/dist/generated/src/models/ListUsers401Response.js +45 -0
- package/dist/generated/src/models/MapEntryInner.d.ts +38 -0
- package/dist/generated/src/models/MapEntryInner.js +43 -0
- package/dist/generated/src/models/MapItem.d.ts +38 -0
- package/dist/generated/src/models/MapItem.js +43 -0
- package/dist/generated/src/models/MfaCookie.d.ts +87 -0
- package/dist/generated/src/models/MfaCookie.js +60 -0
- package/dist/generated/src/models/ModelError.d.ts +38 -0
- package/dist/generated/src/models/ModelError.js +43 -0
- package/dist/generated/src/models/ModelMap.d.ts +33 -0
- package/dist/generated/src/models/ModelMap.js +42 -0
- package/dist/generated/src/models/Money.d.ts +39 -0
- package/dist/generated/src/models/Money.js +44 -0
- package/dist/generated/src/models/Money1.d.ts +48 -0
- package/dist/generated/src/models/Money1.js +52 -0
- package/dist/generated/src/models/Money2.d.ts +233 -0
- package/dist/generated/src/models/Money2.js +237 -0
- package/dist/generated/src/models/NonSubscriptionEvent.d.ts +45 -0
- package/dist/generated/src/models/NonSubscriptionEvent.js +46 -0
- package/dist/generated/src/models/Notification.d.ts +50 -0
- package/dist/generated/src/models/Notification.js +47 -0
- package/dist/generated/src/models/NotificationEvent.d.ts +46 -0
- package/dist/generated/src/models/NotificationEvent.js +47 -0
- package/dist/generated/src/models/Page.d.ts +50 -0
- package/dist/generated/src/models/Page.js +47 -0
- package/dist/generated/src/models/Pageable.d.ts +44 -0
- package/dist/generated/src/models/Pageable.js +45 -0
- package/dist/generated/src/models/PasswordResponse.d.ts +56 -0
- package/dist/generated/src/models/PasswordResponse.js +49 -0
- package/dist/generated/src/models/PaymentOptionType.d.ts +31 -0
- package/dist/generated/src/models/PaymentOptionType.js +49 -0
- package/dist/generated/src/models/Person.d.ts +33 -0
- package/dist/generated/src/models/Person.js +42 -0
- package/dist/generated/src/models/PhoneNumber.d.ts +66 -0
- package/dist/generated/src/models/PhoneNumber.js +58 -0
- package/dist/generated/src/models/PostalAddress.d.ts +68 -0
- package/dist/generated/src/models/PostalAddress.js +53 -0
- package/dist/generated/src/models/PostalAddress1.d.ts +94 -0
- package/dist/generated/src/models/PostalAddress1.js +76 -0
- package/dist/generated/src/models/ProductAppUserInfo.d.ts +98 -0
- package/dist/generated/src/models/ProductAppUserInfo.js +63 -0
- package/dist/generated/src/models/ProductAppUserInfos.d.ts +33 -0
- package/dist/generated/src/models/ProductAppUserInfos.js +42 -0
- package/dist/generated/src/models/ProductUserInfo.d.ts +32 -0
- package/dist/generated/src/models/ProductUserInfo.js +41 -0
- package/dist/generated/src/models/Protocol.d.ts +27 -0
- package/dist/generated/src/models/Protocol.js +45 -0
- package/dist/generated/src/models/Recipient.d.ts +87 -0
- package/dist/generated/src/models/Recipient.js +60 -0
- package/dist/generated/src/models/Recipients.d.ts +33 -0
- package/dist/generated/src/models/Recipients.js +42 -0
- package/dist/generated/src/models/RefreshTokenResponse.d.ts +56 -0
- package/dist/generated/src/models/RefreshTokenResponse.js +49 -0
- package/dist/generated/src/models/RegDLimits.d.ts +56 -0
- package/dist/generated/src/models/RegDLimits.js +49 -0
- package/dist/generated/src/models/RegDLimits1.d.ts +50 -0
- package/dist/generated/src/models/RegDLimits1.js +47 -0
- package/dist/generated/src/models/RegisterCustomerRequest.d.ts +33 -0
- package/dist/generated/src/models/RegisterCustomerRequest.js +44 -0
- package/dist/generated/src/models/RegisterCustomerResponse.d.ts +33 -0
- package/dist/generated/src/models/RegisterCustomerResponse.js +42 -0
- package/dist/generated/src/models/ResetPasswordRequest.d.ts +46 -0
- package/dist/generated/src/models/ResetPasswordRequest.js +52 -0
- package/dist/generated/src/models/Resource.d.ts +46 -0
- package/dist/generated/src/models/Resource.js +47 -0
- package/dist/generated/src/models/ResponseDTO.d.ts +38 -0
- package/dist/generated/src/models/ResponseDTO.js +43 -0
- package/dist/generated/src/models/Schedule.d.ts +88 -0
- package/dist/generated/src/models/Schedule.js +61 -0
- package/dist/generated/src/models/SearchCriteriaRequestBody.d.ts +112 -0
- package/dist/generated/src/models/SearchCriteriaRequestBody.js +78 -0
- package/dist/generated/src/models/SearchResultResponse.d.ts +40 -0
- package/dist/generated/src/models/SearchResultResponse.js +43 -0
- package/dist/generated/src/models/StatementType.d.ts +45 -0
- package/dist/generated/src/models/StatementType.js +63 -0
- package/dist/generated/src/models/Status.d.ts +39 -0
- package/dist/generated/src/models/Status.js +44 -0
- package/dist/generated/src/models/Status1.d.ts +39 -0
- package/dist/generated/src/models/Status1.js +44 -0
- package/dist/generated/src/models/Status1ErrorInfo.d.ts +53 -0
- package/dist/generated/src/models/Status1ErrorInfo.js +53 -0
- package/dist/generated/src/models/Status2.d.ts +39 -0
- package/dist/generated/src/models/Status2.js +44 -0
- package/dist/generated/src/models/Status2ErrorInfo.d.ts +53 -0
- package/dist/generated/src/models/Status2ErrorInfo.js +53 -0
- package/dist/generated/src/models/StatusAdditionalInfo.d.ts +62 -0
- package/dist/generated/src/models/StatusAdditionalInfo.js +51 -0
- package/dist/generated/src/models/SubFilter.d.ts +40 -0
- package/dist/generated/src/models/SubFilter.js +49 -0
- package/dist/generated/src/models/SubUserStatus.d.ts +93 -0
- package/dist/generated/src/models/SubUserStatus.js +62 -0
- package/dist/generated/src/models/Subscription.d.ts +74 -0
- package/dist/generated/src/models/Subscription.js +56 -0
- package/dist/generated/src/models/SubscriptionAction.d.ts +41 -0
- package/dist/generated/src/models/SubscriptionAction.js +45 -0
- package/dist/generated/src/models/SubscriptionActionAttributesMap.d.ts +33 -0
- package/dist/generated/src/models/SubscriptionActionAttributesMap.js +42 -0
- package/dist/generated/src/models/SubscriptionActions.d.ts +33 -0
- package/dist/generated/src/models/SubscriptionActions.js +42 -0
- package/dist/generated/src/models/SubscriptionEventConditionsMap.d.ts +33 -0
- package/dist/generated/src/models/SubscriptionEventConditionsMap.js +42 -0
- package/dist/generated/src/models/Term.d.ts +39 -0
- package/dist/generated/src/models/Term.js +44 -0
- package/dist/generated/src/models/TermType.d.ts +27 -0
- package/dist/generated/src/models/TermType.js +45 -0
- package/dist/generated/src/models/TimeZone.d.ts +50 -0
- package/dist/generated/src/models/TimeZone.js +47 -0
- package/dist/generated/src/models/Token.d.ts +68 -0
- package/dist/generated/src/models/Token.js +53 -0
- package/dist/generated/src/models/Transaction.d.ts +167 -0
- package/dist/generated/src/models/Transaction.js +88 -0
- package/dist/generated/src/models/TransactionCategory.d.ts +55 -0
- package/dist/generated/src/models/TransactionCategory.js +55 -0
- package/dist/generated/src/models/TransactionEvent.d.ts +46 -0
- package/dist/generated/src/models/TransactionEvent.js +47 -0
- package/dist/generated/src/models/TransactionList.d.ts +33 -0
- package/dist/generated/src/models/TransactionList.js +42 -0
- package/dist/generated/src/models/TransactionRange.d.ts +39 -0
- package/dist/generated/src/models/TransactionRange.js +44 -0
- package/dist/generated/src/models/TransactionStatus.d.ts +25 -0
- package/dist/generated/src/models/TransactionStatus.js +43 -0
- package/dist/generated/src/models/TransactionTransactionImage.d.ts +45 -0
- package/dist/generated/src/models/TransactionTransactionImage.js +46 -0
- package/dist/generated/src/models/TransactionType.d.ts +73 -0
- package/dist/generated/src/models/TransactionType.js +91 -0
- package/dist/generated/src/models/Transfer.d.ts +120 -0
- package/dist/generated/src/models/Transfer.js +73 -0
- package/dist/generated/src/models/TransferStatus.d.ts +25 -0
- package/dist/generated/src/models/TransferStatus.js +43 -0
- package/dist/generated/src/models/UpdateContactInfoPostalAddress.d.ts +62 -0
- package/dist/generated/src/models/UpdateContactInfoPostalAddress.js +51 -0
- package/dist/generated/src/models/UploadResponse.d.ts +32 -0
- package/dist/generated/src/models/UploadResponse.js +41 -0
- package/dist/generated/src/models/UploadResponseDTO.d.ts +50 -0
- package/dist/generated/src/models/UploadResponseDTO.js +47 -0
- package/dist/generated/src/models/User.d.ts +134 -0
- package/dist/generated/src/models/User.js +89 -0
- package/dist/generated/src/models/UserEntitlementsLimits.d.ts +48 -0
- package/dist/generated/src/models/UserEntitlementsLimits.js +49 -0
- package/dist/generated/src/models/UserEvent.d.ts +45 -0
- package/dist/generated/src/models/UserEvent.js +46 -0
- package/dist/generated/src/models/UserList.d.ts +38 -0
- package/dist/generated/src/models/UserList.js +47 -0
- package/dist/generated/src/models/UserListFileDTO.d.ts +47 -0
- package/dist/generated/src/models/UserListFileDTO.js +48 -0
- package/dist/generated/src/models/UserListsDTO.d.ts +33 -0
- package/dist/generated/src/models/UserListsDTO.js +42 -0
- package/dist/generated/src/models/UserListsFileResponse.d.ts +33 -0
- package/dist/generated/src/models/UserListsFileResponse.js +42 -0
- package/dist/generated/src/models/UserListsWithFileMetadata.d.ts +33 -0
- package/dist/generated/src/models/UserListsWithFileMetadata.js +42 -0
- package/dist/generated/src/models/UserStatus.d.ts +80 -0
- package/dist/generated/src/models/UserStatus.js +57 -0
- package/dist/generated/src/models/UserStatus1.d.ts +284 -0
- package/dist/generated/src/models/UserStatus1.js +125 -0
- package/dist/generated/src/models/UserStatus2.d.ts +94 -0
- package/dist/generated/src/models/UserStatus2.js +63 -0
- package/dist/generated/src/models/UsersList.d.ts +33 -0
- package/dist/generated/src/models/UsersList.js +44 -0
- package/dist/generated/src/models/index.d.ts +266 -0
- package/dist/generated/src/models/index.js +268 -0
- package/dist/generated/src/runtime.d.ts +184 -0
- package/dist/generated/src/runtime.js +348 -0
- package/dist/src/auth.d.ts +71 -0
- package/dist/src/auth.js +226 -0
- package/dist/src/client.d.ts +86 -0
- package/dist/src/client.js +399 -0
- package/dist/src/completions.d.ts +4 -0
- package/dist/src/completions.js +5 -0
- package/dist/src/errors.d.ts +49 -0
- package/dist/src/errors.js +119 -0
- package/dist/src/index.d.ts +26 -0
- package/dist/src/index.js +29 -0
- package/dist/src/operations.d.ts +31 -0
- package/dist/src/operations.js +45 -0
- package/dist/src/pagination.d.ts +31 -0
- package/dist/src/pagination.js +67 -0
- package/dist/src/registry.d.ts +69 -0
- package/dist/src/registry.js +4820 -0
- package/dist/src/result.d.ts +29 -0
- package/dist/src/result.js +26 -0
- package/dist/src/retry.d.ts +12 -0
- package/dist/src/retry.js +51 -0
- package/dist/src/transport.d.ts +53 -0
- package/dist/src/transport.js +115 -0
- package/dist/src/validate.d.ts +27 -0
- package/dist/src/validate.js +68 -0
- package/package.json +58 -0
|
@@ -0,0 +1,68 @@
|
|
|
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 PostalAddress
|
|
16
|
+
*/
|
|
17
|
+
export interface PostalAddress {
|
|
18
|
+
/**
|
|
19
|
+
* Posatl address street1
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof PostalAddress
|
|
22
|
+
*/
|
|
23
|
+
streetAddress1?: string;
|
|
24
|
+
/**
|
|
25
|
+
* Posatl address street2
|
|
26
|
+
* @type {string}
|
|
27
|
+
* @memberof PostalAddress
|
|
28
|
+
*/
|
|
29
|
+
streetAddress2?: string;
|
|
30
|
+
/**
|
|
31
|
+
* Posatl address street3
|
|
32
|
+
* @type {string}
|
|
33
|
+
* @memberof PostalAddress
|
|
34
|
+
*/
|
|
35
|
+
streetAddress3?: string;
|
|
36
|
+
/**
|
|
37
|
+
* Apartment number
|
|
38
|
+
* @type {string}
|
|
39
|
+
* @memberof PostalAddress
|
|
40
|
+
*/
|
|
41
|
+
apartmentNumber?: string;
|
|
42
|
+
/**
|
|
43
|
+
* City
|
|
44
|
+
* @type {string}
|
|
45
|
+
* @memberof PostalAddress
|
|
46
|
+
*/
|
|
47
|
+
city?: string;
|
|
48
|
+
/**
|
|
49
|
+
* State
|
|
50
|
+
* @type {string}
|
|
51
|
+
* @memberof PostalAddress
|
|
52
|
+
*/
|
|
53
|
+
state?: string;
|
|
54
|
+
/**
|
|
55
|
+
* Country
|
|
56
|
+
* @type {string}
|
|
57
|
+
* @memberof PostalAddress
|
|
58
|
+
*/
|
|
59
|
+
country?: string;
|
|
60
|
+
}
|
|
61
|
+
/**
|
|
62
|
+
* Check if a given object implements the PostalAddress interface.
|
|
63
|
+
*/
|
|
64
|
+
export declare function instanceOfPostalAddress(value: object): value is PostalAddress;
|
|
65
|
+
export declare function PostalAddressFromJSON(json: any): PostalAddress;
|
|
66
|
+
export declare function PostalAddressFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostalAddress;
|
|
67
|
+
export declare function PostalAddressToJSON(json: any): PostalAddress;
|
|
68
|
+
export declare function PostalAddressToJSONTyped(value?: PostalAddress | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,53 @@
|
|
|
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 PostalAddress interface.
|
|
16
|
+
*/
|
|
17
|
+
export function instanceOfPostalAddress(value) {
|
|
18
|
+
return true;
|
|
19
|
+
}
|
|
20
|
+
export function PostalAddressFromJSON(json) {
|
|
21
|
+
return PostalAddressFromJSONTyped(json, false);
|
|
22
|
+
}
|
|
23
|
+
export function PostalAddressFromJSONTyped(json, ignoreDiscriminator) {
|
|
24
|
+
if (json == null) {
|
|
25
|
+
return json;
|
|
26
|
+
}
|
|
27
|
+
return {
|
|
28
|
+
'streetAddress1': json['streetAddress1'] == null ? undefined : json['streetAddress1'],
|
|
29
|
+
'streetAddress2': json['streetAddress2'] == null ? undefined : json['streetAddress2'],
|
|
30
|
+
'streetAddress3': json['streetAddress3'] == null ? undefined : json['streetAddress3'],
|
|
31
|
+
'apartmentNumber': json['apartmentNumber'] == null ? undefined : json['apartmentNumber'],
|
|
32
|
+
'city': json['city'] == null ? undefined : json['city'],
|
|
33
|
+
'state': json['state'] == null ? undefined : json['state'],
|
|
34
|
+
'country': json['country'] == null ? undefined : json['country'],
|
|
35
|
+
};
|
|
36
|
+
}
|
|
37
|
+
export function PostalAddressToJSON(json) {
|
|
38
|
+
return PostalAddressToJSONTyped(json, false);
|
|
39
|
+
}
|
|
40
|
+
export function PostalAddressToJSONTyped(value, ignoreDiscriminator = false) {
|
|
41
|
+
if (value == null) {
|
|
42
|
+
return value;
|
|
43
|
+
}
|
|
44
|
+
return {
|
|
45
|
+
'streetAddress1': value['streetAddress1'],
|
|
46
|
+
'streetAddress2': value['streetAddress2'],
|
|
47
|
+
'streetAddress3': value['streetAddress3'],
|
|
48
|
+
'apartmentNumber': value['apartmentNumber'],
|
|
49
|
+
'city': value['city'],
|
|
50
|
+
'state': value['state'],
|
|
51
|
+
'country': value['country'],
|
|
52
|
+
};
|
|
53
|
+
}
|
|
@@ -0,0 +1,94 @@
|
|
|
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
|
+
* Postal or street address used for customer profile.
|
|
14
|
+
* @export
|
|
15
|
+
* @interface PostalAddress1
|
|
16
|
+
*/
|
|
17
|
+
export interface PostalAddress1 {
|
|
18
|
+
/**
|
|
19
|
+
* Key or sequence for this address when the customer has multiple postal addresses (ordering, selection, or updates).
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof PostalAddress1
|
|
22
|
+
*/
|
|
23
|
+
index?: string;
|
|
24
|
+
/**
|
|
25
|
+
* Primary street address line (street number and name).
|
|
26
|
+
* @type {string}
|
|
27
|
+
* @memberof PostalAddress1
|
|
28
|
+
*/
|
|
29
|
+
address1: string;
|
|
30
|
+
/**
|
|
31
|
+
* Secondary address line (e.g. unit, suite). Required for customer registration; contact-info update APIs may not require a value in this field.
|
|
32
|
+
* @type {string}
|
|
33
|
+
* @memberof PostalAddress1
|
|
34
|
+
*/
|
|
35
|
+
address2?: string;
|
|
36
|
+
/**
|
|
37
|
+
* Optional third address line for additional location detail.
|
|
38
|
+
* @type {string}
|
|
39
|
+
* @memberof PostalAddress1
|
|
40
|
+
*/
|
|
41
|
+
address3?: string;
|
|
42
|
+
/**
|
|
43
|
+
* City or locality name.
|
|
44
|
+
* @type {string}
|
|
45
|
+
* @memberof PostalAddress1
|
|
46
|
+
*/
|
|
47
|
+
city: string;
|
|
48
|
+
/**
|
|
49
|
+
* State, province, or region code (e.g. US state abbreviation).
|
|
50
|
+
* @type {string}
|
|
51
|
+
* @memberof PostalAddress1
|
|
52
|
+
*/
|
|
53
|
+
state: string;
|
|
54
|
+
/**
|
|
55
|
+
* Postal or ZIP code.
|
|
56
|
+
* @type {string}
|
|
57
|
+
* @memberof PostalAddress1
|
|
58
|
+
*/
|
|
59
|
+
postalCode?: string;
|
|
60
|
+
/**
|
|
61
|
+
* Country code (typically ISO 3166-1 alpha-2, e.g. US).
|
|
62
|
+
* @type {string}
|
|
63
|
+
* @memberof PostalAddress1
|
|
64
|
+
*/
|
|
65
|
+
country?: string;
|
|
66
|
+
/**
|
|
67
|
+
* Address classification: physical vs mailing, home vs work, seasonal, temporary, or tax reporting. Use UNKNOWN when not specified.
|
|
68
|
+
* @type {PostalAddress1TypeEnum}
|
|
69
|
+
* @memberof PostalAddress1
|
|
70
|
+
*/
|
|
71
|
+
type?: PostalAddress1TypeEnum;
|
|
72
|
+
}
|
|
73
|
+
/**
|
|
74
|
+
* @export
|
|
75
|
+
*/
|
|
76
|
+
export declare const PostalAddress1TypeEnum: {
|
|
77
|
+
readonly UNKNOWN: "UNKNOWN";
|
|
78
|
+
readonly PHYSICAL_HOME_ADDRESS: "PHYSICAL_HOME_ADDRESS";
|
|
79
|
+
readonly MAILING_HOME_ADDRESS: "MAILING_HOME_ADDRESS";
|
|
80
|
+
readonly PHYSICAL_WORK_ADDRESS: "PHYSICAL_WORK_ADDRESS";
|
|
81
|
+
readonly MAILING_WORK_ADDRESS: "MAILING_WORK_ADDRESS";
|
|
82
|
+
readonly SEASONAL_OR_VACATION_ADDRESS: "SEASONAL_OR_VACATION_ADDRESS";
|
|
83
|
+
readonly TEMPORARY_ADDRESS: "TEMPORARY_ADDRESS";
|
|
84
|
+
readonly TAX_REPORTING_ADDRESS: "TAX_REPORTING_ADDRESS";
|
|
85
|
+
};
|
|
86
|
+
export type PostalAddress1TypeEnum = typeof PostalAddress1TypeEnum[keyof typeof PostalAddress1TypeEnum];
|
|
87
|
+
/**
|
|
88
|
+
* Check if a given object implements the PostalAddress1 interface.
|
|
89
|
+
*/
|
|
90
|
+
export declare function instanceOfPostalAddress1(value: object): value is PostalAddress1;
|
|
91
|
+
export declare function PostalAddress1FromJSON(json: any): PostalAddress1;
|
|
92
|
+
export declare function PostalAddress1FromJSONTyped(json: any, ignoreDiscriminator: boolean): PostalAddress1;
|
|
93
|
+
export declare function PostalAddress1ToJSON(json: any): PostalAddress1;
|
|
94
|
+
export declare function PostalAddress1ToJSONTyped(value?: PostalAddress1 | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,76 @@
|
|
|
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 PostalAddress1TypeEnum = {
|
|
18
|
+
UNKNOWN: 'UNKNOWN',
|
|
19
|
+
PHYSICAL_HOME_ADDRESS: 'PHYSICAL_HOME_ADDRESS',
|
|
20
|
+
MAILING_HOME_ADDRESS: 'MAILING_HOME_ADDRESS',
|
|
21
|
+
PHYSICAL_WORK_ADDRESS: 'PHYSICAL_WORK_ADDRESS',
|
|
22
|
+
MAILING_WORK_ADDRESS: 'MAILING_WORK_ADDRESS',
|
|
23
|
+
SEASONAL_OR_VACATION_ADDRESS: 'SEASONAL_OR_VACATION_ADDRESS',
|
|
24
|
+
TEMPORARY_ADDRESS: 'TEMPORARY_ADDRESS',
|
|
25
|
+
TAX_REPORTING_ADDRESS: 'TAX_REPORTING_ADDRESS'
|
|
26
|
+
};
|
|
27
|
+
/**
|
|
28
|
+
* Check if a given object implements the PostalAddress1 interface.
|
|
29
|
+
*/
|
|
30
|
+
export function instanceOfPostalAddress1(value) {
|
|
31
|
+
if (!('address1' in value) || value['address1'] === undefined)
|
|
32
|
+
return false;
|
|
33
|
+
if (!('city' in value) || value['city'] === undefined)
|
|
34
|
+
return false;
|
|
35
|
+
if (!('state' in value) || value['state'] === undefined)
|
|
36
|
+
return false;
|
|
37
|
+
return true;
|
|
38
|
+
}
|
|
39
|
+
export function PostalAddress1FromJSON(json) {
|
|
40
|
+
return PostalAddress1FromJSONTyped(json, false);
|
|
41
|
+
}
|
|
42
|
+
export function PostalAddress1FromJSONTyped(json, ignoreDiscriminator) {
|
|
43
|
+
if (json == null) {
|
|
44
|
+
return json;
|
|
45
|
+
}
|
|
46
|
+
return {
|
|
47
|
+
'index': json['index'] == null ? undefined : json['index'],
|
|
48
|
+
'address1': json['address1'],
|
|
49
|
+
'address2': json['address2'] == null ? undefined : json['address2'],
|
|
50
|
+
'address3': json['address3'] == null ? undefined : json['address3'],
|
|
51
|
+
'city': json['city'],
|
|
52
|
+
'state': json['state'],
|
|
53
|
+
'postalCode': json['postalCode'] == null ? undefined : json['postalCode'],
|
|
54
|
+
'country': json['country'] == null ? undefined : json['country'],
|
|
55
|
+
'type': json['type'] == null ? undefined : json['type'],
|
|
56
|
+
};
|
|
57
|
+
}
|
|
58
|
+
export function PostalAddress1ToJSON(json) {
|
|
59
|
+
return PostalAddress1ToJSONTyped(json, false);
|
|
60
|
+
}
|
|
61
|
+
export function PostalAddress1ToJSONTyped(value, ignoreDiscriminator = false) {
|
|
62
|
+
if (value == null) {
|
|
63
|
+
return value;
|
|
64
|
+
}
|
|
65
|
+
return {
|
|
66
|
+
'index': value['index'],
|
|
67
|
+
'address1': value['address1'],
|
|
68
|
+
'address2': value['address2'],
|
|
69
|
+
'address3': value['address3'],
|
|
70
|
+
'city': value['city'],
|
|
71
|
+
'state': value['state'],
|
|
72
|
+
'postalCode': value['postalCode'],
|
|
73
|
+
'country': value['country'],
|
|
74
|
+
'type': value['type'],
|
|
75
|
+
};
|
|
76
|
+
}
|
|
@@ -0,0 +1,98 @@
|
|
|
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 ProductAppUserInfo
|
|
16
|
+
*/
|
|
17
|
+
export interface ProductAppUserInfo {
|
|
18
|
+
/**
|
|
19
|
+
*
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof ProductAppUserInfo
|
|
22
|
+
*/
|
|
23
|
+
acceptedDisclosureDate?: string;
|
|
24
|
+
/**
|
|
25
|
+
*
|
|
26
|
+
* @type {string}
|
|
27
|
+
* @memberof ProductAppUserInfo
|
|
28
|
+
*/
|
|
29
|
+
appCode?: string;
|
|
30
|
+
/**
|
|
31
|
+
*
|
|
32
|
+
* @type {string}
|
|
33
|
+
* @memberof ProductAppUserInfo
|
|
34
|
+
*/
|
|
35
|
+
esignDate?: string;
|
|
36
|
+
/**
|
|
37
|
+
*
|
|
38
|
+
* @type {boolean}
|
|
39
|
+
* @memberof ProductAppUserInfo
|
|
40
|
+
*/
|
|
41
|
+
esignStatus?: boolean;
|
|
42
|
+
/**
|
|
43
|
+
*
|
|
44
|
+
* @type {string}
|
|
45
|
+
* @memberof ProductAppUserInfo
|
|
46
|
+
*/
|
|
47
|
+
externalAuthId?: string;
|
|
48
|
+
/**
|
|
49
|
+
*
|
|
50
|
+
* @type {string}
|
|
51
|
+
* @memberof ProductAppUserInfo
|
|
52
|
+
*/
|
|
53
|
+
lastActivityDate?: string;
|
|
54
|
+
/**
|
|
55
|
+
*
|
|
56
|
+
* @type {boolean}
|
|
57
|
+
* @memberof ProductAppUserInfo
|
|
58
|
+
*/
|
|
59
|
+
osdisclosure?: boolean;
|
|
60
|
+
/**
|
|
61
|
+
*
|
|
62
|
+
* @type {boolean}
|
|
63
|
+
* @memberof ProductAppUserInfo
|
|
64
|
+
*/
|
|
65
|
+
osemailReminder?: boolean;
|
|
66
|
+
/**
|
|
67
|
+
*
|
|
68
|
+
* @type {boolean}
|
|
69
|
+
* @memberof ProductAppUserInfo
|
|
70
|
+
*/
|
|
71
|
+
osgroup?: boolean;
|
|
72
|
+
/**
|
|
73
|
+
*
|
|
74
|
+
* @type {boolean}
|
|
75
|
+
* @memberof ProductAppUserInfo
|
|
76
|
+
*/
|
|
77
|
+
ospaperStatement?: boolean;
|
|
78
|
+
/**
|
|
79
|
+
*
|
|
80
|
+
* @type {string}
|
|
81
|
+
* @memberof ProductAppUserInfo
|
|
82
|
+
*/
|
|
83
|
+
statusCode?: string;
|
|
84
|
+
/**
|
|
85
|
+
*
|
|
86
|
+
* @type {string}
|
|
87
|
+
* @memberof ProductAppUserInfo
|
|
88
|
+
*/
|
|
89
|
+
updateDateTime?: string;
|
|
90
|
+
}
|
|
91
|
+
/**
|
|
92
|
+
* Check if a given object implements the ProductAppUserInfo interface.
|
|
93
|
+
*/
|
|
94
|
+
export declare function instanceOfProductAppUserInfo(value: object): value is ProductAppUserInfo;
|
|
95
|
+
export declare function ProductAppUserInfoFromJSON(json: any): ProductAppUserInfo;
|
|
96
|
+
export declare function ProductAppUserInfoFromJSONTyped(json: any, ignoreDiscriminator: boolean): ProductAppUserInfo;
|
|
97
|
+
export declare function ProductAppUserInfoToJSON(json: any): ProductAppUserInfo;
|
|
98
|
+
export declare function ProductAppUserInfoToJSONTyped(value?: ProductAppUserInfo | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,63 @@
|
|
|
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 ProductAppUserInfo interface.
|
|
16
|
+
*/
|
|
17
|
+
export function instanceOfProductAppUserInfo(value) {
|
|
18
|
+
return true;
|
|
19
|
+
}
|
|
20
|
+
export function ProductAppUserInfoFromJSON(json) {
|
|
21
|
+
return ProductAppUserInfoFromJSONTyped(json, false);
|
|
22
|
+
}
|
|
23
|
+
export function ProductAppUserInfoFromJSONTyped(json, ignoreDiscriminator) {
|
|
24
|
+
if (json == null) {
|
|
25
|
+
return json;
|
|
26
|
+
}
|
|
27
|
+
return {
|
|
28
|
+
'acceptedDisclosureDate': json['acceptedDisclosureDate'] == null ? undefined : json['acceptedDisclosureDate'],
|
|
29
|
+
'appCode': json['appCode'] == null ? undefined : json['appCode'],
|
|
30
|
+
'esignDate': json['esignDate'] == null ? undefined : json['esignDate'],
|
|
31
|
+
'esignStatus': json['esignStatus'] == null ? undefined : json['esignStatus'],
|
|
32
|
+
'externalAuthId': json['externalAuthId'] == null ? undefined : json['externalAuthId'],
|
|
33
|
+
'lastActivityDate': json['lastActivityDate'] == null ? undefined : json['lastActivityDate'],
|
|
34
|
+
'osdisclosure': json['osdisclosure'] == null ? undefined : json['osdisclosure'],
|
|
35
|
+
'osemailReminder': json['osemailReminder'] == null ? undefined : json['osemailReminder'],
|
|
36
|
+
'osgroup': json['osgroup'] == null ? undefined : json['osgroup'],
|
|
37
|
+
'ospaperStatement': json['ospaperStatement'] == null ? undefined : json['ospaperStatement'],
|
|
38
|
+
'statusCode': json['statusCode'] == null ? undefined : json['statusCode'],
|
|
39
|
+
'updateDateTime': json['updateDateTime'] == null ? undefined : json['updateDateTime'],
|
|
40
|
+
};
|
|
41
|
+
}
|
|
42
|
+
export function ProductAppUserInfoToJSON(json) {
|
|
43
|
+
return ProductAppUserInfoToJSONTyped(json, false);
|
|
44
|
+
}
|
|
45
|
+
export function ProductAppUserInfoToJSONTyped(value, ignoreDiscriminator = false) {
|
|
46
|
+
if (value == null) {
|
|
47
|
+
return value;
|
|
48
|
+
}
|
|
49
|
+
return {
|
|
50
|
+
'acceptedDisclosureDate': value['acceptedDisclosureDate'],
|
|
51
|
+
'appCode': value['appCode'],
|
|
52
|
+
'esignDate': value['esignDate'],
|
|
53
|
+
'esignStatus': value['esignStatus'],
|
|
54
|
+
'externalAuthId': value['externalAuthId'],
|
|
55
|
+
'lastActivityDate': value['lastActivityDate'],
|
|
56
|
+
'osdisclosure': value['osdisclosure'],
|
|
57
|
+
'osemailReminder': value['osemailReminder'],
|
|
58
|
+
'osgroup': value['osgroup'],
|
|
59
|
+
'ospaperStatement': value['ospaperStatement'],
|
|
60
|
+
'statusCode': value['statusCode'],
|
|
61
|
+
'updateDateTime': value['updateDateTime'],
|
|
62
|
+
};
|
|
63
|
+
}
|
|
@@ -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 { ProductAppUserInfo } from './ProductAppUserInfo.js';
|
|
13
|
+
/**
|
|
14
|
+
*
|
|
15
|
+
* @export
|
|
16
|
+
* @interface ProductAppUserInfos
|
|
17
|
+
*/
|
|
18
|
+
export interface ProductAppUserInfos {
|
|
19
|
+
/**
|
|
20
|
+
*
|
|
21
|
+
* @type {Array<ProductAppUserInfo>}
|
|
22
|
+
* @memberof ProductAppUserInfos
|
|
23
|
+
*/
|
|
24
|
+
productAppUserInfo?: Array<ProductAppUserInfo>;
|
|
25
|
+
}
|
|
26
|
+
/**
|
|
27
|
+
* Check if a given object implements the ProductAppUserInfos interface.
|
|
28
|
+
*/
|
|
29
|
+
export declare function instanceOfProductAppUserInfos(value: object): value is ProductAppUserInfos;
|
|
30
|
+
export declare function ProductAppUserInfosFromJSON(json: any): ProductAppUserInfos;
|
|
31
|
+
export declare function ProductAppUserInfosFromJSONTyped(json: any, ignoreDiscriminator: boolean): ProductAppUserInfos;
|
|
32
|
+
export declare function ProductAppUserInfosToJSON(json: any): ProductAppUserInfos;
|
|
33
|
+
export declare function ProductAppUserInfosToJSONTyped(value?: ProductAppUserInfos | 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 { ProductAppUserInfoFromJSON, ProductAppUserInfoToJSON, } from './ProductAppUserInfo.js';
|
|
15
|
+
/**
|
|
16
|
+
* Check if a given object implements the ProductAppUserInfos interface.
|
|
17
|
+
*/
|
|
18
|
+
export function instanceOfProductAppUserInfos(value) {
|
|
19
|
+
return true;
|
|
20
|
+
}
|
|
21
|
+
export function ProductAppUserInfosFromJSON(json) {
|
|
22
|
+
return ProductAppUserInfosFromJSONTyped(json, false);
|
|
23
|
+
}
|
|
24
|
+
export function ProductAppUserInfosFromJSONTyped(json, ignoreDiscriminator) {
|
|
25
|
+
if (json == null) {
|
|
26
|
+
return json;
|
|
27
|
+
}
|
|
28
|
+
return {
|
|
29
|
+
'productAppUserInfo': json['productAppUserInfo'] == null ? undefined : (json['productAppUserInfo'].map(ProductAppUserInfoFromJSON)),
|
|
30
|
+
};
|
|
31
|
+
}
|
|
32
|
+
export function ProductAppUserInfosToJSON(json) {
|
|
33
|
+
return ProductAppUserInfosToJSONTyped(json, false);
|
|
34
|
+
}
|
|
35
|
+
export function ProductAppUserInfosToJSONTyped(value, ignoreDiscriminator = false) {
|
|
36
|
+
if (value == null) {
|
|
37
|
+
return value;
|
|
38
|
+
}
|
|
39
|
+
return {
|
|
40
|
+
'productAppUserInfo': value['productAppUserInfo'] == null ? undefined : (value['productAppUserInfo'].map(ProductAppUserInfoToJSON)),
|
|
41
|
+
};
|
|
42
|
+
}
|
|
@@ -0,0 +1,32 @@
|
|
|
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 ProductUserInfo
|
|
16
|
+
*/
|
|
17
|
+
export interface ProductUserInfo {
|
|
18
|
+
/**
|
|
19
|
+
*
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof ProductUserInfo
|
|
22
|
+
*/
|
|
23
|
+
productType?: string;
|
|
24
|
+
}
|
|
25
|
+
/**
|
|
26
|
+
* Check if a given object implements the ProductUserInfo interface.
|
|
27
|
+
*/
|
|
28
|
+
export declare function instanceOfProductUserInfo(value: object): value is ProductUserInfo;
|
|
29
|
+
export declare function ProductUserInfoFromJSON(json: any): ProductUserInfo;
|
|
30
|
+
export declare function ProductUserInfoFromJSONTyped(json: any, ignoreDiscriminator: boolean): ProductUserInfo;
|
|
31
|
+
export declare function ProductUserInfoToJSON(json: any): ProductUserInfo;
|
|
32
|
+
export declare function ProductUserInfoToJSONTyped(value?: ProductUserInfo | null, ignoreDiscriminator?: boolean): any;
|