@cdx-forge/di-typescript-sdk 0.1.0-beta.1

package/dist/generated/src/models/index.js

@@ -0,0 +1,268 @@
+/* tslint:disable */
+/* eslint-disable */
+export * from './Account.js';
+export * from './Account1.js';
+export * from './Account2Inner.js';
+export * from './Account3.js';
+export * from './AccountCategory.js';
+export * from './AccountEntitledFeature.js';
+export * from './AccountEvent.js';
+export * from './AccountId.js';
+export * from './AccountNickname.js';
+export * from './AccountNumber.js';
+export * from './AccountRefreshStatus.js';
+export * from './AccountStatus.js';
+export * from './AccountStatus1.js';
+export * from './AccountStatuses.js';
+export * from './AccountTransaction.js';
+export * from './AccountTransaction1.js';
+export * from './AccountTransactions.js';
+export * from './AccountType.js';
+export * from './AccountType1.js';
+export * from './AccountType2.js';
+export * from './AccountsResponse.js';
+export * from './Action.js';
+export * from './Actions.js';
+export * from './Actions1.js';
+export * from './AdditionalFilters.js';
+export * from './AlertHistoryContentResource.js';
+export * from './AlertHistorySummaryResource.js';
+export * from './AlertHistorySummaryResources.js';
+export * from './AlertPreferenceAccountDetailsModel.js';
+export * from './AlertPreferenceDetailsModel.js';
+export * from './AlertPreferenceResource.js';
+export * from './AlertPreferenceResources.js';
+export * from './AlertTemplateResource.js';
+export * from './AlertTemplateResources.js';
+export * from './AlertTypeResource.js';
+export * from './AlertTypeResources.js';
+export * from './AuthCode.js';
+export * from './AuthorizationCodeResponse.js';
+export * from './Balance.js';
+export * from './Balance1.js';
+export * from './BankAccount.js';
+export * from './BankingImage.js';
+export * from './BankingImages.js';
+export * from './BaseGroupsWithParticipantsCountDTO.js';
+export * from './BasePageDTOListImportJobDTO.js';
+export * from './BasePageDTOListImportJobErrorDTO.js';
+export * from './BbRegistration.js';
+export * from './BbRegistrationStatus.js';
+export * from './BbRegistrationUser.js';
+export * from './BbRegistrationUserType.js';
+export * from './BusinessAddress.js';
+export * from './BusinessContact.js';
+export * from './BusinessDetails.js';
+export * from './BusinessEntitlementsLimits.js';
+export * from './BusinessRegistrationConfig.js';
+export * from './BusinessTinInfo.js';
+export * from './BusinessUser.js';
+export * from './Calendar.js';
+export * from './ChallengeQuestionInfo.js';
+export * from './ChannelContent.js';
+export * from './ChannelInfo.js';
+export * from './ChannelInfos.js';
+export * from './ClientAuth.js';
+export * from './ClientAuthAdditionalInfo.js';
+export * from './ClientCredentialsResponse.js';
+export * from './Condition.js';
+export * from './ContactInfo.js';
+export * from './ContactInfo1.js';
+export * from './ContactInfoEmail.js';
+export * from './ContactInfoPhoneNumber.js';
+export * from './ContactMethod.js';
+export * from './ContactMethod1.js';
+export * from './ContactMethodResponse.js';
+export * from './Controls.js';
+export * from './CreateToken200Response.js';
+export * from './Credential.js';
+export * from './CurrencyCode.js';
+export * from './Customer.js';
+export * from './CustomerAccountsResponse.js';
+export * from './CustomerInformation.js';
+export * from './DIAccountType.js';
+export * from './DIAccountType1.js';
+export * from './DataMap.js';
+export * from './Destination.js';
+export * from './DisplayFlag.js';
+export * from './DownloadTransactionLogs404Response.js';
+export * from './EStatementDisclosure.js';
+export * from './EStatementDisclosureResponse.js';
+export * from './EStatementPreferencesRequest.js';
+export * from './EStatementPreferencesResponse.js';
+export * from './EStatementReport.js';
+export * from './EStatementReportRequest.js';
+export * from './EStatementReportResponse.js';
+export * from './EStatementRequest.js';
+export * from './EntitledFeature.js';
+export * from './EntitledTins.js';
+export * from './Entitlement.js';
+export * from './Entitlements.js';
+export * from './Entry.js';
+export * from './Error1.js';
+export * from './Error2.js';
+export * from './Error3.js';
+export * from './Error4.js';
+export * from './Error5.js';
+export * from './ErrorInfo.js';
+export * from './ErrorInfo1.js';
+export * from './ErrorInfo2.js';
+export * from './ErrorInfo3.js';
+export * from './ErrorInfo4.js';
+export * from './ErrorInfo5.js';
+export * from './Event.js';
+export * from './Event1.js';
+export * from './EventDetails.js';
+export * from './Events.js';
+export * from './FIAccountType.js';
+export * from './FICustomer.js';
+export * from './FICustomerId.js';
+export * from './FICustomerRequest.js';
+export * from './FICustomerRequestChannelInfos.js';
+export * from './FICustomerRequestChannelInfosChannelInfoInner.js';
+export * from './FICustomerRequestChannelInfosChannelInfoInnerCredential.js';
+export * from './FICustomerRequestFiId.js';
+export * from './FICustomerRequestHostCredential.js';
+export * from './FICustomerRequestId.js';
+export * from './FICustomerRequestPerson.js';
+export * from './FICustomerRequestPersonContactInfo.js';
+export * from './FICustomerRequestPersonContactInfoPhoneNumberInner.js';
+export * from './FICustomerRequestPersonContactInfoPostalAddressInner.js';
+export * from './FICustomerRequestPersonPersonName.js';
+export * from './FICustomerResponse.js';
+export * from './FICustomerResponseChannelInfos.js';
+export * from './FICustomerResponseChannelInfosChannelInfoInner.js';
+export * from './FICustomerResponseChannelInfosChannelInfoInnerCredential.js';
+export * from './FICustomerResponseDestinations.js';
+export * from './FICustomerResponseDestinationsDestinationInner.js';
+export * from './FICustomerResponseFiId.js';
+export * from './FICustomerResponseHostCredential.js';
+export * from './FICustomerResponseId.js';
+export * from './FICustomerResponsePerson.js';
+export * from './FICustomerResponsePersonContactInfo.js';
+export * from './FICustomerResponsePersonContactInfoPhoneNumberInner.js';
+export * from './FICustomerResponsePersonContactInfoPostalAddressInner.js';
+export * from './FICustomerResponsePersonPersonName.js';
+export * from './FeatureLimits.js';
+export * from './FiAlertPreferenceResource.js';
+export * from './FiAlertPreferenceResources.js';
+export * from './FileErrorReport.js';
+export * from './FileMetadata.js';
+export * from './FileStatus.js';
+export * from './Filter.js';
+export * from './Frequency.js';
+export * from './GetUser404Response.js';
+export * from './GetWidgetUrl200Response.js';
+export * from './GroupBaseRequestDTO.js';
+export * from './GroupBaseResponseDTO.js';
+export * from './GroupExperienceDTO.js';
+export * from './GroupsWithParticipantsCount.js';
+export * from './HostTransactionType.js';
+export * from './IdType.js';
+export * from './ImageInfo.js';
+export * from './ImageInfoType.js';
+export * from './ImageType.js';
+export * from './ImageView.js';
+export * from './ImportJobDTO.js';
+export * from './ImportJobDTOSingle.js';
+export * from './ImportJobErrorDTO.js';
+export * from './InstitutionAlertTypeResource.js';
+export * from './InstitutionAlertTypeResources.js';
+export * from './InstitutionCustomer.js';
+export * from './InstitutionCustomerAdditionalInfo.js';
+export * from './InstitutionDisclosure.js';
+export * from './InstitutionDisclosureDataType.js';
+export * from './InstitutionDisclosures.js';
+export * from './InstitutionUser.js';
+export * from './InstitutionUserAdditionalInfo.js';
+export * from './InstitutionUserDisclosure.js';
+export * from './InstitutionUserDisclosureStatus.js';
+export * from './InstitutionUserDisclosures.js';
+export * from './JobUploadStatus.js';
+export * from './JobUploadStatusStatus.js';
+export * from './LifeType.js';
+export * from './Limit.js';
+export * from './Limits.js';
+export * from './Links.js';
+export * from './ListUsers400Response.js';
+export * from './ListUsers400ResponseErrorsInner.js';
+export * from './ListUsers401Response.js';
+export * from './MapEntryInner.js';
+export * from './MapItem.js';
+export * from './MfaCookie.js';
+export * from './ModelError.js';
+export * from './ModelMap.js';
+export * from './Money.js';
+export * from './Money1.js';
+export * from './Money2.js';
+export * from './NonSubscriptionEvent.js';
+export * from './Notification.js';
+export * from './NotificationEvent.js';
+export * from './Page.js';
+export * from './Pageable.js';
+export * from './PasswordResponse.js';
+export * from './PaymentOptionType.js';
+export * from './Person.js';
+export * from './PhoneNumber.js';
+export * from './PostalAddress.js';
+export * from './PostalAddress1.js';
+export * from './ProductAppUserInfo.js';
+export * from './ProductAppUserInfos.js';
+export * from './ProductUserInfo.js';
+export * from './Protocol.js';
+export * from './Recipient.js';
+export * from './Recipients.js';
+export * from './RefreshTokenResponse.js';
+export * from './RegDLimits.js';
+export * from './RegDLimits1.js';
+export * from './RegisterCustomerRequest.js';
+export * from './RegisterCustomerResponse.js';
+export * from './ResetPasswordRequest.js';
+export * from './Resource.js';
+export * from './ResponseDTO.js';
+export * from './Schedule.js';
+export * from './SearchCriteriaRequestBody.js';
+export * from './SearchResultResponse.js';
+export * from './StatementType.js';
+export * from './Status.js';
+export * from './Status1.js';
+export * from './Status1ErrorInfo.js';
+export * from './Status2.js';
+export * from './Status2ErrorInfo.js';
+export * from './StatusAdditionalInfo.js';
+export * from './SubFilter.js';
+export * from './SubUserStatus.js';
+export * from './Subscription.js';
+export * from './SubscriptionAction.js';
+export * from './SubscriptionActionAttributesMap.js';
+export * from './SubscriptionActions.js';
+export * from './SubscriptionEventConditionsMap.js';
+export * from './Term.js';
+export * from './TermType.js';
+export * from './TimeZone.js';
+export * from './Token.js';
+export * from './Transaction.js';
+export * from './TransactionCategory.js';
+export * from './TransactionEvent.js';
+export * from './TransactionList.js';
+export * from './TransactionRange.js';
+export * from './TransactionStatus.js';
+export * from './TransactionTransactionImage.js';
+export * from './TransactionType.js';
+export * from './Transfer.js';
+export * from './TransferStatus.js';
+export * from './UpdateContactInfoPostalAddress.js';
+export * from './UploadResponse.js';
+export * from './UploadResponseDTO.js';
+export * from './User.js';
+export * from './UserEntitlementsLimits.js';
+export * from './UserEvent.js';
+export * from './UserList.js';
+export * from './UserListFileDTO.js';
+export * from './UserListsDTO.js';
+export * from './UserListsFileResponse.js';
+export * from './UserListsWithFileMetadata.js';
+export * from './UserStatus.js';
+export * from './UserStatus1.js';
+export * from './UserStatus2.js';
+export * from './UsersList.js';

