@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,555 @@
|
|
|
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 { EStatementDisclosureResponseFromJSON, EStatementPreferencesRequestToJSON, EStatementReportRequestToJSON, EStatementReportResponseFromJSON, EStatementRequestToJSON, InstitutionDisclosureFromJSON, InstitutionDisclosureToJSON, InstitutionDisclosuresFromJSON, InstitutionUserDisclosureToJSON, InstitutionUserDisclosuresFromJSON, } from '../models/index.js';
|
|
16
|
+
/**
|
|
17
|
+
*
|
|
18
|
+
*/
|
|
19
|
+
export class DocumentsAndPreferencesApi extends runtime.BaseAPI {
|
|
20
|
+
/**
|
|
21
|
+
* Creates request options for createInstitutionDisclosure without sending the request
|
|
22
|
+
*/
|
|
23
|
+
async createInstitutionDisclosureRequestOpts(requestParameters) {
|
|
24
|
+
if (requestParameters['institutionDisclosure'] == null) {
|
|
25
|
+
throw new runtime.RequiredError('institutionDisclosure', 'Required parameter "institutionDisclosure" was null or undefined when calling createInstitutionDisclosure().');
|
|
26
|
+
}
|
|
27
|
+
const queryParameters = {};
|
|
28
|
+
const headerParameters = {};
|
|
29
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
30
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
31
|
+
const token = this.configuration.accessToken;
|
|
32
|
+
const tokenString = await token("BearerAuth", []);
|
|
33
|
+
if (tokenString) {
|
|
34
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
35
|
+
}
|
|
36
|
+
}
|
|
37
|
+
let urlPath = `/db-disclosures/v1/institution-disclosures`;
|
|
38
|
+
return {
|
|
39
|
+
path: urlPath,
|
|
40
|
+
method: 'POST',
|
|
41
|
+
headers: headerParameters,
|
|
42
|
+
query: queryParameters,
|
|
43
|
+
body: InstitutionDisclosureToJSON(requestParameters['institutionDisclosure']),
|
|
44
|
+
};
|
|
45
|
+
}
|
|
46
|
+
/**
|
|
47
|
+
* Creates a new disclosure definition for the financial institution. The disclosure can contain content as a URL reference or agreement for online statement. **Scope Required:** `disclosures:write`
|
|
48
|
+
* Create institution disclosure
|
|
49
|
+
*/
|
|
50
|
+
async createInstitutionDisclosureRaw(requestParameters, initOverrides) {
|
|
51
|
+
const requestOptions = await this.createInstitutionDisclosureRequestOpts(requestParameters);
|
|
52
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
53
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => InstitutionDisclosureFromJSON(jsonValue));
|
|
54
|
+
}
|
|
55
|
+
/**
|
|
56
|
+
* Creates a new disclosure definition for the financial institution. The disclosure can contain content as a URL reference or agreement for online statement. **Scope Required:** `disclosures:write`
|
|
57
|
+
* Create institution disclosure
|
|
58
|
+
*/
|
|
59
|
+
async createInstitutionDisclosure(requestParameters, initOverrides) {
|
|
60
|
+
const response = await this.createInstitutionDisclosureRaw(requestParameters, initOverrides);
|
|
61
|
+
return await response.value();
|
|
62
|
+
}
|
|
63
|
+
/**
|
|
64
|
+
* Creates request options for createUserDisclosure without sending the request
|
|
65
|
+
*/
|
|
66
|
+
async createUserDisclosureRequestOpts(requestParameters) {
|
|
67
|
+
if (requestParameters['institutionUserDisclosure'] == null) {
|
|
68
|
+
throw new runtime.RequiredError('institutionUserDisclosure', 'Required parameter "institutionUserDisclosure" was null or undefined when calling createUserDisclosure().');
|
|
69
|
+
}
|
|
70
|
+
const queryParameters = {};
|
|
71
|
+
if (requestParameters['hostUserId'] != null) {
|
|
72
|
+
queryParameters['hostUserId'] = requestParameters['hostUserId'];
|
|
73
|
+
}
|
|
74
|
+
if (requestParameters['loginId'] != null) {
|
|
75
|
+
queryParameters['loginId'] = requestParameters['loginId'];
|
|
76
|
+
}
|
|
77
|
+
if (requestParameters['institutionCustomerId'] != null) {
|
|
78
|
+
queryParameters['institutionCustomerId'] = requestParameters['institutionCustomerId'];
|
|
79
|
+
}
|
|
80
|
+
if (requestParameters['accountType'] != null) {
|
|
81
|
+
queryParameters['accountType'] = requestParameters['accountType'];
|
|
82
|
+
}
|
|
83
|
+
const headerParameters = {};
|
|
84
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
85
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
86
|
+
const token = this.configuration.accessToken;
|
|
87
|
+
const tokenString = await token("BearerAuth", []);
|
|
88
|
+
if (tokenString) {
|
|
89
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
90
|
+
}
|
|
91
|
+
}
|
|
92
|
+
let urlPath = `/db-disclosures/v1/institution-user-disclosures`;
|
|
93
|
+
return {
|
|
94
|
+
path: urlPath,
|
|
95
|
+
method: 'POST',
|
|
96
|
+
headers: headerParameters,
|
|
97
|
+
query: queryParameters,
|
|
98
|
+
body: InstitutionUserDisclosureToJSON(requestParameters['institutionUserDisclosure']),
|
|
99
|
+
};
|
|
100
|
+
}
|
|
101
|
+
/**
|
|
102
|
+
* Creates a new user disclosure acceptance record. Use this to record when a user accepts or enrolls in a disclosure during onboarding or account updates. **Scope Required:** `disclosures:write` For multi-statement disclosures (e.g., e-statement consent), the `accountType` parameter specifies which account type the disclosure applies to. This API can also be used to update online statement disclosure.
|
|
103
|
+
* Create user disclosure
|
|
104
|
+
*/
|
|
105
|
+
async createUserDisclosureRaw(requestParameters, initOverrides) {
|
|
106
|
+
const requestOptions = await this.createUserDisclosureRequestOpts(requestParameters);
|
|
107
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
108
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => InstitutionUserDisclosuresFromJSON(jsonValue));
|
|
109
|
+
}
|
|
110
|
+
/**
|
|
111
|
+
* Creates a new user disclosure acceptance record. Use this to record when a user accepts or enrolls in a disclosure during onboarding or account updates. **Scope Required:** `disclosures:write` For multi-statement disclosures (e.g., e-statement consent), the `accountType` parameter specifies which account type the disclosure applies to. This API can also be used to update online statement disclosure.
|
|
112
|
+
* Create user disclosure
|
|
113
|
+
*/
|
|
114
|
+
async createUserDisclosure(requestParameters, initOverrides) {
|
|
115
|
+
const response = await this.createUserDisclosureRaw(requestParameters, initOverrides);
|
|
116
|
+
switch (response.raw.status) {
|
|
117
|
+
case 200:
|
|
118
|
+
return await response.value();
|
|
119
|
+
case 204:
|
|
120
|
+
return null;
|
|
121
|
+
default:
|
|
122
|
+
return await response.value();
|
|
123
|
+
}
|
|
124
|
+
}
|
|
125
|
+
/**
|
|
126
|
+
* Creates request options for deleteUserDisclosure without sending the request
|
|
127
|
+
*/
|
|
128
|
+
async deleteUserDisclosureRequestOpts(requestParameters) {
|
|
129
|
+
if (requestParameters['accountType'] == null) {
|
|
130
|
+
throw new runtime.RequiredError('accountType', 'Required parameter "accountType" was null or undefined when calling deleteUserDisclosure().');
|
|
131
|
+
}
|
|
132
|
+
if (requestParameters['institutionUserDisclosure'] == null) {
|
|
133
|
+
throw new runtime.RequiredError('institutionUserDisclosure', 'Required parameter "institutionUserDisclosure" was null or undefined when calling deleteUserDisclosure().');
|
|
134
|
+
}
|
|
135
|
+
const queryParameters = {};
|
|
136
|
+
if (requestParameters['hostUserId'] != null) {
|
|
137
|
+
queryParameters['hostUserId'] = requestParameters['hostUserId'];
|
|
138
|
+
}
|
|
139
|
+
if (requestParameters['loginId'] != null) {
|
|
140
|
+
queryParameters['loginId'] = requestParameters['loginId'];
|
|
141
|
+
}
|
|
142
|
+
if (requestParameters['institutionCustomerId'] != null) {
|
|
143
|
+
queryParameters['institutionCustomerId'] = requestParameters['institutionCustomerId'];
|
|
144
|
+
}
|
|
145
|
+
if (requestParameters['accountType'] != null) {
|
|
146
|
+
queryParameters['accountType'] = requestParameters['accountType'];
|
|
147
|
+
}
|
|
148
|
+
const headerParameters = {};
|
|
149
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
150
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
151
|
+
const token = this.configuration.accessToken;
|
|
152
|
+
const tokenString = await token("BearerAuth", []);
|
|
153
|
+
if (tokenString) {
|
|
154
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
155
|
+
}
|
|
156
|
+
}
|
|
157
|
+
let urlPath = `/db-disclosures/v1/institution-user-disclosures`;
|
|
158
|
+
return {
|
|
159
|
+
path: urlPath,
|
|
160
|
+
method: 'DELETE',
|
|
161
|
+
headers: headerParameters,
|
|
162
|
+
query: queryParameters,
|
|
163
|
+
body: InstitutionUserDisclosureToJSON(requestParameters['institutionUserDisclosure']),
|
|
164
|
+
};
|
|
165
|
+
}
|
|
166
|
+
/**
|
|
167
|
+
* Deletes a user disclosure acceptance record. Use this to remove a user\'s disclosure enrollment or acceptance status. **Scope Required:** `disclosures:write` **Note:** This permanently removes the disclosure record. The user may need to re-accept the disclosure if required by the institution.
|
|
168
|
+
* Delete user disclosure for online statement
|
|
169
|
+
*/
|
|
170
|
+
async deleteUserDisclosureRaw(requestParameters, initOverrides) {
|
|
171
|
+
const requestOptions = await this.deleteUserDisclosureRequestOpts(requestParameters);
|
|
172
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
173
|
+
return new runtime.VoidApiResponse(response);
|
|
174
|
+
}
|
|
175
|
+
/**
|
|
176
|
+
* Deletes a user disclosure acceptance record. Use this to remove a user\'s disclosure enrollment or acceptance status. **Scope Required:** `disclosures:write` **Note:** This permanently removes the disclosure record. The user may need to re-accept the disclosure if required by the institution.
|
|
177
|
+
* Delete user disclosure for online statement
|
|
178
|
+
*/
|
|
179
|
+
async deleteUserDisclosure(requestParameters, initOverrides) {
|
|
180
|
+
await this.deleteUserDisclosureRaw(requestParameters, initOverrides);
|
|
181
|
+
}
|
|
182
|
+
/**
|
|
183
|
+
* Creates request options for getDisclosuresByAccount without sending the request
|
|
184
|
+
*/
|
|
185
|
+
async getDisclosuresByAccountRequestOpts(requestParameters) {
|
|
186
|
+
if (requestParameters['accountId'] == null) {
|
|
187
|
+
throw new runtime.RequiredError('accountId', 'Required parameter "accountId" was null or undefined when calling getDisclosuresByAccount().');
|
|
188
|
+
}
|
|
189
|
+
const queryParameters = {};
|
|
190
|
+
if (requestParameters['hostUserId'] != null) {
|
|
191
|
+
queryParameters['hostUserId'] = requestParameters['hostUserId'];
|
|
192
|
+
}
|
|
193
|
+
if (requestParameters['loginId'] != null) {
|
|
194
|
+
queryParameters['loginId'] = requestParameters['loginId'];
|
|
195
|
+
}
|
|
196
|
+
const headerParameters = {};
|
|
197
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
198
|
+
const token = this.configuration.accessToken;
|
|
199
|
+
const tokenString = await token("BearerAuth", []);
|
|
200
|
+
if (tokenString) {
|
|
201
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
202
|
+
}
|
|
203
|
+
}
|
|
204
|
+
let urlPath = `/ux-users/v1/e-statements/{accountId}/disclosures`;
|
|
205
|
+
urlPath = urlPath.replace(`{${"accountId"}}`, encodeURIComponent(String(requestParameters['accountId'])));
|
|
206
|
+
return {
|
|
207
|
+
path: urlPath,
|
|
208
|
+
method: 'GET',
|
|
209
|
+
headers: headerParameters,
|
|
210
|
+
query: queryParameters,
|
|
211
|
+
};
|
|
212
|
+
}
|
|
213
|
+
/**
|
|
214
|
+
* API to fetch disclosure information for the particular account Id
|
|
215
|
+
* To fetch disclosure information for the particular account Id
|
|
216
|
+
*/
|
|
217
|
+
async getDisclosuresByAccountRaw(requestParameters, initOverrides) {
|
|
218
|
+
const requestOptions = await this.getDisclosuresByAccountRequestOpts(requestParameters);
|
|
219
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
220
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => EStatementDisclosureResponseFromJSON(jsonValue));
|
|
221
|
+
}
|
|
222
|
+
/**
|
|
223
|
+
* API to fetch disclosure information for the particular account Id
|
|
224
|
+
* To fetch disclosure information for the particular account Id
|
|
225
|
+
*/
|
|
226
|
+
async getDisclosuresByAccount(requestParameters, initOverrides) {
|
|
227
|
+
const response = await this.getDisclosuresByAccountRaw(requestParameters, initOverrides);
|
|
228
|
+
return await response.value();
|
|
229
|
+
}
|
|
230
|
+
/**
|
|
231
|
+
* Creates request options for getEstatementsReport without sending the request
|
|
232
|
+
*/
|
|
233
|
+
async getEstatementsReportRequestOpts(requestParameters) {
|
|
234
|
+
if (requestParameters['eStatementReportRequest'] == null) {
|
|
235
|
+
throw new runtime.RequiredError('eStatementReportRequest', 'Required parameter "eStatementReportRequest" was null or undefined when calling getEstatementsReport().');
|
|
236
|
+
}
|
|
237
|
+
const queryParameters = {};
|
|
238
|
+
if (requestParameters['hostUserId'] != null) {
|
|
239
|
+
queryParameters['hostUserId'] = requestParameters['hostUserId'];
|
|
240
|
+
}
|
|
241
|
+
if (requestParameters['loginId'] != null) {
|
|
242
|
+
queryParameters['loginId'] = requestParameters['loginId'];
|
|
243
|
+
}
|
|
244
|
+
const headerParameters = {};
|
|
245
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
246
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
247
|
+
const token = this.configuration.accessToken;
|
|
248
|
+
const tokenString = await token("BearerAuth", []);
|
|
249
|
+
if (tokenString) {
|
|
250
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
251
|
+
}
|
|
252
|
+
}
|
|
253
|
+
let urlPath = `/ux-users/v1/reports/e-statements`;
|
|
254
|
+
return {
|
|
255
|
+
path: urlPath,
|
|
256
|
+
method: 'POST',
|
|
257
|
+
headers: headerParameters,
|
|
258
|
+
query: queryParameters,
|
|
259
|
+
body: EStatementReportRequestToJSON(requestParameters['eStatementReportRequest']),
|
|
260
|
+
};
|
|
261
|
+
}
|
|
262
|
+
/**
|
|
263
|
+
* Retrieves opt-in preferences for all accounts associated with a specified customer. Supports filtering by account type.
|
|
264
|
+
* API to fetch the opt-in data
|
|
265
|
+
*/
|
|
266
|
+
async getEstatementsReportRaw(requestParameters, initOverrides) {
|
|
267
|
+
const requestOptions = await this.getEstatementsReportRequestOpts(requestParameters);
|
|
268
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
269
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => EStatementReportResponseFromJSON(jsonValue));
|
|
270
|
+
}
|
|
271
|
+
/**
|
|
272
|
+
* Retrieves opt-in preferences for all accounts associated with a specified customer. Supports filtering by account type.
|
|
273
|
+
* API to fetch the opt-in data
|
|
274
|
+
*/
|
|
275
|
+
async getEstatementsReport(requestParameters, initOverrides) {
|
|
276
|
+
const response = await this.getEstatementsReportRaw(requestParameters, initOverrides);
|
|
277
|
+
return await response.value();
|
|
278
|
+
}
|
|
279
|
+
/**
|
|
280
|
+
* Creates request options for listInstitutionDisclosures without sending the request
|
|
281
|
+
*/
|
|
282
|
+
async listInstitutionDisclosuresRequestOpts() {
|
|
283
|
+
const queryParameters = {};
|
|
284
|
+
const headerParameters = {};
|
|
285
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
286
|
+
const token = this.configuration.accessToken;
|
|
287
|
+
const tokenString = await token("BearerAuth", []);
|
|
288
|
+
if (tokenString) {
|
|
289
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
290
|
+
}
|
|
291
|
+
}
|
|
292
|
+
let urlPath = `/db-disclosures/v1/institution-disclosures`;
|
|
293
|
+
return {
|
|
294
|
+
path: urlPath,
|
|
295
|
+
method: 'GET',
|
|
296
|
+
headers: headerParameters,
|
|
297
|
+
query: queryParameters,
|
|
298
|
+
};
|
|
299
|
+
}
|
|
300
|
+
/**
|
|
301
|
+
* Retrieves all disclosures configured for the financial institution. Returns all disclosure definitions regardless of their enabled/disabled status. Use this endpoint to display available disclosures to users or to audit the institution\'s disclosure configuration.
|
|
302
|
+
* List institution disclosures
|
|
303
|
+
*/
|
|
304
|
+
async listInstitutionDisclosuresRaw(initOverrides) {
|
|
305
|
+
const requestOptions = await this.listInstitutionDisclosuresRequestOpts();
|
|
306
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
307
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => InstitutionDisclosuresFromJSON(jsonValue));
|
|
308
|
+
}
|
|
309
|
+
/**
|
|
310
|
+
* Retrieves all disclosures configured for the financial institution. Returns all disclosure definitions regardless of their enabled/disabled status. Use this endpoint to display available disclosures to users or to audit the institution\'s disclosure configuration.
|
|
311
|
+
* List institution disclosures
|
|
312
|
+
*/
|
|
313
|
+
async listInstitutionDisclosures(initOverrides) {
|
|
314
|
+
const response = await this.listInstitutionDisclosuresRaw(initOverrides);
|
|
315
|
+
return await response.value();
|
|
316
|
+
}
|
|
317
|
+
/**
|
|
318
|
+
* Creates request options for listUserDisclosures without sending the request
|
|
319
|
+
*/
|
|
320
|
+
async listUserDisclosuresRequestOpts(requestParameters) {
|
|
321
|
+
const queryParameters = {};
|
|
322
|
+
if (requestParameters['hostUserId'] != null) {
|
|
323
|
+
queryParameters['hostUserId'] = requestParameters['hostUserId'];
|
|
324
|
+
}
|
|
325
|
+
if (requestParameters['loginId'] != null) {
|
|
326
|
+
queryParameters['loginId'] = requestParameters['loginId'];
|
|
327
|
+
}
|
|
328
|
+
if (requestParameters['institutionCustomerId'] != null) {
|
|
329
|
+
queryParameters['institutionCustomerId'] = requestParameters['institutionCustomerId'];
|
|
330
|
+
}
|
|
331
|
+
const headerParameters = {};
|
|
332
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
333
|
+
const token = this.configuration.accessToken;
|
|
334
|
+
const tokenString = await token("BearerAuth", []);
|
|
335
|
+
if (tokenString) {
|
|
336
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
337
|
+
}
|
|
338
|
+
}
|
|
339
|
+
let urlPath = `/db-disclosures/v1/institution-user-disclosures`;
|
|
340
|
+
return {
|
|
341
|
+
path: urlPath,
|
|
342
|
+
method: 'GET',
|
|
343
|
+
headers: headerParameters,
|
|
344
|
+
query: queryParameters,
|
|
345
|
+
};
|
|
346
|
+
}
|
|
347
|
+
/**
|
|
348
|
+
* Retrieves all disclosure acceptance records for the authenticated user. Returns the status of each disclosure (ACCEPTED, NOT_ACCEPTED, ENROLLED, NOT_ENROLLED) along with the acceptance/rejection timestamp. For Business Banking users, the `institutionCustomerId` query parameter is required to specify the customer context.
|
|
349
|
+
* List user disclosures
|
|
350
|
+
*/
|
|
351
|
+
async listUserDisclosuresRaw(requestParameters, initOverrides) {
|
|
352
|
+
const requestOptions = await this.listUserDisclosuresRequestOpts(requestParameters);
|
|
353
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
354
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => InstitutionUserDisclosuresFromJSON(jsonValue));
|
|
355
|
+
}
|
|
356
|
+
/**
|
|
357
|
+
* Retrieves all disclosure acceptance records for the authenticated user. Returns the status of each disclosure (ACCEPTED, NOT_ACCEPTED, ENROLLED, NOT_ENROLLED) along with the acceptance/rejection timestamp. For Business Banking users, the `institutionCustomerId` query parameter is required to specify the customer context.
|
|
358
|
+
* List user disclosures
|
|
359
|
+
*/
|
|
360
|
+
async listUserDisclosures(requestParameters = {}, initOverrides) {
|
|
361
|
+
const response = await this.listUserDisclosuresRaw(requestParameters, initOverrides);
|
|
362
|
+
return await response.value();
|
|
363
|
+
}
|
|
364
|
+
/**
|
|
365
|
+
* Creates request options for updateEStatementPreferences without sending the request
|
|
366
|
+
*/
|
|
367
|
+
async updateEStatementPreferencesRequestOpts(requestParameters) {
|
|
368
|
+
if (requestParameters['eStatementPreferencesRequest'] == null) {
|
|
369
|
+
throw new runtime.RequiredError('eStatementPreferencesRequest', 'Required parameter "eStatementPreferencesRequest" was null or undefined when calling updateEStatementPreferences().');
|
|
370
|
+
}
|
|
371
|
+
const queryParameters = {};
|
|
372
|
+
if (requestParameters['hostUserId'] != null) {
|
|
373
|
+
queryParameters['hostUserId'] = requestParameters['hostUserId'];
|
|
374
|
+
}
|
|
375
|
+
if (requestParameters['loginId'] != null) {
|
|
376
|
+
queryParameters['loginId'] = requestParameters['loginId'];
|
|
377
|
+
}
|
|
378
|
+
const headerParameters = {};
|
|
379
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
380
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
381
|
+
const token = this.configuration.accessToken;
|
|
382
|
+
const tokenString = await token("BearerAuth", []);
|
|
383
|
+
if (tokenString) {
|
|
384
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
385
|
+
}
|
|
386
|
+
}
|
|
387
|
+
let urlPath = `/ux-users/v2/e-statements/user/preferences`;
|
|
388
|
+
return {
|
|
389
|
+
path: urlPath,
|
|
390
|
+
method: 'PUT',
|
|
391
|
+
headers: headerParameters,
|
|
392
|
+
query: queryParameters,
|
|
393
|
+
body: EStatementPreferencesRequestToJSON(requestParameters['eStatementPreferencesRequest']),
|
|
394
|
+
};
|
|
395
|
+
}
|
|
396
|
+
/**
|
|
397
|
+
* ### Before you call - **MultiStatement** — This API is available only when the **MultiStatement** feature configured to `false` for the financial institution during the onboarding process. - **Disclosure** — The preference applies only where the applicable e-statement disclosure has been approved for the user. - **Access token** — Obtain a **V2** OAuth 2.0 access token by calling **`POST /oauth2/v1/token`** (Authentication API — **Create V2 access token**). Grant types, required headers (for example `institutionId`, `transactionid`), and form body are defined in that operation. Then pass the token in the `Authorization` header as `Bearer <access_token>`. For full details, see the [Authentication API reference](/api/generated/authentication/). ### Behavior Enables users to apply a unified statement delivery preference (online or mail) to **all** of their accounts.
|
|
398
|
+
* Update user e-statement preferences
|
|
399
|
+
*/
|
|
400
|
+
async updateEStatementPreferencesRaw(requestParameters, initOverrides) {
|
|
401
|
+
const requestOptions = await this.updateEStatementPreferencesRequestOpts(requestParameters);
|
|
402
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
403
|
+
return new runtime.VoidApiResponse(response);
|
|
404
|
+
}
|
|
405
|
+
/**
|
|
406
|
+
* ### Before you call - **MultiStatement** — This API is available only when the **MultiStatement** feature configured to `false` for the financial institution during the onboarding process. - **Disclosure** — The preference applies only where the applicable e-statement disclosure has been approved for the user. - **Access token** — Obtain a **V2** OAuth 2.0 access token by calling **`POST /oauth2/v1/token`** (Authentication API — **Create V2 access token**). Grant types, required headers (for example `institutionId`, `transactionid`), and form body are defined in that operation. Then pass the token in the `Authorization` header as `Bearer <access_token>`. For full details, see the [Authentication API reference](/api/generated/authentication/). ### Behavior Enables users to apply a unified statement delivery preference (online or mail) to **all** of their accounts.
|
|
407
|
+
* Update user e-statement preferences
|
|
408
|
+
*/
|
|
409
|
+
async updateEStatementPreferences(requestParameters, initOverrides) {
|
|
410
|
+
await this.updateEStatementPreferencesRaw(requestParameters, initOverrides);
|
|
411
|
+
}
|
|
412
|
+
/**
|
|
413
|
+
* Creates request options for updateInstitutionDisclosure without sending the request
|
|
414
|
+
*/
|
|
415
|
+
async updateInstitutionDisclosureRequestOpts(requestParameters) {
|
|
416
|
+
if (requestParameters['institutionDisclosureId'] == null) {
|
|
417
|
+
throw new runtime.RequiredError('institutionDisclosureId', 'Required parameter "institutionDisclosureId" was null or undefined when calling updateInstitutionDisclosure().');
|
|
418
|
+
}
|
|
419
|
+
if (requestParameters['institutionDisclosure'] == null) {
|
|
420
|
+
throw new runtime.RequiredError('institutionDisclosure', 'Required parameter "institutionDisclosure" was null or undefined when calling updateInstitutionDisclosure().');
|
|
421
|
+
}
|
|
422
|
+
const queryParameters = {};
|
|
423
|
+
const headerParameters = {};
|
|
424
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
425
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
426
|
+
const token = this.configuration.accessToken;
|
|
427
|
+
const tokenString = await token("BearerAuth", []);
|
|
428
|
+
if (tokenString) {
|
|
429
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
430
|
+
}
|
|
431
|
+
}
|
|
432
|
+
let urlPath = `/db-disclosures/v1/institution-disclosures/{institutionDisclosureId}`;
|
|
433
|
+
urlPath = urlPath.replace(`{${"institutionDisclosureId"}}`, encodeURIComponent(String(requestParameters['institutionDisclosureId'])));
|
|
434
|
+
return {
|
|
435
|
+
path: urlPath,
|
|
436
|
+
method: 'PUT',
|
|
437
|
+
headers: headerParameters,
|
|
438
|
+
query: queryParameters,
|
|
439
|
+
body: InstitutionDisclosureToJSON(requestParameters['institutionDisclosure']),
|
|
440
|
+
};
|
|
441
|
+
}
|
|
442
|
+
/**
|
|
443
|
+
* Updates an existing institution disclosure definition. Use this to modify disclosure content, change the data type, or enable/disable the disclosure. **Scope Required:** `disclosures:write` **Note:** The disclosure ID in the URL must match the ID in the request body.
|
|
444
|
+
* Update institution disclosure
|
|
445
|
+
*/
|
|
446
|
+
async updateInstitutionDisclosureRaw(requestParameters, initOverrides) {
|
|
447
|
+
const requestOptions = await this.updateInstitutionDisclosureRequestOpts(requestParameters);
|
|
448
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
449
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => InstitutionDisclosureFromJSON(jsonValue));
|
|
450
|
+
}
|
|
451
|
+
/**
|
|
452
|
+
* Updates an existing institution disclosure definition. Use this to modify disclosure content, change the data type, or enable/disable the disclosure. **Scope Required:** `disclosures:write` **Note:** The disclosure ID in the URL must match the ID in the request body.
|
|
453
|
+
* Update institution disclosure
|
|
454
|
+
*/
|
|
455
|
+
async updateInstitutionDisclosure(requestParameters, initOverrides) {
|
|
456
|
+
const response = await this.updateInstitutionDisclosureRaw(requestParameters, initOverrides);
|
|
457
|
+
return await response.value();
|
|
458
|
+
}
|
|
459
|
+
/**
|
|
460
|
+
* Creates request options for updateStatementDeliveryPreference without sending the request
|
|
461
|
+
*/
|
|
462
|
+
async updateStatementDeliveryPreferenceRequestOpts(requestParameters) {
|
|
463
|
+
if (requestParameters['eStatementRequest'] == null) {
|
|
464
|
+
throw new runtime.RequiredError('eStatementRequest', 'Required parameter "eStatementRequest" was null or undefined when calling updateStatementDeliveryPreference().');
|
|
465
|
+
}
|
|
466
|
+
const queryParameters = {};
|
|
467
|
+
if (requestParameters['hostUserId'] != null) {
|
|
468
|
+
queryParameters['hostUserId'] = requestParameters['hostUserId'];
|
|
469
|
+
}
|
|
470
|
+
if (requestParameters['loginId'] != null) {
|
|
471
|
+
queryParameters['loginId'] = requestParameters['loginId'];
|
|
472
|
+
}
|
|
473
|
+
const headerParameters = {};
|
|
474
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
475
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
476
|
+
const token = this.configuration.accessToken;
|
|
477
|
+
const tokenString = await token("BearerAuth", []);
|
|
478
|
+
if (tokenString) {
|
|
479
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
480
|
+
}
|
|
481
|
+
}
|
|
482
|
+
let urlPath = `/ux-users/v1/e-statements/preference`;
|
|
483
|
+
return {
|
|
484
|
+
path: urlPath,
|
|
485
|
+
method: 'PUT',
|
|
486
|
+
headers: headerParameters,
|
|
487
|
+
query: queryParameters,
|
|
488
|
+
body: EStatementRequestToJSON(requestParameters['eStatementRequest']),
|
|
489
|
+
};
|
|
490
|
+
}
|
|
491
|
+
/**
|
|
492
|
+
* ### Before you call - **MultiStatement** — This API is available only when **MultiStatement** is configured **`true`** for the financial institution during the onboarding process (account-level statement preference). - **Disclosure** — The preference applies only when the required e-statement disclosure agreement exists for the **account** in the request (for example Multi-OLS where configured). If no disclosure is available for that account, the call may fail (for example **404**). - **Access token** — Obtain a **V2** OAuth 2.0 access token by calling **`POST /oauth2/v1/token`** (Authentication API — **Create V2 access token**). Grant types, required headers (for example `institutionId`, `transactionid`), and form body are defined on that operation. Send the token in the `Authorization` header as `Bearer <access_token>`. See the [Authentication API reference](/api/generated/authentication/). ### Behavior Updates whether account statements are delivered electronically or by mail for a **single** account. This preference is set per account, not for all accounts at once.
|
|
493
|
+
* Update account e-statement preference
|
|
494
|
+
*/
|
|
495
|
+
async updateStatementDeliveryPreferenceRaw(requestParameters, initOverrides) {
|
|
496
|
+
const requestOptions = await this.updateStatementDeliveryPreferenceRequestOpts(requestParameters);
|
|
497
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
498
|
+
return new runtime.VoidApiResponse(response);
|
|
499
|
+
}
|
|
500
|
+
/**
|
|
501
|
+
* ### Before you call - **MultiStatement** — This API is available only when **MultiStatement** is configured **`true`** for the financial institution during the onboarding process (account-level statement preference). - **Disclosure** — The preference applies only when the required e-statement disclosure agreement exists for the **account** in the request (for example Multi-OLS where configured). If no disclosure is available for that account, the call may fail (for example **404**). - **Access token** — Obtain a **V2** OAuth 2.0 access token by calling **`POST /oauth2/v1/token`** (Authentication API — **Create V2 access token**). Grant types, required headers (for example `institutionId`, `transactionid`), and form body are defined on that operation. Send the token in the `Authorization` header as `Bearer <access_token>`. See the [Authentication API reference](/api/generated/authentication/). ### Behavior Updates whether account statements are delivered electronically or by mail for a **single** account. This preference is set per account, not for all accounts at once.
|
|
502
|
+
* Update account e-statement preference
|
|
503
|
+
*/
|
|
504
|
+
async updateStatementDeliveryPreference(requestParameters, initOverrides) {
|
|
505
|
+
await this.updateStatementDeliveryPreferenceRaw(requestParameters, initOverrides);
|
|
506
|
+
}
|
|
507
|
+
/**
|
|
508
|
+
* Creates request options for updateUserDisclosure without sending the request
|
|
509
|
+
*/
|
|
510
|
+
async updateUserDisclosureRequestOpts(requestParameters) {
|
|
511
|
+
const queryParameters = {};
|
|
512
|
+
if (requestParameters['hostUserId'] != null) {
|
|
513
|
+
queryParameters['hostUserId'] = requestParameters['hostUserId'];
|
|
514
|
+
}
|
|
515
|
+
if (requestParameters['loginId'] != null) {
|
|
516
|
+
queryParameters['loginId'] = requestParameters['loginId'];
|
|
517
|
+
}
|
|
518
|
+
if (requestParameters['institutionCustomerId'] != null) {
|
|
519
|
+
queryParameters['institutionCustomerId'] = requestParameters['institutionCustomerId'];
|
|
520
|
+
}
|
|
521
|
+
const headerParameters = {};
|
|
522
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
523
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
524
|
+
const token = this.configuration.accessToken;
|
|
525
|
+
const tokenString = await token("BearerAuth", []);
|
|
526
|
+
if (tokenString) {
|
|
527
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
528
|
+
}
|
|
529
|
+
}
|
|
530
|
+
let urlPath = `/db-disclosures/v1/institution-user-disclosures`;
|
|
531
|
+
return {
|
|
532
|
+
path: urlPath,
|
|
533
|
+
method: 'PUT',
|
|
534
|
+
headers: headerParameters,
|
|
535
|
+
query: queryParameters,
|
|
536
|
+
body: InstitutionUserDisclosureToJSON(requestParameters['institutionUserDisclosure']),
|
|
537
|
+
};
|
|
538
|
+
}
|
|
539
|
+
/**
|
|
540
|
+
* Updates an existing user disclosure record. Use this to change the user\'s acceptance status for a disclosure (e.g., from NOT_ACCEPTED to ACCEPTED). **Scope Required:** `disclosures:write` For Business Banking users, the `institutionCustomerId` query parameter is required.
|
|
541
|
+
* Update user disclosure for a custom disclosure
|
|
542
|
+
*/
|
|
543
|
+
async updateUserDisclosureRaw(requestParameters, initOverrides) {
|
|
544
|
+
const requestOptions = await this.updateUserDisclosureRequestOpts(requestParameters);
|
|
545
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
546
|
+
return new runtime.VoidApiResponse(response);
|
|
547
|
+
}
|
|
548
|
+
/**
|
|
549
|
+
* Updates an existing user disclosure record. Use this to change the user\'s acceptance status for a disclosure (e.g., from NOT_ACCEPTED to ACCEPTED). **Scope Required:** `disclosures:write` For Business Banking users, the `institutionCustomerId` query parameter is required.
|
|
550
|
+
* Update user disclosure for a custom disclosure
|
|
551
|
+
*/
|
|
552
|
+
async updateUserDisclosure(requestParameters = {}, initOverrides) {
|
|
553
|
+
await this.updateUserDisclosureRaw(requestParameters, initOverrides);
|
|
554
|
+
}
|
|
555
|
+
}
|