@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,218 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Candescent DI API
|
|
3
|
+
* Welcome to the **Candescent Digital Insight API** documentation. This comprehensive API platform enables financial institutions, Marketplace Partners, and developers to build powerful digital banking experiences. ## Getting Started New to the Candescent API? Start here: - **[Quick Start Guide](/guides/getting-started/quickstart/)** - Make your first API call in minutes - **[API Categories Overview](/guides/getting-started/api-overview/)** - Explore all available API categories - **[Error Codes Reference](/guides/getting-started/error-codes/)** - Handle errors effectively ## API Categories | Category | Description | |----------|-------------| | **[Accounts](/api/generated/accounts/)** | Account information, transactions, and banking images | | **[Alert Configuration](/api/generated/alert-configuration/)** | Alert types and templates | | **[Alert Delivery](/api/generated/alert-delivery/)** | Alert delivery history | | **[Alert Preferences](/api/generated/alert-preferences/)** | End-user notification preferences | | **[Authentication](/api/generated/authentication/)** | OAuth 2.0 token management and authorization | | **[Business Banking](/api/generated/business-banking/)** | Business banking services | | **[Customer Campaigns](/api/generated/customer-campaigns/)** | User segmentation and promotions | | **[Customer Management](/api/generated/customer-management/)** | Customer profiles, registration, and self-service | | **[Documents and Preferences](/api/generated/documents-and-preferences/)** | Disclosures and e-statement preferences | | **[Money Movement](/api/generated/money-movement/)** | Recipients and fund transfers | | **[MX](/api/generated/mx/)** | Account aggregation and financial insights | | **[Notification Channels](/api/generated/notification-channels/)** | Notification channels for alert delivery | ## Base URLs | Environment | Base URL | |-------------|----------| | Stage | `https://api.candescent.com/digitalbanking/stage` | | Production | `https://api.candescent.com/digitalbanking` | > **Note:** This documentation primarily references the **Stage** environment for examples. ## Authentication Overview Candescent APIs use OAuth 2.0 with JWT Bearer tokens. Follow these steps: ### Step 1: Obtain Client Credentials Get your `Client ID` and `Client Secret` from the Candescent Developer Console. ### Step 2: Generate an Access Token ```bash curl -X POST \'https://api.candescent.com/digitalbanking/stage/oauth2/v1/token\' \\ -H \'Authorization: Basic <BASE64_ENCODED(CLIENT_ID:CLIENT_SECRET)>\' \\ -H \'Content-Type: application/x-www-form-urlencoded\' \\ -H \'transactionid: <YOUR_UNIQUE_UUID>\' \\ -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\ -d \'grant_type=client_credentials\' ``` ### Step 3: Make Authenticated Requests Include the token in the `Authorization` header: ```bash curl \'https://api.candescent.com/digitalbanking/stage/accounts/v1/accounts\' \\ -H \'Authorization: Bearer <YOUR_ACCESS_TOKEN>\' \\ -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\ -H \'transactionid: <YOUR_UNIQUE_UUID>\' ``` > **Tip:** Access tokens expire in ~1 hour. Implement token refresh logic for uninterrupted access. For detailed authentication flows, see the **[Authentication API Reference](/api/generated/authentication/)**.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.4.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import * as runtime from '../runtime.js';
|
|
13
|
+
import type { AlertHistoryContentResource, AlertHistorySummaryResources, Event } from '../models/index.js';
|
|
14
|
+
export interface AlertDeliveryApiGetHistoryContentRequest {
|
|
15
|
+
alertHistoryId?: string;
|
|
16
|
+
eventId?: string;
|
|
17
|
+
id?: number;
|
|
18
|
+
}
|
|
19
|
+
export interface AlertDeliveryApiListHistoryRequest {
|
|
20
|
+
accountIds?: Array<string>;
|
|
21
|
+
alertTypeNames?: Array<string>;
|
|
22
|
+
emailStatus?: ListHistoryEmailStatusEnum;
|
|
23
|
+
endDate?: string;
|
|
24
|
+
eventIds?: Array<string>;
|
|
25
|
+
id?: number;
|
|
26
|
+
pushStatus?: ListHistoryPushStatusEnum;
|
|
27
|
+
readFlag?: boolean;
|
|
28
|
+
smsStatus?: ListHistorySmsStatusEnum;
|
|
29
|
+
startDate?: string;
|
|
30
|
+
hostUserId?: string;
|
|
31
|
+
loginId?: string;
|
|
32
|
+
institutionCustomerId?: string;
|
|
33
|
+
}
|
|
34
|
+
export interface AlertDeliveryApiPublishEventsRequest {
|
|
35
|
+
event: Event;
|
|
36
|
+
institutionCustomerId?: string;
|
|
37
|
+
hostUserId?: string;
|
|
38
|
+
loginId?: string;
|
|
39
|
+
}
|
|
40
|
+
/**
|
|
41
|
+
* AlertDeliveryApi - interface
|
|
42
|
+
*
|
|
43
|
+
* @export
|
|
44
|
+
* @interface AlertDeliveryApiInterface
|
|
45
|
+
*/
|
|
46
|
+
export interface AlertDeliveryApiInterface {
|
|
47
|
+
/**
|
|
48
|
+
* Creates request options for getHistoryContent without sending the request
|
|
49
|
+
* @param {string} [alertHistoryId] alertHistoryId
|
|
50
|
+
* @param {string} [eventId] eventId
|
|
51
|
+
* @param {number} [id] id
|
|
52
|
+
* @throws {RequiredError}
|
|
53
|
+
* @memberof AlertDeliveryApiInterface
|
|
54
|
+
*/
|
|
55
|
+
getHistoryContentRequestOpts(requestParameters: AlertDeliveryApiGetHistoryContentRequest): Promise<runtime.RequestOpts>;
|
|
56
|
+
/**
|
|
57
|
+
* Retrieve specific alert history records using content ID, history summary ID, or event ID.
|
|
58
|
+
* @summary Get alert history content
|
|
59
|
+
* @param {string} [alertHistoryId] alertHistoryId
|
|
60
|
+
* @param {string} [eventId] eventId
|
|
61
|
+
* @param {number} [id] id
|
|
62
|
+
* @param {*} [options] Override http request option.
|
|
63
|
+
* @throws {RequiredError}
|
|
64
|
+
* @memberof AlertDeliveryApiInterface
|
|
65
|
+
*/
|
|
66
|
+
getHistoryContentRaw(requestParameters: AlertDeliveryApiGetHistoryContentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AlertHistoryContentResource>>;
|
|
67
|
+
/**
|
|
68
|
+
* Retrieve specific alert history records using content ID, history summary ID, or event ID.
|
|
69
|
+
* Get alert history content
|
|
70
|
+
*/
|
|
71
|
+
getHistoryContent(requestParameters: AlertDeliveryApiGetHistoryContentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AlertHistoryContentResource>;
|
|
72
|
+
/**
|
|
73
|
+
* Creates request options for listHistory without sending the request
|
|
74
|
+
* @param {Array<string>} [accountIds] accountIds
|
|
75
|
+
* @param {Array<string>} [alertTypeNames] alertTypeNames
|
|
76
|
+
* @param {Array<'SUCCESS' | 'FAILURE' | 'IN_PROCESS'>} [emailStatus] emailStatus
|
|
77
|
+
* @param {string} [endDate] endDate
|
|
78
|
+
* @param {Array<string>} [eventIds] eventIds
|
|
79
|
+
* @param {number} [id] id
|
|
80
|
+
* @param {Array<'SUCCESS' | 'FAILURE' | 'IN_PROCESS'>} [pushStatus] pushStatus
|
|
81
|
+
* @param {boolean} [readFlag] readFlag
|
|
82
|
+
* @param {Array<'SUCCESS' | 'FAILURE' | 'IN_PROCESS'>} [smsStatus] smsStatus
|
|
83
|
+
* @param {string} [startDate] startDate
|
|
84
|
+
* @param {string} [hostUserId] Identifier for the user associated with the financial institution. This parameter is **required** when the access token was issued using the `client_credentials` grant type; otherwise, it is optional. Cannot be used with `loginId` query parameter.
|
|
85
|
+
* @param {string} [loginId] Login identifier for the user associated with the financial institution. This parameter is **required** when the access token was issued using the `client_credentials` grant type; otherwise, it is optional. Cannot be used with `hostUserId` query parameter.
|
|
86
|
+
* @param {string} [institutionCustomerId] institutionCustomerId
|
|
87
|
+
* @throws {RequiredError}
|
|
88
|
+
* @memberof AlertDeliveryApiInterface
|
|
89
|
+
*/
|
|
90
|
+
listHistoryRequestOpts(requestParameters: AlertDeliveryApiListHistoryRequest): Promise<runtime.RequestOpts>;
|
|
91
|
+
/**
|
|
92
|
+
* Retrieve alert history data using various filter parameters. You can filter by account IDs, date range, alert types, and other criteria.
|
|
93
|
+
* @summary List alert history
|
|
94
|
+
* @param {Array<string>} [accountIds] accountIds
|
|
95
|
+
* @param {Array<string>} [alertTypeNames] alertTypeNames
|
|
96
|
+
* @param {Array<'SUCCESS' | 'FAILURE' | 'IN_PROCESS'>} [emailStatus] emailStatus
|
|
97
|
+
* @param {string} [endDate] endDate
|
|
98
|
+
* @param {Array<string>} [eventIds] eventIds
|
|
99
|
+
* @param {number} [id] id
|
|
100
|
+
* @param {Array<'SUCCESS' | 'FAILURE' | 'IN_PROCESS'>} [pushStatus] pushStatus
|
|
101
|
+
* @param {boolean} [readFlag] readFlag
|
|
102
|
+
* @param {Array<'SUCCESS' | 'FAILURE' | 'IN_PROCESS'>} [smsStatus] smsStatus
|
|
103
|
+
* @param {string} [startDate] startDate
|
|
104
|
+
* @param {string} [hostUserId] Identifier for the user associated with the financial institution. This parameter is **required** when the access token was issued using the `client_credentials` grant type; otherwise, it is optional. Cannot be used with `loginId` query parameter.
|
|
105
|
+
* @param {string} [loginId] Login identifier for the user associated with the financial institution. This parameter is **required** when the access token was issued using the `client_credentials` grant type; otherwise, it is optional. Cannot be used with `hostUserId` query parameter.
|
|
106
|
+
* @param {string} [institutionCustomerId] institutionCustomerId
|
|
107
|
+
* @param {*} [options] Override http request option.
|
|
108
|
+
* @throws {RequiredError}
|
|
109
|
+
* @memberof AlertDeliveryApiInterface
|
|
110
|
+
*/
|
|
111
|
+
listHistoryRaw(requestParameters: AlertDeliveryApiListHistoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AlertHistorySummaryResources>>;
|
|
112
|
+
/**
|
|
113
|
+
* Retrieve alert history data using various filter parameters. You can filter by account IDs, date range, alert types, and other criteria.
|
|
114
|
+
* List alert history
|
|
115
|
+
*/
|
|
116
|
+
listHistory(requestParameters: AlertDeliveryApiListHistoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AlertHistorySummaryResources>;
|
|
117
|
+
/**
|
|
118
|
+
* Creates request options for publishEvents without sending the request
|
|
119
|
+
* @param {Event} event event
|
|
120
|
+
* @param {string} [institutionCustomerId] institutionCustomerId
|
|
121
|
+
* @param {string} [hostUserId] Identifier for the user associated with the financial institution. This parameter is **required** when the access token was issued using the `client_credentials` grant type; otherwise, it is optional. Cannot be used with `loginId` query parameter.
|
|
122
|
+
* @param {string} [loginId] Login identifier for the user associated with the financial institution. This parameter is **required** when the access token was issued using the `client_credentials` grant type; otherwise, it is optional. Cannot be used with `hostUserId` query parameter.
|
|
123
|
+
* @throws {RequiredError}
|
|
124
|
+
* @memberof AlertDeliveryApiInterface
|
|
125
|
+
*/
|
|
126
|
+
publishEventsRequestOpts(requestParameters: AlertDeliveryApiPublishEventsRequest): Promise<runtime.RequestOpts>;
|
|
127
|
+
/**
|
|
128
|
+
* Trigger an alert notification when an event occurs. This API processes the event data and sends notifications based on the configured alert type, template, and customer preferences. **Event Domain Types:** - **AccountEvent**: Account-related alerts (balance changes, low balance, etc.) - **TransactionEvent**: Transaction-related alerts (large transactions, payment exceeding limit, etc.) - **NotificationEvent**: Messages from external parties (such as Visa) that pass through to the customer without additional processing - **UserEvent**: User-related events (login, password change, etc.) **Processing Flow:** 1. Event is received and validated 2. Alert type and user preferences are matched 3. Template is applied with event data 4. Notifications are sent via configured channels (EMAIL, SMS, PUSH)
|
|
129
|
+
* @summary Publish alert event
|
|
130
|
+
* @param {Event} event event
|
|
131
|
+
* @param {string} [institutionCustomerId] institutionCustomerId
|
|
132
|
+
* @param {string} [hostUserId] Identifier for the user associated with the financial institution. This parameter is **required** when the access token was issued using the `client_credentials` grant type; otherwise, it is optional. Cannot be used with `loginId` query parameter.
|
|
133
|
+
* @param {string} [loginId] Login identifier for the user associated with the financial institution. This parameter is **required** when the access token was issued using the `client_credentials` grant type; otherwise, it is optional. Cannot be used with `hostUserId` query parameter.
|
|
134
|
+
* @param {*} [options] Override http request option.
|
|
135
|
+
* @throws {RequiredError}
|
|
136
|
+
* @memberof AlertDeliveryApiInterface
|
|
137
|
+
*/
|
|
138
|
+
publishEventsRaw(requestParameters: AlertDeliveryApiPublishEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
139
|
+
/**
|
|
140
|
+
* Trigger an alert notification when an event occurs. This API processes the event data and sends notifications based on the configured alert type, template, and customer preferences. **Event Domain Types:** - **AccountEvent**: Account-related alerts (balance changes, low balance, etc.) - **TransactionEvent**: Transaction-related alerts (large transactions, payment exceeding limit, etc.) - **NotificationEvent**: Messages from external parties (such as Visa) that pass through to the customer without additional processing - **UserEvent**: User-related events (login, password change, etc.) **Processing Flow:** 1. Event is received and validated 2. Alert type and user preferences are matched 3. Template is applied with event data 4. Notifications are sent via configured channels (EMAIL, SMS, PUSH)
|
|
141
|
+
* Publish alert event
|
|
142
|
+
*/
|
|
143
|
+
publishEvents(requestParameters: AlertDeliveryApiPublishEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
144
|
+
}
|
|
145
|
+
/**
|
|
146
|
+
*
|
|
147
|
+
*/
|
|
148
|
+
export declare class AlertDeliveryApi extends runtime.BaseAPI implements AlertDeliveryApiInterface {
|
|
149
|
+
/**
|
|
150
|
+
* Creates request options for getHistoryContent without sending the request
|
|
151
|
+
*/
|
|
152
|
+
getHistoryContentRequestOpts(requestParameters: AlertDeliveryApiGetHistoryContentRequest): Promise<runtime.RequestOpts>;
|
|
153
|
+
/**
|
|
154
|
+
* Retrieve specific alert history records using content ID, history summary ID, or event ID.
|
|
155
|
+
* Get alert history content
|
|
156
|
+
*/
|
|
157
|
+
getHistoryContentRaw(requestParameters: AlertDeliveryApiGetHistoryContentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AlertHistoryContentResource>>;
|
|
158
|
+
/**
|
|
159
|
+
* Retrieve specific alert history records using content ID, history summary ID, or event ID.
|
|
160
|
+
* Get alert history content
|
|
161
|
+
*/
|
|
162
|
+
getHistoryContent(requestParameters?: AlertDeliveryApiGetHistoryContentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AlertHistoryContentResource>;
|
|
163
|
+
/**
|
|
164
|
+
* Creates request options for listHistory without sending the request
|
|
165
|
+
*/
|
|
166
|
+
listHistoryRequestOpts(requestParameters: AlertDeliveryApiListHistoryRequest): Promise<runtime.RequestOpts>;
|
|
167
|
+
/**
|
|
168
|
+
* Retrieve alert history data using various filter parameters. You can filter by account IDs, date range, alert types, and other criteria.
|
|
169
|
+
* List alert history
|
|
170
|
+
*/
|
|
171
|
+
listHistoryRaw(requestParameters: AlertDeliveryApiListHistoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AlertHistorySummaryResources>>;
|
|
172
|
+
/**
|
|
173
|
+
* Retrieve alert history data using various filter parameters. You can filter by account IDs, date range, alert types, and other criteria.
|
|
174
|
+
* List alert history
|
|
175
|
+
*/
|
|
176
|
+
listHistory(requestParameters?: AlertDeliveryApiListHistoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AlertHistorySummaryResources>;
|
|
177
|
+
/**
|
|
178
|
+
* Creates request options for publishEvents without sending the request
|
|
179
|
+
*/
|
|
180
|
+
publishEventsRequestOpts(requestParameters: AlertDeliveryApiPublishEventsRequest): Promise<runtime.RequestOpts>;
|
|
181
|
+
/**
|
|
182
|
+
* Trigger an alert notification when an event occurs. This API processes the event data and sends notifications based on the configured alert type, template, and customer preferences. **Event Domain Types:** - **AccountEvent**: Account-related alerts (balance changes, low balance, etc.) - **TransactionEvent**: Transaction-related alerts (large transactions, payment exceeding limit, etc.) - **NotificationEvent**: Messages from external parties (such as Visa) that pass through to the customer without additional processing - **UserEvent**: User-related events (login, password change, etc.) **Processing Flow:** 1. Event is received and validated 2. Alert type and user preferences are matched 3. Template is applied with event data 4. Notifications are sent via configured channels (EMAIL, SMS, PUSH)
|
|
183
|
+
* Publish alert event
|
|
184
|
+
*/
|
|
185
|
+
publishEventsRaw(requestParameters: AlertDeliveryApiPublishEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
186
|
+
/**
|
|
187
|
+
* Trigger an alert notification when an event occurs. This API processes the event data and sends notifications based on the configured alert type, template, and customer preferences. **Event Domain Types:** - **AccountEvent**: Account-related alerts (balance changes, low balance, etc.) - **TransactionEvent**: Transaction-related alerts (large transactions, payment exceeding limit, etc.) - **NotificationEvent**: Messages from external parties (such as Visa) that pass through to the customer without additional processing - **UserEvent**: User-related events (login, password change, etc.) **Processing Flow:** 1. Event is received and validated 2. Alert type and user preferences are matched 3. Template is applied with event data 4. Notifications are sent via configured channels (EMAIL, SMS, PUSH)
|
|
188
|
+
* Publish alert event
|
|
189
|
+
*/
|
|
190
|
+
publishEvents(requestParameters: AlertDeliveryApiPublishEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
191
|
+
}
|
|
192
|
+
/**
|
|
193
|
+
* @export
|
|
194
|
+
*/
|
|
195
|
+
export declare const ListHistoryEmailStatusEnum: {
|
|
196
|
+
readonly SUCCESS: "SUCCESS";
|
|
197
|
+
readonly FAILURE: "FAILURE";
|
|
198
|
+
readonly IN_PROCESS: "IN_PROCESS";
|
|
199
|
+
};
|
|
200
|
+
export type ListHistoryEmailStatusEnum = typeof ListHistoryEmailStatusEnum[keyof typeof ListHistoryEmailStatusEnum];
|
|
201
|
+
/**
|
|
202
|
+
* @export
|
|
203
|
+
*/
|
|
204
|
+
export declare const ListHistoryPushStatusEnum: {
|
|
205
|
+
readonly SUCCESS: "SUCCESS";
|
|
206
|
+
readonly FAILURE: "FAILURE";
|
|
207
|
+
readonly IN_PROCESS: "IN_PROCESS";
|
|
208
|
+
};
|
|
209
|
+
export type ListHistoryPushStatusEnum = typeof ListHistoryPushStatusEnum[keyof typeof ListHistoryPushStatusEnum];
|
|
210
|
+
/**
|
|
211
|
+
* @export
|
|
212
|
+
*/
|
|
213
|
+
export declare const ListHistorySmsStatusEnum: {
|
|
214
|
+
readonly SUCCESS: "SUCCESS";
|
|
215
|
+
readonly FAILURE: "FAILURE";
|
|
216
|
+
readonly IN_PROCESS: "IN_PROCESS";
|
|
217
|
+
};
|
|
218
|
+
export type ListHistorySmsStatusEnum = typeof ListHistorySmsStatusEnum[keyof typeof ListHistorySmsStatusEnum];
|
|
@@ -0,0 +1,219 @@
|
|
|
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 * as runtime from '../runtime.js';
|
|
15
|
+
import { AlertHistoryContentResourceFromJSON, AlertHistorySummaryResourcesFromJSON, EventToJSON, } from '../models/index.js';
|
|
16
|
+
/**
|
|
17
|
+
*
|
|
18
|
+
*/
|
|
19
|
+
export class AlertDeliveryApi extends runtime.BaseAPI {
|
|
20
|
+
/**
|
|
21
|
+
* Creates request options for getHistoryContent without sending the request
|
|
22
|
+
*/
|
|
23
|
+
async getHistoryContentRequestOpts(requestParameters) {
|
|
24
|
+
const queryParameters = {};
|
|
25
|
+
if (requestParameters['alertHistoryId'] != null) {
|
|
26
|
+
queryParameters['alertHistoryId'] = requestParameters['alertHistoryId'];
|
|
27
|
+
}
|
|
28
|
+
if (requestParameters['eventId'] != null) {
|
|
29
|
+
queryParameters['eventId'] = requestParameters['eventId'];
|
|
30
|
+
}
|
|
31
|
+
if (requestParameters['id'] != null) {
|
|
32
|
+
queryParameters['id'] = requestParameters['id'];
|
|
33
|
+
}
|
|
34
|
+
const headerParameters = {};
|
|
35
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
36
|
+
const token = this.configuration.accessToken;
|
|
37
|
+
const tokenString = await token("BearerAuth", []);
|
|
38
|
+
if (tokenString) {
|
|
39
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
40
|
+
}
|
|
41
|
+
}
|
|
42
|
+
let urlPath = `/db-alerts-delivery/v1/alert-history-content`;
|
|
43
|
+
return {
|
|
44
|
+
path: urlPath,
|
|
45
|
+
method: 'GET',
|
|
46
|
+
headers: headerParameters,
|
|
47
|
+
query: queryParameters,
|
|
48
|
+
};
|
|
49
|
+
}
|
|
50
|
+
/**
|
|
51
|
+
* Retrieve specific alert history records using content ID, history summary ID, or event ID.
|
|
52
|
+
* Get alert history content
|
|
53
|
+
*/
|
|
54
|
+
async getHistoryContentRaw(requestParameters, initOverrides) {
|
|
55
|
+
const requestOptions = await this.getHistoryContentRequestOpts(requestParameters);
|
|
56
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
57
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => AlertHistoryContentResourceFromJSON(jsonValue));
|
|
58
|
+
}
|
|
59
|
+
/**
|
|
60
|
+
* Retrieve specific alert history records using content ID, history summary ID, or event ID.
|
|
61
|
+
* Get alert history content
|
|
62
|
+
*/
|
|
63
|
+
async getHistoryContent(requestParameters = {}, initOverrides) {
|
|
64
|
+
const response = await this.getHistoryContentRaw(requestParameters, initOverrides);
|
|
65
|
+
return await response.value();
|
|
66
|
+
}
|
|
67
|
+
/**
|
|
68
|
+
* Creates request options for listHistory without sending the request
|
|
69
|
+
*/
|
|
70
|
+
async listHistoryRequestOpts(requestParameters) {
|
|
71
|
+
const queryParameters = {};
|
|
72
|
+
if (requestParameters['accountIds'] != null) {
|
|
73
|
+
queryParameters['accountIds'] = requestParameters['accountIds'];
|
|
74
|
+
}
|
|
75
|
+
if (requestParameters['alertTypeNames'] != null) {
|
|
76
|
+
queryParameters['alertTypeNames'] = requestParameters['alertTypeNames'];
|
|
77
|
+
}
|
|
78
|
+
if (requestParameters['emailStatus'] != null) {
|
|
79
|
+
queryParameters['emailStatus'] = requestParameters['emailStatus'];
|
|
80
|
+
}
|
|
81
|
+
if (requestParameters['endDate'] != null) {
|
|
82
|
+
queryParameters['endDate'] = requestParameters['endDate'];
|
|
83
|
+
}
|
|
84
|
+
if (requestParameters['eventIds'] != null) {
|
|
85
|
+
queryParameters['eventIds'] = requestParameters['eventIds'];
|
|
86
|
+
}
|
|
87
|
+
if (requestParameters['id'] != null) {
|
|
88
|
+
queryParameters['id'] = requestParameters['id'];
|
|
89
|
+
}
|
|
90
|
+
if (requestParameters['pushStatus'] != null) {
|
|
91
|
+
queryParameters['pushStatus'] = requestParameters['pushStatus'];
|
|
92
|
+
}
|
|
93
|
+
if (requestParameters['readFlag'] != null) {
|
|
94
|
+
queryParameters['readFlag'] = requestParameters['readFlag'];
|
|
95
|
+
}
|
|
96
|
+
if (requestParameters['smsStatus'] != null) {
|
|
97
|
+
queryParameters['smsStatus'] = requestParameters['smsStatus'];
|
|
98
|
+
}
|
|
99
|
+
if (requestParameters['startDate'] != null) {
|
|
100
|
+
queryParameters['startDate'] = requestParameters['startDate'];
|
|
101
|
+
}
|
|
102
|
+
if (requestParameters['hostUserId'] != null) {
|
|
103
|
+
queryParameters['hostUserId'] = requestParameters['hostUserId'];
|
|
104
|
+
}
|
|
105
|
+
if (requestParameters['loginId'] != null) {
|
|
106
|
+
queryParameters['loginId'] = requestParameters['loginId'];
|
|
107
|
+
}
|
|
108
|
+
const headerParameters = {};
|
|
109
|
+
if (requestParameters['institutionCustomerId'] != null) {
|
|
110
|
+
headerParameters['institutionCustomerId'] = String(requestParameters['institutionCustomerId']);
|
|
111
|
+
}
|
|
112
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
113
|
+
const token = this.configuration.accessToken;
|
|
114
|
+
const tokenString = await token("BearerAuth", []);
|
|
115
|
+
if (tokenString) {
|
|
116
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
117
|
+
}
|
|
118
|
+
}
|
|
119
|
+
let urlPath = `/db-alerts-delivery/v1/alert-history`;
|
|
120
|
+
return {
|
|
121
|
+
path: urlPath,
|
|
122
|
+
method: 'GET',
|
|
123
|
+
headers: headerParameters,
|
|
124
|
+
query: queryParameters,
|
|
125
|
+
};
|
|
126
|
+
}
|
|
127
|
+
/**
|
|
128
|
+
* Retrieve alert history data using various filter parameters. You can filter by account IDs, date range, alert types, and other criteria.
|
|
129
|
+
* List alert history
|
|
130
|
+
*/
|
|
131
|
+
async listHistoryRaw(requestParameters, initOverrides) {
|
|
132
|
+
const requestOptions = await this.listHistoryRequestOpts(requestParameters);
|
|
133
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
134
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => AlertHistorySummaryResourcesFromJSON(jsonValue));
|
|
135
|
+
}
|
|
136
|
+
/**
|
|
137
|
+
* Retrieve alert history data using various filter parameters. You can filter by account IDs, date range, alert types, and other criteria.
|
|
138
|
+
* List alert history
|
|
139
|
+
*/
|
|
140
|
+
async listHistory(requestParameters = {}, initOverrides) {
|
|
141
|
+
const response = await this.listHistoryRaw(requestParameters, initOverrides);
|
|
142
|
+
return await response.value();
|
|
143
|
+
}
|
|
144
|
+
/**
|
|
145
|
+
* Creates request options for publishEvents without sending the request
|
|
146
|
+
*/
|
|
147
|
+
async publishEventsRequestOpts(requestParameters) {
|
|
148
|
+
if (requestParameters['event'] == null) {
|
|
149
|
+
throw new runtime.RequiredError('event', 'Required parameter "event" was null or undefined when calling publishEvents().');
|
|
150
|
+
}
|
|
151
|
+
const queryParameters = {};
|
|
152
|
+
if (requestParameters['hostUserId'] != null) {
|
|
153
|
+
queryParameters['hostUserId'] = requestParameters['hostUserId'];
|
|
154
|
+
}
|
|
155
|
+
if (requestParameters['loginId'] != null) {
|
|
156
|
+
queryParameters['loginId'] = requestParameters['loginId'];
|
|
157
|
+
}
|
|
158
|
+
const headerParameters = {};
|
|
159
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
160
|
+
if (requestParameters['institutionCustomerId'] != null) {
|
|
161
|
+
headerParameters['institutionCustomerId'] = String(requestParameters['institutionCustomerId']);
|
|
162
|
+
}
|
|
163
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
164
|
+
const token = this.configuration.accessToken;
|
|
165
|
+
const tokenString = await token("BearerAuth", []);
|
|
166
|
+
if (tokenString) {
|
|
167
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
168
|
+
}
|
|
169
|
+
}
|
|
170
|
+
let urlPath = `/db-events/v1/realtime-events`;
|
|
171
|
+
return {
|
|
172
|
+
path: urlPath,
|
|
173
|
+
method: 'POST',
|
|
174
|
+
headers: headerParameters,
|
|
175
|
+
query: queryParameters,
|
|
176
|
+
body: EventToJSON(requestParameters['event']),
|
|
177
|
+
};
|
|
178
|
+
}
|
|
179
|
+
/**
|
|
180
|
+
* Trigger an alert notification when an event occurs. This API processes the event data and sends notifications based on the configured alert type, template, and customer preferences. **Event Domain Types:** - **AccountEvent**: Account-related alerts (balance changes, low balance, etc.) - **TransactionEvent**: Transaction-related alerts (large transactions, payment exceeding limit, etc.) - **NotificationEvent**: Messages from external parties (such as Visa) that pass through to the customer without additional processing - **UserEvent**: User-related events (login, password change, etc.) **Processing Flow:** 1. Event is received and validated 2. Alert type and user preferences are matched 3. Template is applied with event data 4. Notifications are sent via configured channels (EMAIL, SMS, PUSH)
|
|
181
|
+
* Publish alert event
|
|
182
|
+
*/
|
|
183
|
+
async publishEventsRaw(requestParameters, initOverrides) {
|
|
184
|
+
const requestOptions = await this.publishEventsRequestOpts(requestParameters);
|
|
185
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
186
|
+
return new runtime.VoidApiResponse(response);
|
|
187
|
+
}
|
|
188
|
+
/**
|
|
189
|
+
* Trigger an alert notification when an event occurs. This API processes the event data and sends notifications based on the configured alert type, template, and customer preferences. **Event Domain Types:** - **AccountEvent**: Account-related alerts (balance changes, low balance, etc.) - **TransactionEvent**: Transaction-related alerts (large transactions, payment exceeding limit, etc.) - **NotificationEvent**: Messages from external parties (such as Visa) that pass through to the customer without additional processing - **UserEvent**: User-related events (login, password change, etc.) **Processing Flow:** 1. Event is received and validated 2. Alert type and user preferences are matched 3. Template is applied with event data 4. Notifications are sent via configured channels (EMAIL, SMS, PUSH)
|
|
190
|
+
* Publish alert event
|
|
191
|
+
*/
|
|
192
|
+
async publishEvents(requestParameters, initOverrides) {
|
|
193
|
+
await this.publishEventsRaw(requestParameters, initOverrides);
|
|
194
|
+
}
|
|
195
|
+
}
|
|
196
|
+
/**
|
|
197
|
+
* @export
|
|
198
|
+
*/
|
|
199
|
+
export const ListHistoryEmailStatusEnum = {
|
|
200
|
+
SUCCESS: 'SUCCESS',
|
|
201
|
+
FAILURE: 'FAILURE',
|
|
202
|
+
IN_PROCESS: 'IN_PROCESS'
|
|
203
|
+
};
|
|
204
|
+
/**
|
|
205
|
+
* @export
|
|
206
|
+
*/
|
|
207
|
+
export const ListHistoryPushStatusEnum = {
|
|
208
|
+
SUCCESS: 'SUCCESS',
|
|
209
|
+
FAILURE: 'FAILURE',
|
|
210
|
+
IN_PROCESS: 'IN_PROCESS'
|
|
211
|
+
};
|
|
212
|
+
/**
|
|
213
|
+
* @export
|
|
214
|
+
*/
|
|
215
|
+
export const ListHistorySmsStatusEnum = {
|
|
216
|
+
SUCCESS: 'SUCCESS',
|
|
217
|
+
FAILURE: 'FAILURE',
|
|
218
|
+
IN_PROCESS: 'IN_PROCESS'
|
|
219
|
+
};
|