@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,25 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Candescent DI API
|
|
3
|
+
* Welcome to the **Candescent Digital Insight API** documentation. This comprehensive API platform enables financial institutions, Marketplace Partners, and developers to build powerful digital banking experiences. ## Getting Started New to the Candescent API? Start here: - **[Quick Start Guide](/guides/getting-started/quickstart/)** - Make your first API call in minutes - **[API Categories Overview](/guides/getting-started/api-overview/)** - Explore all available API categories - **[Error Codes Reference](/guides/getting-started/error-codes/)** - Handle errors effectively ## API Categories | Category | Description | |----------|-------------| | **[Accounts](/api/generated/accounts/)** | Account information, transactions, and banking images | | **[Alert Configuration](/api/generated/alert-configuration/)** | Alert types and templates | | **[Alert Delivery](/api/generated/alert-delivery/)** | Alert delivery history | | **[Alert Preferences](/api/generated/alert-preferences/)** | End-user notification preferences | | **[Authentication](/api/generated/authentication/)** | OAuth 2.0 token management and authorization | | **[Business Banking](/api/generated/business-banking/)** | Business banking services | | **[Customer Campaigns](/api/generated/customer-campaigns/)** | User segmentation and promotions | | **[Customer Management](/api/generated/customer-management/)** | Customer profiles, registration, and self-service | | **[Documents and Preferences](/api/generated/documents-and-preferences/)** | Disclosures and e-statement preferences | | **[Money Movement](/api/generated/money-movement/)** | Recipients and fund transfers | | **[MX](/api/generated/mx/)** | Account aggregation and financial insights | | **[Notification Channels](/api/generated/notification-channels/)** | Notification channels for alert delivery | ## Base URLs | Environment | Base URL | |-------------|----------| | Stage | `https://api.candescent.com/digitalbanking/stage` | | Production | `https://api.candescent.com/digitalbanking` | > **Note:** This documentation primarily references the **Stage** environment for examples. ## Authentication Overview Candescent APIs use OAuth 2.0 with JWT Bearer tokens. Follow these steps: ### Step 1: Obtain Client Credentials Get your `Client ID` and `Client Secret` from the Candescent Developer Console. ### Step 2: Generate an Access Token ```bash curl -X POST \'https://api.candescent.com/digitalbanking/stage/oauth2/v1/token\' \\ -H \'Authorization: Basic <BASE64_ENCODED(CLIENT_ID:CLIENT_SECRET)>\' \\ -H \'Content-Type: application/x-www-form-urlencoded\' \\ -H \'transactionid: <YOUR_UNIQUE_UUID>\' \\ -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\ -d \'grant_type=client_credentials\' ``` ### Step 3: Make Authenticated Requests Include the token in the `Authorization` header: ```bash curl \'https://api.candescent.com/digitalbanking/stage/accounts/v1/accounts\' \\ -H \'Authorization: Bearer <YOUR_ACCESS_TOKEN>\' \\ -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\ -H \'transactionid: <YOUR_UNIQUE_UUID>\' ``` > **Tip:** Access tokens expire in ~1 hour. Implement token refresh logic for uninterrupted access. For detailed authentication flows, see the **[Authentication API Reference](/api/generated/authentication/)**.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.4.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
*
|
|
14
|
+
* @export
|
|
15
|
+
*/
|
|
16
|
+
export declare const TransferStatus: {
|
|
17
|
+
readonly SUCCESS: "SUCCESS";
|
|
18
|
+
readonly ERROR: "ERROR";
|
|
19
|
+
};
|
|
20
|
+
export type TransferStatus = typeof TransferStatus[keyof typeof TransferStatus];
|
|
21
|
+
export declare function instanceOfTransferStatus(value: any): boolean;
|
|
22
|
+
export declare function TransferStatusFromJSON(json: any): TransferStatus;
|
|
23
|
+
export declare function TransferStatusFromJSONTyped(json: any, ignoreDiscriminator: boolean): TransferStatus;
|
|
24
|
+
export declare function TransferStatusToJSON(value?: TransferStatus | null): any;
|
|
25
|
+
export declare function TransferStatusToJSONTyped(value: any, ignoreDiscriminator: boolean): TransferStatus;
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Candescent DI API
|
|
5
|
+
* Welcome to the **Candescent Digital Insight API** documentation. This comprehensive API platform enables financial institutions, Marketplace Partners, and developers to build powerful digital banking experiences. ## Getting Started New to the Candescent API? Start here: - **[Quick Start Guide](/guides/getting-started/quickstart/)** - Make your first API call in minutes - **[API Categories Overview](/guides/getting-started/api-overview/)** - Explore all available API categories - **[Error Codes Reference](/guides/getting-started/error-codes/)** - Handle errors effectively ## API Categories | Category | Description | |----------|-------------| | **[Accounts](/api/generated/accounts/)** | Account information, transactions, and banking images | | **[Alert Configuration](/api/generated/alert-configuration/)** | Alert types and templates | | **[Alert Delivery](/api/generated/alert-delivery/)** | Alert delivery history | | **[Alert Preferences](/api/generated/alert-preferences/)** | End-user notification preferences | | **[Authentication](/api/generated/authentication/)** | OAuth 2.0 token management and authorization | | **[Business Banking](/api/generated/business-banking/)** | Business banking services | | **[Customer Campaigns](/api/generated/customer-campaigns/)** | User segmentation and promotions | | **[Customer Management](/api/generated/customer-management/)** | Customer profiles, registration, and self-service | | **[Documents and Preferences](/api/generated/documents-and-preferences/)** | Disclosures and e-statement preferences | | **[Money Movement](/api/generated/money-movement/)** | Recipients and fund transfers | | **[MX](/api/generated/mx/)** | Account aggregation and financial insights | | **[Notification Channels](/api/generated/notification-channels/)** | Notification channels for alert delivery | ## Base URLs | Environment | Base URL | |-------------|----------| | Stage | `https://api.candescent.com/digitalbanking/stage` | | Production | `https://api.candescent.com/digitalbanking` | > **Note:** This documentation primarily references the **Stage** environment for examples. ## Authentication Overview Candescent APIs use OAuth 2.0 with JWT Bearer tokens. Follow these steps: ### Step 1: Obtain Client Credentials Get your `Client ID` and `Client Secret` from the Candescent Developer Console. ### Step 2: Generate an Access Token ```bash curl -X POST \'https://api.candescent.com/digitalbanking/stage/oauth2/v1/token\' \\ -H \'Authorization: Basic <BASE64_ENCODED(CLIENT_ID:CLIENT_SECRET)>\' \\ -H \'Content-Type: application/x-www-form-urlencoded\' \\ -H \'transactionid: <YOUR_UNIQUE_UUID>\' \\ -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\ -d \'grant_type=client_credentials\' ``` ### Step 3: Make Authenticated Requests Include the token in the `Authorization` header: ```bash curl \'https://api.candescent.com/digitalbanking/stage/accounts/v1/accounts\' \\ -H \'Authorization: Bearer <YOUR_ACCESS_TOKEN>\' \\ -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\ -H \'transactionid: <YOUR_UNIQUE_UUID>\' ``` > **Tip:** Access tokens expire in ~1 hour. Implement token refresh logic for uninterrupted access. For detailed authentication flows, see the **[Authentication API Reference](/api/generated/authentication/)**.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.4.0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
/**
|
|
15
|
+
*
|
|
16
|
+
* @export
|
|
17
|
+
*/
|
|
18
|
+
export const TransferStatus = {
|
|
19
|
+
SUCCESS: 'SUCCESS',
|
|
20
|
+
ERROR: 'ERROR'
|
|
21
|
+
};
|
|
22
|
+
export function instanceOfTransferStatus(value) {
|
|
23
|
+
for (const key in TransferStatus) {
|
|
24
|
+
if (Object.prototype.hasOwnProperty.call(TransferStatus, key)) {
|
|
25
|
+
if (TransferStatus[key] === value) {
|
|
26
|
+
return true;
|
|
27
|
+
}
|
|
28
|
+
}
|
|
29
|
+
}
|
|
30
|
+
return false;
|
|
31
|
+
}
|
|
32
|
+
export function TransferStatusFromJSON(json) {
|
|
33
|
+
return TransferStatusFromJSONTyped(json, false);
|
|
34
|
+
}
|
|
35
|
+
export function TransferStatusFromJSONTyped(json, ignoreDiscriminator) {
|
|
36
|
+
return json;
|
|
37
|
+
}
|
|
38
|
+
export function TransferStatusToJSON(value) {
|
|
39
|
+
return value;
|
|
40
|
+
}
|
|
41
|
+
export function TransferStatusToJSONTyped(value, ignoreDiscriminator) {
|
|
42
|
+
return value;
|
|
43
|
+
}
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Candescent DI API
|
|
3
|
+
* Welcome to the **Candescent Digital Insight API** documentation. This comprehensive API platform enables financial institutions, Marketplace Partners, and developers to build powerful digital banking experiences. ## Getting Started New to the Candescent API? Start here: - **[Quick Start Guide](/guides/getting-started/quickstart/)** - Make your first API call in minutes - **[API Categories Overview](/guides/getting-started/api-overview/)** - Explore all available API categories - **[Error Codes Reference](/guides/getting-started/error-codes/)** - Handle errors effectively ## API Categories | Category | Description | |----------|-------------| | **[Accounts](/api/generated/accounts/)** | Account information, transactions, and banking images | | **[Alert Configuration](/api/generated/alert-configuration/)** | Alert types and templates | | **[Alert Delivery](/api/generated/alert-delivery/)** | Alert delivery history | | **[Alert Preferences](/api/generated/alert-preferences/)** | End-user notification preferences | | **[Authentication](/api/generated/authentication/)** | OAuth 2.0 token management and authorization | | **[Business Banking](/api/generated/business-banking/)** | Business banking services | | **[Customer Campaigns](/api/generated/customer-campaigns/)** | User segmentation and promotions | | **[Customer Management](/api/generated/customer-management/)** | Customer profiles, registration, and self-service | | **[Documents and Preferences](/api/generated/documents-and-preferences/)** | Disclosures and e-statement preferences | | **[Money Movement](/api/generated/money-movement/)** | Recipients and fund transfers | | **[MX](/api/generated/mx/)** | Account aggregation and financial insights | | **[Notification Channels](/api/generated/notification-channels/)** | Notification channels for alert delivery | ## Base URLs | Environment | Base URL | |-------------|----------| | Stage | `https://api.candescent.com/digitalbanking/stage` | | Production | `https://api.candescent.com/digitalbanking` | > **Note:** This documentation primarily references the **Stage** environment for examples. ## Authentication Overview Candescent APIs use OAuth 2.0 with JWT Bearer tokens. Follow these steps: ### Step 1: Obtain Client Credentials Get your `Client ID` and `Client Secret` from the Candescent Developer Console. ### Step 2: Generate an Access Token ```bash curl -X POST \'https://api.candescent.com/digitalbanking/stage/oauth2/v1/token\' \\ -H \'Authorization: Basic <BASE64_ENCODED(CLIENT_ID:CLIENT_SECRET)>\' \\ -H \'Content-Type: application/x-www-form-urlencoded\' \\ -H \'transactionid: <YOUR_UNIQUE_UUID>\' \\ -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\ -d \'grant_type=client_credentials\' ``` ### Step 3: Make Authenticated Requests Include the token in the `Authorization` header: ```bash curl \'https://api.candescent.com/digitalbanking/stage/accounts/v1/accounts\' \\ -H \'Authorization: Bearer <YOUR_ACCESS_TOKEN>\' \\ -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\ -H \'transactionid: <YOUR_UNIQUE_UUID>\' ``` > **Tip:** Access tokens expire in ~1 hour. Implement token refresh logic for uninterrupted access. For detailed authentication flows, see the **[Authentication API Reference](/api/generated/authentication/)**.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.4.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
* Postal address for contact info update
|
|
14
|
+
* @export
|
|
15
|
+
* @interface UpdateContactInfoPostalAddress
|
|
16
|
+
*/
|
|
17
|
+
export interface UpdateContactInfoPostalAddress {
|
|
18
|
+
/**
|
|
19
|
+
*
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof UpdateContactInfoPostalAddress
|
|
22
|
+
*/
|
|
23
|
+
address1?: string;
|
|
24
|
+
/**
|
|
25
|
+
*
|
|
26
|
+
* @type {string}
|
|
27
|
+
* @memberof UpdateContactInfoPostalAddress
|
|
28
|
+
*/
|
|
29
|
+
address2?: string;
|
|
30
|
+
/**
|
|
31
|
+
*
|
|
32
|
+
* @type {string}
|
|
33
|
+
* @memberof UpdateContactInfoPostalAddress
|
|
34
|
+
*/
|
|
35
|
+
city?: string;
|
|
36
|
+
/**
|
|
37
|
+
*
|
|
38
|
+
* @type {string}
|
|
39
|
+
* @memberof UpdateContactInfoPostalAddress
|
|
40
|
+
*/
|
|
41
|
+
state?: string;
|
|
42
|
+
/**
|
|
43
|
+
*
|
|
44
|
+
* @type {string}
|
|
45
|
+
* @memberof UpdateContactInfoPostalAddress
|
|
46
|
+
*/
|
|
47
|
+
postalCode?: string;
|
|
48
|
+
/**
|
|
49
|
+
*
|
|
50
|
+
* @type {string}
|
|
51
|
+
* @memberof UpdateContactInfoPostalAddress
|
|
52
|
+
*/
|
|
53
|
+
country?: string;
|
|
54
|
+
}
|
|
55
|
+
/**
|
|
56
|
+
* Check if a given object implements the UpdateContactInfoPostalAddress interface.
|
|
57
|
+
*/
|
|
58
|
+
export declare function instanceOfUpdateContactInfoPostalAddress(value: object): value is UpdateContactInfoPostalAddress;
|
|
59
|
+
export declare function UpdateContactInfoPostalAddressFromJSON(json: any): UpdateContactInfoPostalAddress;
|
|
60
|
+
export declare function UpdateContactInfoPostalAddressFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateContactInfoPostalAddress;
|
|
61
|
+
export declare function UpdateContactInfoPostalAddressToJSON(json: any): UpdateContactInfoPostalAddress;
|
|
62
|
+
export declare function UpdateContactInfoPostalAddressToJSONTyped(value?: UpdateContactInfoPostalAddress | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Candescent DI API
|
|
5
|
+
* Welcome to the **Candescent Digital Insight API** documentation. This comprehensive API platform enables financial institutions, Marketplace Partners, and developers to build powerful digital banking experiences. ## Getting Started New to the Candescent API? Start here: - **[Quick Start Guide](/guides/getting-started/quickstart/)** - Make your first API call in minutes - **[API Categories Overview](/guides/getting-started/api-overview/)** - Explore all available API categories - **[Error Codes Reference](/guides/getting-started/error-codes/)** - Handle errors effectively ## API Categories | Category | Description | |----------|-------------| | **[Accounts](/api/generated/accounts/)** | Account information, transactions, and banking images | | **[Alert Configuration](/api/generated/alert-configuration/)** | Alert types and templates | | **[Alert Delivery](/api/generated/alert-delivery/)** | Alert delivery history | | **[Alert Preferences](/api/generated/alert-preferences/)** | End-user notification preferences | | **[Authentication](/api/generated/authentication/)** | OAuth 2.0 token management and authorization | | **[Business Banking](/api/generated/business-banking/)** | Business banking services | | **[Customer Campaigns](/api/generated/customer-campaigns/)** | User segmentation and promotions | | **[Customer Management](/api/generated/customer-management/)** | Customer profiles, registration, and self-service | | **[Documents and Preferences](/api/generated/documents-and-preferences/)** | Disclosures and e-statement preferences | | **[Money Movement](/api/generated/money-movement/)** | Recipients and fund transfers | | **[MX](/api/generated/mx/)** | Account aggregation and financial insights | | **[Notification Channels](/api/generated/notification-channels/)** | Notification channels for alert delivery | ## Base URLs | Environment | Base URL | |-------------|----------| | Stage | `https://api.candescent.com/digitalbanking/stage` | | Production | `https://api.candescent.com/digitalbanking` | > **Note:** This documentation primarily references the **Stage** environment for examples. ## Authentication Overview Candescent APIs use OAuth 2.0 with JWT Bearer tokens. Follow these steps: ### Step 1: Obtain Client Credentials Get your `Client ID` and `Client Secret` from the Candescent Developer Console. ### Step 2: Generate an Access Token ```bash curl -X POST \'https://api.candescent.com/digitalbanking/stage/oauth2/v1/token\' \\ -H \'Authorization: Basic <BASE64_ENCODED(CLIENT_ID:CLIENT_SECRET)>\' \\ -H \'Content-Type: application/x-www-form-urlencoded\' \\ -H \'transactionid: <YOUR_UNIQUE_UUID>\' \\ -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\ -d \'grant_type=client_credentials\' ``` ### Step 3: Make Authenticated Requests Include the token in the `Authorization` header: ```bash curl \'https://api.candescent.com/digitalbanking/stage/accounts/v1/accounts\' \\ -H \'Authorization: Bearer <YOUR_ACCESS_TOKEN>\' \\ -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\ -H \'transactionid: <YOUR_UNIQUE_UUID>\' ``` > **Tip:** Access tokens expire in ~1 hour. Implement token refresh logic for uninterrupted access. For detailed authentication flows, see the **[Authentication API Reference](/api/generated/authentication/)**.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.4.0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
/**
|
|
15
|
+
* Check if a given object implements the UpdateContactInfoPostalAddress interface.
|
|
16
|
+
*/
|
|
17
|
+
export function instanceOfUpdateContactInfoPostalAddress(value) {
|
|
18
|
+
return true;
|
|
19
|
+
}
|
|
20
|
+
export function UpdateContactInfoPostalAddressFromJSON(json) {
|
|
21
|
+
return UpdateContactInfoPostalAddressFromJSONTyped(json, false);
|
|
22
|
+
}
|
|
23
|
+
export function UpdateContactInfoPostalAddressFromJSONTyped(json, ignoreDiscriminator) {
|
|
24
|
+
if (json == null) {
|
|
25
|
+
return json;
|
|
26
|
+
}
|
|
27
|
+
return {
|
|
28
|
+
'address1': json['address1'] == null ? undefined : json['address1'],
|
|
29
|
+
'address2': json['address2'] == null ? undefined : json['address2'],
|
|
30
|
+
'city': json['city'] == null ? undefined : json['city'],
|
|
31
|
+
'state': json['state'] == null ? undefined : json['state'],
|
|
32
|
+
'postalCode': json['postalCode'] == null ? undefined : json['postalCode'],
|
|
33
|
+
'country': json['country'] == null ? undefined : json['country'],
|
|
34
|
+
};
|
|
35
|
+
}
|
|
36
|
+
export function UpdateContactInfoPostalAddressToJSON(json) {
|
|
37
|
+
return UpdateContactInfoPostalAddressToJSONTyped(json, false);
|
|
38
|
+
}
|
|
39
|
+
export function UpdateContactInfoPostalAddressToJSONTyped(value, ignoreDiscriminator = false) {
|
|
40
|
+
if (value == null) {
|
|
41
|
+
return value;
|
|
42
|
+
}
|
|
43
|
+
return {
|
|
44
|
+
'address1': value['address1'],
|
|
45
|
+
'address2': value['address2'],
|
|
46
|
+
'city': value['city'],
|
|
47
|
+
'state': value['state'],
|
|
48
|
+
'postalCode': value['postalCode'],
|
|
49
|
+
'country': value['country'],
|
|
50
|
+
};
|
|
51
|
+
}
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Candescent DI API
|
|
3
|
+
* Welcome to the **Candescent Digital Insight API** documentation. This comprehensive API platform enables financial institutions, Marketplace Partners, and developers to build powerful digital banking experiences. ## Getting Started New to the Candescent API? Start here: - **[Quick Start Guide](/guides/getting-started/quickstart/)** - Make your first API call in minutes - **[API Categories Overview](/guides/getting-started/api-overview/)** - Explore all available API categories - **[Error Codes Reference](/guides/getting-started/error-codes/)** - Handle errors effectively ## API Categories | Category | Description | |----------|-------------| | **[Accounts](/api/generated/accounts/)** | Account information, transactions, and banking images | | **[Alert Configuration](/api/generated/alert-configuration/)** | Alert types and templates | | **[Alert Delivery](/api/generated/alert-delivery/)** | Alert delivery history | | **[Alert Preferences](/api/generated/alert-preferences/)** | End-user notification preferences | | **[Authentication](/api/generated/authentication/)** | OAuth 2.0 token management and authorization | | **[Business Banking](/api/generated/business-banking/)** | Business banking services | | **[Customer Campaigns](/api/generated/customer-campaigns/)** | User segmentation and promotions | | **[Customer Management](/api/generated/customer-management/)** | Customer profiles, registration, and self-service | | **[Documents and Preferences](/api/generated/documents-and-preferences/)** | Disclosures and e-statement preferences | | **[Money Movement](/api/generated/money-movement/)** | Recipients and fund transfers | | **[MX](/api/generated/mx/)** | Account aggregation and financial insights | | **[Notification Channels](/api/generated/notification-channels/)** | Notification channels for alert delivery | ## Base URLs | Environment | Base URL | |-------------|----------| | Stage | `https://api.candescent.com/digitalbanking/stage` | | Production | `https://api.candescent.com/digitalbanking` | > **Note:** This documentation primarily references the **Stage** environment for examples. ## Authentication Overview Candescent APIs use OAuth 2.0 with JWT Bearer tokens. Follow these steps: ### Step 1: Obtain Client Credentials Get your `Client ID` and `Client Secret` from the Candescent Developer Console. ### Step 2: Generate an Access Token ```bash curl -X POST \'https://api.candescent.com/digitalbanking/stage/oauth2/v1/token\' \\ -H \'Authorization: Basic <BASE64_ENCODED(CLIENT_ID:CLIENT_SECRET)>\' \\ -H \'Content-Type: application/x-www-form-urlencoded\' \\ -H \'transactionid: <YOUR_UNIQUE_UUID>\' \\ -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\ -d \'grant_type=client_credentials\' ``` ### Step 3: Make Authenticated Requests Include the token in the `Authorization` header: ```bash curl \'https://api.candescent.com/digitalbanking/stage/accounts/v1/accounts\' \\ -H \'Authorization: Bearer <YOUR_ACCESS_TOKEN>\' \\ -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\ -H \'transactionid: <YOUR_UNIQUE_UUID>\' ``` > **Tip:** Access tokens expire in ~1 hour. Implement token refresh logic for uninterrupted access. For detailed authentication flows, see the **[Authentication API Reference](/api/generated/authentication/)**.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.4.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
*
|
|
14
|
+
* @export
|
|
15
|
+
* @interface UploadResponse
|
|
16
|
+
*/
|
|
17
|
+
export interface UploadResponse {
|
|
18
|
+
/**
|
|
19
|
+
*
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof UploadResponse
|
|
22
|
+
*/
|
|
23
|
+
jobId?: string;
|
|
24
|
+
}
|
|
25
|
+
/**
|
|
26
|
+
* Check if a given object implements the UploadResponse interface.
|
|
27
|
+
*/
|
|
28
|
+
export declare function instanceOfUploadResponse(value: object): value is UploadResponse;
|
|
29
|
+
export declare function UploadResponseFromJSON(json: any): UploadResponse;
|
|
30
|
+
export declare function UploadResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): UploadResponse;
|
|
31
|
+
export declare function UploadResponseToJSON(json: any): UploadResponse;
|
|
32
|
+
export declare function UploadResponseToJSONTyped(value?: UploadResponse | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Candescent DI API
|
|
5
|
+
* Welcome to the **Candescent Digital Insight API** documentation. This comprehensive API platform enables financial institutions, Marketplace Partners, and developers to build powerful digital banking experiences. ## Getting Started New to the Candescent API? Start here: - **[Quick Start Guide](/guides/getting-started/quickstart/)** - Make your first API call in minutes - **[API Categories Overview](/guides/getting-started/api-overview/)** - Explore all available API categories - **[Error Codes Reference](/guides/getting-started/error-codes/)** - Handle errors effectively ## API Categories | Category | Description | |----------|-------------| | **[Accounts](/api/generated/accounts/)** | Account information, transactions, and banking images | | **[Alert Configuration](/api/generated/alert-configuration/)** | Alert types and templates | | **[Alert Delivery](/api/generated/alert-delivery/)** | Alert delivery history | | **[Alert Preferences](/api/generated/alert-preferences/)** | End-user notification preferences | | **[Authentication](/api/generated/authentication/)** | OAuth 2.0 token management and authorization | | **[Business Banking](/api/generated/business-banking/)** | Business banking services | | **[Customer Campaigns](/api/generated/customer-campaigns/)** | User segmentation and promotions | | **[Customer Management](/api/generated/customer-management/)** | Customer profiles, registration, and self-service | | **[Documents and Preferences](/api/generated/documents-and-preferences/)** | Disclosures and e-statement preferences | | **[Money Movement](/api/generated/money-movement/)** | Recipients and fund transfers | | **[MX](/api/generated/mx/)** | Account aggregation and financial insights | | **[Notification Channels](/api/generated/notification-channels/)** | Notification channels for alert delivery | ## Base URLs | Environment | Base URL | |-------------|----------| | Stage | `https://api.candescent.com/digitalbanking/stage` | | Production | `https://api.candescent.com/digitalbanking` | > **Note:** This documentation primarily references the **Stage** environment for examples. ## Authentication Overview Candescent APIs use OAuth 2.0 with JWT Bearer tokens. Follow these steps: ### Step 1: Obtain Client Credentials Get your `Client ID` and `Client Secret` from the Candescent Developer Console. ### Step 2: Generate an Access Token ```bash curl -X POST \'https://api.candescent.com/digitalbanking/stage/oauth2/v1/token\' \\ -H \'Authorization: Basic <BASE64_ENCODED(CLIENT_ID:CLIENT_SECRET)>\' \\ -H \'Content-Type: application/x-www-form-urlencoded\' \\ -H \'transactionid: <YOUR_UNIQUE_UUID>\' \\ -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\ -d \'grant_type=client_credentials\' ``` ### Step 3: Make Authenticated Requests Include the token in the `Authorization` header: ```bash curl \'https://api.candescent.com/digitalbanking/stage/accounts/v1/accounts\' \\ -H \'Authorization: Bearer <YOUR_ACCESS_TOKEN>\' \\ -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\ -H \'transactionid: <YOUR_UNIQUE_UUID>\' ``` > **Tip:** Access tokens expire in ~1 hour. Implement token refresh logic for uninterrupted access. For detailed authentication flows, see the **[Authentication API Reference](/api/generated/authentication/)**.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.4.0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
/**
|
|
15
|
+
* Check if a given object implements the UploadResponse interface.
|
|
16
|
+
*/
|
|
17
|
+
export function instanceOfUploadResponse(value) {
|
|
18
|
+
return true;
|
|
19
|
+
}
|
|
20
|
+
export function UploadResponseFromJSON(json) {
|
|
21
|
+
return UploadResponseFromJSONTyped(json, false);
|
|
22
|
+
}
|
|
23
|
+
export function UploadResponseFromJSONTyped(json, ignoreDiscriminator) {
|
|
24
|
+
if (json == null) {
|
|
25
|
+
return json;
|
|
26
|
+
}
|
|
27
|
+
return {
|
|
28
|
+
'jobId': json['jobId'] == null ? undefined : json['jobId'],
|
|
29
|
+
};
|
|
30
|
+
}
|
|
31
|
+
export function UploadResponseToJSON(json) {
|
|
32
|
+
return UploadResponseToJSONTyped(json, false);
|
|
33
|
+
}
|
|
34
|
+
export function UploadResponseToJSONTyped(value, ignoreDiscriminator = false) {
|
|
35
|
+
if (value == null) {
|
|
36
|
+
return value;
|
|
37
|
+
}
|
|
38
|
+
return {
|
|
39
|
+
'jobId': value['jobId'],
|
|
40
|
+
};
|
|
41
|
+
}
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Candescent DI API
|
|
3
|
+
* Welcome to the **Candescent Digital Insight API** documentation. This comprehensive API platform enables financial institutions, Marketplace Partners, and developers to build powerful digital banking experiences. ## Getting Started New to the Candescent API? Start here: - **[Quick Start Guide](/guides/getting-started/quickstart/)** - Make your first API call in minutes - **[API Categories Overview](/guides/getting-started/api-overview/)** - Explore all available API categories - **[Error Codes Reference](/guides/getting-started/error-codes/)** - Handle errors effectively ## API Categories | Category | Description | |----------|-------------| | **[Accounts](/api/generated/accounts/)** | Account information, transactions, and banking images | | **[Alert Configuration](/api/generated/alert-configuration/)** | Alert types and templates | | **[Alert Delivery](/api/generated/alert-delivery/)** | Alert delivery history | | **[Alert Preferences](/api/generated/alert-preferences/)** | End-user notification preferences | | **[Authentication](/api/generated/authentication/)** | OAuth 2.0 token management and authorization | | **[Business Banking](/api/generated/business-banking/)** | Business banking services | | **[Customer Campaigns](/api/generated/customer-campaigns/)** | User segmentation and promotions | | **[Customer Management](/api/generated/customer-management/)** | Customer profiles, registration, and self-service | | **[Documents and Preferences](/api/generated/documents-and-preferences/)** | Disclosures and e-statement preferences | | **[Money Movement](/api/generated/money-movement/)** | Recipients and fund transfers | | **[MX](/api/generated/mx/)** | Account aggregation and financial insights | | **[Notification Channels](/api/generated/notification-channels/)** | Notification channels for alert delivery | ## Base URLs | Environment | Base URL | |-------------|----------| | Stage | `https://api.candescent.com/digitalbanking/stage` | | Production | `https://api.candescent.com/digitalbanking` | > **Note:** This documentation primarily references the **Stage** environment for examples. ## Authentication Overview Candescent APIs use OAuth 2.0 with JWT Bearer tokens. Follow these steps: ### Step 1: Obtain Client Credentials Get your `Client ID` and `Client Secret` from the Candescent Developer Console. ### Step 2: Generate an Access Token ```bash curl -X POST \'https://api.candescent.com/digitalbanking/stage/oauth2/v1/token\' \\ -H \'Authorization: Basic <BASE64_ENCODED(CLIENT_ID:CLIENT_SECRET)>\' \\ -H \'Content-Type: application/x-www-form-urlencoded\' \\ -H \'transactionid: <YOUR_UNIQUE_UUID>\' \\ -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\ -d \'grant_type=client_credentials\' ``` ### Step 3: Make Authenticated Requests Include the token in the `Authorization` header: ```bash curl \'https://api.candescent.com/digitalbanking/stage/accounts/v1/accounts\' \\ -H \'Authorization: Bearer <YOUR_ACCESS_TOKEN>\' \\ -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\ -H \'transactionid: <YOUR_UNIQUE_UUID>\' ``` > **Tip:** Access tokens expire in ~1 hour. Implement token refresh logic for uninterrupted access. For detailed authentication flows, see the **[Authentication API Reference](/api/generated/authentication/)**.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.4.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
*
|
|
14
|
+
* @export
|
|
15
|
+
* @interface UploadResponseDTO
|
|
16
|
+
*/
|
|
17
|
+
export interface UploadResponseDTO {
|
|
18
|
+
/**
|
|
19
|
+
*
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof UploadResponseDTO
|
|
22
|
+
*/
|
|
23
|
+
code?: string;
|
|
24
|
+
/**
|
|
25
|
+
*
|
|
26
|
+
* @type {string}
|
|
27
|
+
* @memberof UploadResponseDTO
|
|
28
|
+
*/
|
|
29
|
+
message?: string;
|
|
30
|
+
/**
|
|
31
|
+
*
|
|
32
|
+
* @type {string}
|
|
33
|
+
* @memberof UploadResponseDTO
|
|
34
|
+
*/
|
|
35
|
+
jobId?: string;
|
|
36
|
+
/**
|
|
37
|
+
*
|
|
38
|
+
* @type {string}
|
|
39
|
+
* @memberof UploadResponseDTO
|
|
40
|
+
*/
|
|
41
|
+
jobStatus?: string;
|
|
42
|
+
}
|
|
43
|
+
/**
|
|
44
|
+
* Check if a given object implements the UploadResponseDTO interface.
|
|
45
|
+
*/
|
|
46
|
+
export declare function instanceOfUploadResponseDTO(value: object): value is UploadResponseDTO;
|
|
47
|
+
export declare function UploadResponseDTOFromJSON(json: any): UploadResponseDTO;
|
|
48
|
+
export declare function UploadResponseDTOFromJSONTyped(json: any, ignoreDiscriminator: boolean): UploadResponseDTO;
|
|
49
|
+
export declare function UploadResponseDTOToJSON(json: any): UploadResponseDTO;
|
|
50
|
+
export declare function UploadResponseDTOToJSONTyped(value?: UploadResponseDTO | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Candescent DI API
|
|
5
|
+
* Welcome to the **Candescent Digital Insight API** documentation. This comprehensive API platform enables financial institutions, Marketplace Partners, and developers to build powerful digital banking experiences. ## Getting Started New to the Candescent API? Start here: - **[Quick Start Guide](/guides/getting-started/quickstart/)** - Make your first API call in minutes - **[API Categories Overview](/guides/getting-started/api-overview/)** - Explore all available API categories - **[Error Codes Reference](/guides/getting-started/error-codes/)** - Handle errors effectively ## API Categories | Category | Description | |----------|-------------| | **[Accounts](/api/generated/accounts/)** | Account information, transactions, and banking images | | **[Alert Configuration](/api/generated/alert-configuration/)** | Alert types and templates | | **[Alert Delivery](/api/generated/alert-delivery/)** | Alert delivery history | | **[Alert Preferences](/api/generated/alert-preferences/)** | End-user notification preferences | | **[Authentication](/api/generated/authentication/)** | OAuth 2.0 token management and authorization | | **[Business Banking](/api/generated/business-banking/)** | Business banking services | | **[Customer Campaigns](/api/generated/customer-campaigns/)** | User segmentation and promotions | | **[Customer Management](/api/generated/customer-management/)** | Customer profiles, registration, and self-service | | **[Documents and Preferences](/api/generated/documents-and-preferences/)** | Disclosures and e-statement preferences | | **[Money Movement](/api/generated/money-movement/)** | Recipients and fund transfers | | **[MX](/api/generated/mx/)** | Account aggregation and financial insights | | **[Notification Channels](/api/generated/notification-channels/)** | Notification channels for alert delivery | ## Base URLs | Environment | Base URL | |-------------|----------| | Stage | `https://api.candescent.com/digitalbanking/stage` | | Production | `https://api.candescent.com/digitalbanking` | > **Note:** This documentation primarily references the **Stage** environment for examples. ## Authentication Overview Candescent APIs use OAuth 2.0 with JWT Bearer tokens. Follow these steps: ### Step 1: Obtain Client Credentials Get your `Client ID` and `Client Secret` from the Candescent Developer Console. ### Step 2: Generate an Access Token ```bash curl -X POST \'https://api.candescent.com/digitalbanking/stage/oauth2/v1/token\' \\ -H \'Authorization: Basic <BASE64_ENCODED(CLIENT_ID:CLIENT_SECRET)>\' \\ -H \'Content-Type: application/x-www-form-urlencoded\' \\ -H \'transactionid: <YOUR_UNIQUE_UUID>\' \\ -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\ -d \'grant_type=client_credentials\' ``` ### Step 3: Make Authenticated Requests Include the token in the `Authorization` header: ```bash curl \'https://api.candescent.com/digitalbanking/stage/accounts/v1/accounts\' \\ -H \'Authorization: Bearer <YOUR_ACCESS_TOKEN>\' \\ -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\ -H \'transactionid: <YOUR_UNIQUE_UUID>\' ``` > **Tip:** Access tokens expire in ~1 hour. Implement token refresh logic for uninterrupted access. For detailed authentication flows, see the **[Authentication API Reference](/api/generated/authentication/)**.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.4.0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
/**
|
|
15
|
+
* Check if a given object implements the UploadResponseDTO interface.
|
|
16
|
+
*/
|
|
17
|
+
export function instanceOfUploadResponseDTO(value) {
|
|
18
|
+
return true;
|
|
19
|
+
}
|
|
20
|
+
export function UploadResponseDTOFromJSON(json) {
|
|
21
|
+
return UploadResponseDTOFromJSONTyped(json, false);
|
|
22
|
+
}
|
|
23
|
+
export function UploadResponseDTOFromJSONTyped(json, ignoreDiscriminator) {
|
|
24
|
+
if (json == null) {
|
|
25
|
+
return json;
|
|
26
|
+
}
|
|
27
|
+
return {
|
|
28
|
+
'code': json['code'] == null ? undefined : json['code'],
|
|
29
|
+
'message': json['message'] == null ? undefined : json['message'],
|
|
30
|
+
'jobId': json['jobId'] == null ? undefined : json['jobId'],
|
|
31
|
+
'jobStatus': json['jobStatus'] == null ? undefined : json['jobStatus'],
|
|
32
|
+
};
|
|
33
|
+
}
|
|
34
|
+
export function UploadResponseDTOToJSON(json) {
|
|
35
|
+
return UploadResponseDTOToJSONTyped(json, false);
|
|
36
|
+
}
|
|
37
|
+
export function UploadResponseDTOToJSONTyped(value, ignoreDiscriminator = false) {
|
|
38
|
+
if (value == null) {
|
|
39
|
+
return value;
|
|
40
|
+
}
|
|
41
|
+
return {
|
|
42
|
+
'code': value['code'],
|
|
43
|
+
'message': value['message'],
|
|
44
|
+
'jobId': value['jobId'],
|
|
45
|
+
'jobStatus': value['jobStatus'],
|
|
46
|
+
};
|
|
47
|
+
}
|
|
@@ -0,0 +1,134 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Candescent DI API
|
|
3
|
+
* Welcome to the **Candescent Digital Insight API** documentation. This comprehensive API platform enables financial institutions, Marketplace Partners, and developers to build powerful digital banking experiences. ## Getting Started New to the Candescent API? Start here: - **[Quick Start Guide](/guides/getting-started/quickstart/)** - Make your first API call in minutes - **[API Categories Overview](/guides/getting-started/api-overview/)** - Explore all available API categories - **[Error Codes Reference](/guides/getting-started/error-codes/)** - Handle errors effectively ## API Categories | Category | Description | |----------|-------------| | **[Accounts](/api/generated/accounts/)** | Account information, transactions, and banking images | | **[Alert Configuration](/api/generated/alert-configuration/)** | Alert types and templates | | **[Alert Delivery](/api/generated/alert-delivery/)** | Alert delivery history | | **[Alert Preferences](/api/generated/alert-preferences/)** | End-user notification preferences | | **[Authentication](/api/generated/authentication/)** | OAuth 2.0 token management and authorization | | **[Business Banking](/api/generated/business-banking/)** | Business banking services | | **[Customer Campaigns](/api/generated/customer-campaigns/)** | User segmentation and promotions | | **[Customer Management](/api/generated/customer-management/)** | Customer profiles, registration, and self-service | | **[Documents and Preferences](/api/generated/documents-and-preferences/)** | Disclosures and e-statement preferences | | **[Money Movement](/api/generated/money-movement/)** | Recipients and fund transfers | | **[MX](/api/generated/mx/)** | Account aggregation and financial insights | | **[Notification Channels](/api/generated/notification-channels/)** | Notification channels for alert delivery | ## Base URLs | Environment | Base URL | |-------------|----------| | Stage | `https://api.candescent.com/digitalbanking/stage` | | Production | `https://api.candescent.com/digitalbanking` | > **Note:** This documentation primarily references the **Stage** environment for examples. ## Authentication Overview Candescent APIs use OAuth 2.0 with JWT Bearer tokens. Follow these steps: ### Step 1: Obtain Client Credentials Get your `Client ID` and `Client Secret` from the Candescent Developer Console. ### Step 2: Generate an Access Token ```bash curl -X POST \'https://api.candescent.com/digitalbanking/stage/oauth2/v1/token\' \\ -H \'Authorization: Basic <BASE64_ENCODED(CLIENT_ID:CLIENT_SECRET)>\' \\ -H \'Content-Type: application/x-www-form-urlencoded\' \\ -H \'transactionid: <YOUR_UNIQUE_UUID>\' \\ -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\ -d \'grant_type=client_credentials\' ``` ### Step 3: Make Authenticated Requests Include the token in the `Authorization` header: ```bash curl \'https://api.candescent.com/digitalbanking/stage/accounts/v1/accounts\' \\ -H \'Authorization: Bearer <YOUR_ACCESS_TOKEN>\' \\ -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\ -H \'transactionid: <YOUR_UNIQUE_UUID>\' ``` > **Tip:** Access tokens expire in ~1 hour. Implement token refresh logic for uninterrupted access. For detailed authentication flows, see the **[Authentication API Reference](/api/generated/authentication/)**.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.4.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
* MX User resource
|
|
14
|
+
* @export
|
|
15
|
+
* @interface User
|
|
16
|
+
*/
|
|
17
|
+
export interface User {
|
|
18
|
+
/**
|
|
19
|
+
* Timestamp when user accepted terms and conditions
|
|
20
|
+
* @type {Date}
|
|
21
|
+
* @memberof User
|
|
22
|
+
*/
|
|
23
|
+
acceptedTermsAndConditionsAt?: Date | null;
|
|
24
|
+
/**
|
|
25
|
+
* User birth date
|
|
26
|
+
* @type {Date}
|
|
27
|
+
* @memberof User
|
|
28
|
+
*/
|
|
29
|
+
bornOn?: Date | null;
|
|
30
|
+
/**
|
|
31
|
+
* User credit score
|
|
32
|
+
* @type {number}
|
|
33
|
+
* @memberof User
|
|
34
|
+
*/
|
|
35
|
+
creditScore?: number | null;
|
|
36
|
+
/**
|
|
37
|
+
* User email address
|
|
38
|
+
* @type {string}
|
|
39
|
+
* @memberof User
|
|
40
|
+
*/
|
|
41
|
+
email?: string | null;
|
|
42
|
+
/**
|
|
43
|
+
* Whether user email is verified
|
|
44
|
+
* @type {boolean}
|
|
45
|
+
* @memberof User
|
|
46
|
+
*/
|
|
47
|
+
emailIsVerified: boolean;
|
|
48
|
+
/**
|
|
49
|
+
* Number of failed login attempts
|
|
50
|
+
* @type {number}
|
|
51
|
+
* @memberof User
|
|
52
|
+
*/
|
|
53
|
+
failedTokenLoginAttemptsCount: number;
|
|
54
|
+
/**
|
|
55
|
+
* User first name
|
|
56
|
+
* @type {string}
|
|
57
|
+
* @memberof User
|
|
58
|
+
*/
|
|
59
|
+
firstName?: string | null;
|
|
60
|
+
/**
|
|
61
|
+
* User gender
|
|
62
|
+
* @type {string}
|
|
63
|
+
* @memberof User
|
|
64
|
+
*/
|
|
65
|
+
gender?: string | null;
|
|
66
|
+
/**
|
|
67
|
+
* Global unique identifier for the user
|
|
68
|
+
* @type {string}
|
|
69
|
+
* @memberof User
|
|
70
|
+
*/
|
|
71
|
+
guid: string;
|
|
72
|
+
/**
|
|
73
|
+
* Whether user has accepted terms and conditions
|
|
74
|
+
* @type {boolean}
|
|
75
|
+
* @memberof User
|
|
76
|
+
*/
|
|
77
|
+
hasAcceptedTermsAndConditions: boolean;
|
|
78
|
+
/**
|
|
79
|
+
* MX user identifier
|
|
80
|
+
* @type {string}
|
|
81
|
+
* @memberof User
|
|
82
|
+
*/
|
|
83
|
+
id: string;
|
|
84
|
+
/**
|
|
85
|
+
* Whether user account is disabled
|
|
86
|
+
* @type {boolean}
|
|
87
|
+
* @memberof User
|
|
88
|
+
*/
|
|
89
|
+
isDisabled: boolean;
|
|
90
|
+
/**
|
|
91
|
+
* Whether user account is restricted
|
|
92
|
+
* @type {boolean}
|
|
93
|
+
* @memberof User
|
|
94
|
+
*/
|
|
95
|
+
isRestricted: boolean;
|
|
96
|
+
/**
|
|
97
|
+
* User last name
|
|
98
|
+
* @type {string}
|
|
99
|
+
* @memberof User
|
|
100
|
+
*/
|
|
101
|
+
lastName?: string | null;
|
|
102
|
+
/**
|
|
103
|
+
* Timestamp of last login
|
|
104
|
+
* @type {Date}
|
|
105
|
+
* @memberof User
|
|
106
|
+
*/
|
|
107
|
+
loggedInAt?: Date | null;
|
|
108
|
+
/**
|
|
109
|
+
* Additional custom metadata
|
|
110
|
+
* @type {object}
|
|
111
|
+
* @memberof User
|
|
112
|
+
*/
|
|
113
|
+
metadata?: object | null;
|
|
114
|
+
/**
|
|
115
|
+
* User phone number
|
|
116
|
+
* @type {string}
|
|
117
|
+
* @memberof User
|
|
118
|
+
*/
|
|
119
|
+
phone?: string | null;
|
|
120
|
+
/**
|
|
121
|
+
* User postal code
|
|
122
|
+
* @type {string}
|
|
123
|
+
* @memberof User
|
|
124
|
+
*/
|
|
125
|
+
postalCode?: string | null;
|
|
126
|
+
}
|
|
127
|
+
/**
|
|
128
|
+
* Check if a given object implements the User interface.
|
|
129
|
+
*/
|
|
130
|
+
export declare function instanceOfUser(value: object): value is User;
|
|
131
|
+
export declare function UserFromJSON(json: any): User;
|
|
132
|
+
export declare function UserFromJSONTyped(json: any, ignoreDiscriminator: boolean): User;
|
|
133
|
+
export declare function UserToJSON(json: any): User;
|
|
134
|
+
export declare function UserToJSONTyped(value?: User | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,89 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Candescent DI API
|
|
5
|
+
* Welcome to the **Candescent Digital Insight API** documentation. This comprehensive API platform enables financial institutions, Marketplace Partners, and developers to build powerful digital banking experiences. ## Getting Started New to the Candescent API? Start here: - **[Quick Start Guide](/guides/getting-started/quickstart/)** - Make your first API call in minutes - **[API Categories Overview](/guides/getting-started/api-overview/)** - Explore all available API categories - **[Error Codes Reference](/guides/getting-started/error-codes/)** - Handle errors effectively ## API Categories | Category | Description | |----------|-------------| | **[Accounts](/api/generated/accounts/)** | Account information, transactions, and banking images | | **[Alert Configuration](/api/generated/alert-configuration/)** | Alert types and templates | | **[Alert Delivery](/api/generated/alert-delivery/)** | Alert delivery history | | **[Alert Preferences](/api/generated/alert-preferences/)** | End-user notification preferences | | **[Authentication](/api/generated/authentication/)** | OAuth 2.0 token management and authorization | | **[Business Banking](/api/generated/business-banking/)** | Business banking services | | **[Customer Campaigns](/api/generated/customer-campaigns/)** | User segmentation and promotions | | **[Customer Management](/api/generated/customer-management/)** | Customer profiles, registration, and self-service | | **[Documents and Preferences](/api/generated/documents-and-preferences/)** | Disclosures and e-statement preferences | | **[Money Movement](/api/generated/money-movement/)** | Recipients and fund transfers | | **[MX](/api/generated/mx/)** | Account aggregation and financial insights | | **[Notification Channels](/api/generated/notification-channels/)** | Notification channels for alert delivery | ## Base URLs | Environment | Base URL | |-------------|----------| | Stage | `https://api.candescent.com/digitalbanking/stage` | | Production | `https://api.candescent.com/digitalbanking` | > **Note:** This documentation primarily references the **Stage** environment for examples. ## Authentication Overview Candescent APIs use OAuth 2.0 with JWT Bearer tokens. Follow these steps: ### Step 1: Obtain Client Credentials Get your `Client ID` and `Client Secret` from the Candescent Developer Console. ### Step 2: Generate an Access Token ```bash curl -X POST \'https://api.candescent.com/digitalbanking/stage/oauth2/v1/token\' \\ -H \'Authorization: Basic <BASE64_ENCODED(CLIENT_ID:CLIENT_SECRET)>\' \\ -H \'Content-Type: application/x-www-form-urlencoded\' \\ -H \'transactionid: <YOUR_UNIQUE_UUID>\' \\ -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\ -d \'grant_type=client_credentials\' ``` ### Step 3: Make Authenticated Requests Include the token in the `Authorization` header: ```bash curl \'https://api.candescent.com/digitalbanking/stage/accounts/v1/accounts\' \\ -H \'Authorization: Bearer <YOUR_ACCESS_TOKEN>\' \\ -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\ -H \'transactionid: <YOUR_UNIQUE_UUID>\' ``` > **Tip:** Access tokens expire in ~1 hour. Implement token refresh logic for uninterrupted access. For detailed authentication flows, see the **[Authentication API Reference](/api/generated/authentication/)**.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.4.0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
/**
|
|
15
|
+
* Check if a given object implements the User interface.
|
|
16
|
+
*/
|
|
17
|
+
export function instanceOfUser(value) {
|
|
18
|
+
if (!('emailIsVerified' in value) || value['emailIsVerified'] === undefined)
|
|
19
|
+
return false;
|
|
20
|
+
if (!('failedTokenLoginAttemptsCount' in value) || value['failedTokenLoginAttemptsCount'] === undefined)
|
|
21
|
+
return false;
|
|
22
|
+
if (!('guid' in value) || value['guid'] === undefined)
|
|
23
|
+
return false;
|
|
24
|
+
if (!('hasAcceptedTermsAndConditions' in value) || value['hasAcceptedTermsAndConditions'] === undefined)
|
|
25
|
+
return false;
|
|
26
|
+
if (!('id' in value) || value['id'] === undefined)
|
|
27
|
+
return false;
|
|
28
|
+
if (!('isDisabled' in value) || value['isDisabled'] === undefined)
|
|
29
|
+
return false;
|
|
30
|
+
if (!('isRestricted' in value) || value['isRestricted'] === undefined)
|
|
31
|
+
return false;
|
|
32
|
+
return true;
|
|
33
|
+
}
|
|
34
|
+
export function UserFromJSON(json) {
|
|
35
|
+
return UserFromJSONTyped(json, false);
|
|
36
|
+
}
|
|
37
|
+
export function UserFromJSONTyped(json, ignoreDiscriminator) {
|
|
38
|
+
if (json == null) {
|
|
39
|
+
return json;
|
|
40
|
+
}
|
|
41
|
+
return {
|
|
42
|
+
'acceptedTermsAndConditionsAt': json['accepted_terms_and_conditions_at'] == null ? undefined : (new Date(json['accepted_terms_and_conditions_at'])),
|
|
43
|
+
'bornOn': json['born_on'] == null ? undefined : (new Date(json['born_on'])),
|
|
44
|
+
'creditScore': json['credit_score'] == null ? undefined : json['credit_score'],
|
|
45
|
+
'email': json['email'] == null ? undefined : json['email'],
|
|
46
|
+
'emailIsVerified': json['email_is_verified'],
|
|
47
|
+
'failedTokenLoginAttemptsCount': json['failed_token_login_attempts_count'],
|
|
48
|
+
'firstName': json['first_name'] == null ? undefined : json['first_name'],
|
|
49
|
+
'gender': json['gender'] == null ? undefined : json['gender'],
|
|
50
|
+
'guid': json['guid'],
|
|
51
|
+
'hasAcceptedTermsAndConditions': json['has_accepted_terms_and_conditions'],
|
|
52
|
+
'id': json['id'],
|
|
53
|
+
'isDisabled': json['is_disabled'],
|
|
54
|
+
'isRestricted': json['is_restricted'],
|
|
55
|
+
'lastName': json['last_name'] == null ? undefined : json['last_name'],
|
|
56
|
+
'loggedInAt': json['logged_in_at'] == null ? undefined : (new Date(json['logged_in_at'])),
|
|
57
|
+
'metadata': json['metadata'] == null ? undefined : json['metadata'],
|
|
58
|
+
'phone': json['phone'] == null ? undefined : json['phone'],
|
|
59
|
+
'postalCode': json['postal_code'] == null ? undefined : json['postal_code'],
|
|
60
|
+
};
|
|
61
|
+
}
|
|
62
|
+
export function UserToJSON(json) {
|
|
63
|
+
return UserToJSONTyped(json, false);
|
|
64
|
+
}
|
|
65
|
+
export function UserToJSONTyped(value, ignoreDiscriminator = false) {
|
|
66
|
+
if (value == null) {
|
|
67
|
+
return value;
|
|
68
|
+
}
|
|
69
|
+
return {
|
|
70
|
+
'accepted_terms_and_conditions_at': value['acceptedTermsAndConditionsAt'] == null ? value['acceptedTermsAndConditionsAt'] : value['acceptedTermsAndConditionsAt'].toISOString(),
|
|
71
|
+
'born_on': value['bornOn'] == null ? value['bornOn'] : value['bornOn'].toISOString().substring(0, 10),
|
|
72
|
+
'credit_score': value['creditScore'],
|
|
73
|
+
'email': value['email'],
|
|
74
|
+
'email_is_verified': value['emailIsVerified'],
|
|
75
|
+
'failed_token_login_attempts_count': value['failedTokenLoginAttemptsCount'],
|
|
76
|
+
'first_name': value['firstName'],
|
|
77
|
+
'gender': value['gender'],
|
|
78
|
+
'guid': value['guid'],
|
|
79
|
+
'has_accepted_terms_and_conditions': value['hasAcceptedTermsAndConditions'],
|
|
80
|
+
'id': value['id'],
|
|
81
|
+
'is_disabled': value['isDisabled'],
|
|
82
|
+
'is_restricted': value['isRestricted'],
|
|
83
|
+
'last_name': value['lastName'],
|
|
84
|
+
'logged_in_at': value['loggedInAt'] == null ? value['loggedInAt'] : value['loggedInAt'].toISOString(),
|
|
85
|
+
'metadata': value['metadata'],
|
|
86
|
+
'phone': value['phone'],
|
|
87
|
+
'postal_code': value['postalCode'],
|
|
88
|
+
};
|
|
89
|
+
}
|