package/dist/generated/src/runtime.d.ts

@@ -0,0 +1,184 @@
+/**
+ * Candescent DI API
+ * 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/)**.
+ *
+ * The version of the OpenAPI document: 1.4.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export declare const BASE_PATH: string;
+export interface ConfigurationParameters {
+    basePath?: string;
+    fetchApi?: FetchAPI;
+    middleware?: Middleware[];
+    queryParamsStringify?: (params: HTTPQuery) => string;
+    username?: string;
+    password?: string;
+    apiKey?: string | Promise<string> | ((name: string) => string | Promise<string>);
+    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string | Promise<string>);
+    headers?: HTTPHeaders;
+    credentials?: RequestCredentials;
+}
+export declare class Configuration {
+    private configuration;
+    constructor(configuration?: ConfigurationParameters);
+    set config(configuration: Configuration);
+    get basePath(): string;
+    get fetchApi(): FetchAPI | undefined;
+    get middleware(): Middleware[];
+    get queryParamsStringify(): (params: HTTPQuery) => string;
+    get username(): string | undefined;
+    get password(): string | undefined;
+    get apiKey(): ((name: string) => string | Promise<string>) | undefined;
+    get accessToken(): ((name?: string, scopes?: string[]) => string | Promise<string>) | undefined;
+    get headers(): HTTPHeaders | undefined;
+    get credentials(): RequestCredentials | undefined;
+}
+export declare const DefaultConfig: Configuration;
+/**
+ * This is the base class for all generated API classes.
+ */
+export declare class BaseAPI {
+    protected configuration: Configuration;
+    private static readonly jsonRegex;
+    private middleware;
+    constructor(configuration?: Configuration);
+    withMiddleware<T extends BaseAPI>(this: T, ...middlewares: Middleware[]): T;
+    withPreMiddleware<T extends BaseAPI>(this: T, ...preMiddlewares: Array<Middleware['pre']>): T;
+    withPostMiddleware<T extends BaseAPI>(this: T, ...postMiddlewares: Array<Middleware['post']>): T;
+    /**
+     * Check if the given MIME is a JSON MIME.
+     * JSON MIME examples:
+     *   application/json
+     *   application/json; charset=UTF8
+     *   APPLICATION/JSON
+     *   application/vnd.company+json
+     * @param mime - MIME (Multipurpose Internet Mail Extensions)
+     * @return True if the given MIME is JSON, false otherwise.
+     */
+    protected isJsonMime(mime: string | null | undefined): boolean;
+    protected request(context: RequestOpts, initOverrides?: RequestInit | InitOverrideFunction): Promise<Response>;
+    private createFetchParams;
+    private fetchApi;
+    /**
+     * Create a shallow clone of `this` by constructing a new instance
+     * and then shallow cloning data members.
+     */
+    private clone;
+}
+export declare class ResponseError extends Error {
+    response: Response;
+    name: "ResponseError";
+    constructor(response: Response, msg?: string);
+}
+export declare class FetchError extends Error {
+    cause: Error;
+    name: "FetchError";
+    constructor(cause: Error, msg?: string);
+}
+export declare class RequiredError extends Error {
+    field: string;
+    name: "RequiredError";
+    constructor(field: string, msg?: string);
+}
+export declare const COLLECTION_FORMATS: {
+    csv: string;
+    ssv: string;
+    tsv: string;
+    pipes: string;
+};
+export type FetchAPI = WindowOrWorkerGlobalScope['fetch'];
+export type Json = any;
+export type HTTPMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'HEAD';
+export type HTTPHeaders = {
+    [key: string]: string;
+};
+export type HTTPQuery = {
+    [key: string]: string | number | null | boolean | Array<string | number | null | boolean> | Set<string | number | null | boolean> | HTTPQuery;
+};
+export type HTTPBody = Json | FormData | URLSearchParams;
+export type HTTPRequestInit = {
+    headers?: HTTPHeaders;
+    method: HTTPMethod;
+    credentials?: RequestCredentials;
+    body?: HTTPBody;
+};
+export type ModelPropertyNaming = 'camelCase' | 'snake_case' | 'PascalCase' | 'original';
+export type InitOverrideFunction = (requestContext: {
+    init: HTTPRequestInit;
+    context: RequestOpts;
+}) => Promise<RequestInit>;
+export interface FetchParams {
+    url: string;
+    init: RequestInit;
+}
+export interface RequestOpts {
+    path: string;
+    method: HTTPMethod;
+    headers: HTTPHeaders;
+    query?: HTTPQuery;
+    body?: HTTPBody;
+}
+export declare function querystring(params: HTTPQuery, prefix?: string): string;
+export declare function exists(json: any, key: string): boolean;
+export declare function mapValues(data: any, fn: (item: any) => any): {
+    [key: string]: any;
+};
+export declare function canConsumeForm(consumes: Consume[]): boolean;
+export interface Consume {
+    contentType: string;
+}
+export interface RequestContext {
+    fetch: FetchAPI;
+    url: string;
+    init: RequestInit;
+}
+export interface ResponseContext {
+    fetch: FetchAPI;
+    url: string;
+    init: RequestInit;
+    response: Response;
+}
+export interface ErrorContext {
+    fetch: FetchAPI;
+    url: string;
+    init: RequestInit;
+    error: unknown;
+    response?: Response;
+}
+export interface Middleware {
+    pre?(context: RequestContext): Promise<FetchParams | void>;
+    post?(context: ResponseContext): Promise<Response | void>;
+    onError?(context: ErrorContext): Promise<Response | void>;
+}
+export interface ApiResponse<T> {
+    raw: Response;
+    value(): Promise<T>;
+}
+export interface ResponseTransformer<T> {
+    (json: any): T;
+}
+export declare class JSONApiResponse<T> {
+    raw: Response;
+    private transformer;
+    constructor(raw: Response, transformer?: ResponseTransformer<T>);
+    value(): Promise<T>;
+}
+export declare class VoidApiResponse {
+    raw: Response;
+    constructor(raw: Response);
+    value(): Promise<void>;
+}
+export declare class BlobApiResponse {
+    raw: Response;
+    constructor(raw: Response);
+    value(): Promise<Blob>;
+}
+export declare class TextApiResponse {
+    raw: Response;
+    constructor(raw: Response);
+    value(): Promise<string>;
+}