@crediblex.io/fineract-api-client
Version:
TypeScript client for Fineract APIs
50 lines • 2.3 kB
TypeScript
import { HttpClient, HttpClientConfig } from "./utils/http-client";
import { FineractSmeApi } from "./api/fineract-sme-api";
import { FineractDatatableApi } from "./api/fineract-datatable-api";
import { FineractLoanProductsApi } from "./api/fineract-loanproducts-api";
import { FineractSavingsProductsApi } from "./api/fineract-savingsproducts-api";
import { FineractSavingsAccountsApi } from "./api/fineract-savingsaccounts-api";
import { FineractLoansAccountsApi } from "./api/fineract-loansaccounts-api";
import { FineractReportsApi } from "./api/fineract-reports-api";
import { FineractHolidaysApi } from "./api/fineract-holidays-api";
import { FineractWorkingDaysApi } from "./api/fineract-workingdays-api";
import { FineractCreditLinesApi } from "./api/fineract-creditlines-api";
/**
* Configuration for the FineractSDK.
*/
export interface FineractSDKConfig extends HttpClientConfig {
}
/**
* Main SDK class for interacting with Fineract APIs.
* It provides access to various API modules, starting with FineractClientApi.
*/
export declare class FineractSDK {
private readonly httpClient;
readonly sme: FineractSmeApi;
readonly datatable: FineractDatatableApi;
readonly loanproducts: FineractLoanProductsApi;
readonly savingsproducts: FineractSavingsProductsApi;
readonly savingsaccounts: FineractSavingsAccountsApi;
readonly loansaccounts: FineractLoansAccountsApi;
readonly reports: FineractReportsApi;
readonly holidays: FineractHolidaysApi;
readonly workingdays: FineractWorkingDaysApi;
readonly creditlines: FineractCreditLinesApi;
/**
* Initializes a new instance of the FineractSDK.
* @param config Configuration for the SDK, including baseURL, tenantId, and credentials.
*/
constructor(config: FineractSDKConfig);
/**
* Allows direct access to the underlying HttpClient for advanced use cases
* or for API endpoints not yet covered by specific API client classes.
*/
getHttpClient(): HttpClient;
}
/**
* Factory function to easily create an instance of the FineractSDK.
* @param config Configuration for the SDK.
* @returns A new instance of FineractSDK.
*/
export declare function createFineractSDK(config: FineractSDKConfig): FineractSDK;
//# sourceMappingURL=fineract-sdk.d.ts.map