@adiba-banking-cloud/backoffice-console-ob-api-sdk 0.1.1

package/dist/types/features/merchants/api.d.ts

@@ -0,0 +1,7 @@
+import { BulkMerchantSettlementHoldBody, BulkMerchantSettlementHoldQueryParams, BulkMerchantSettlementHoldSuccessResponse, CreateMerchantBody, CreateMerchantSuccessResponse, InitiateMerchantSettlementBody, InitiateMerchantSettlementSuccessResponse, MerchantDetailSuccessResponse, MerchantsListQueryParams, MerchantsListSuccessResponse, UpdateMerchantStatusBody, UpdateMerchantStatusSuccessResponse } from "./types";
+export declare const listMerchants: (params?: MerchantsListQueryParams) => Promise<MerchantsListSuccessResponse>;
+export declare const createMerchant: (payload: CreateMerchantBody) => Promise<CreateMerchantSuccessResponse>;
+export declare const getMerchantByCode: (code: string) => Promise<MerchantDetailSuccessResponse>;
+export declare const updateMerchantStatus: (code: string, payload: UpdateMerchantStatusBody) => Promise<UpdateMerchantStatusSuccessResponse>;
+export declare const initiateMerchantSettlement: (code: string, payload: InitiateMerchantSettlementBody) => Promise<InitiateMerchantSettlementSuccessResponse>;
+export declare const bulkHoldMerchantSettlements: (payload: BulkMerchantSettlementHoldBody, params?: BulkMerchantSettlementHoldQueryParams) => Promise<BulkMerchantSettlementHoldSuccessResponse>;

package/dist/types/features/merchants/types.d.ts

@@ -0,0 +1,115 @@
+import { ApiSuccessResponse, PaginatedData, PaginationParams } from "../../shared/types";
+export interface MerchantsListQueryParams extends PaginationParams {
+    search?: string;
+    merchantStatus?: string;
+    kycStatus?: string;
+    riskRating?: string;
+    businessCategory?: string;
+    settlementCycle?: string;
+    issueFlag?: string | boolean;
+    kycReviewDue?: string;
+}
+export interface MerchantListItem {
+    merchantName: string;
+    merchantCode: string;
+    createdDate: string;
+    kycExpiryDate: string;
+    merchantStatus: string;
+    riskRating: string;
+    settlementAccountNumber: number;
+    ownerBvn: string;
+    tin: string;
+    holdSettlement: string;
+    issueFlags: boolean;
+}
+export interface CreateMerchantBody {
+    merchantName: string;
+    merchantCode: string;
+    settlementAccountNumber: number;
+    ownerBvn: string;
+    tin: string;
+    businessCategory: string;
+    settlementCycle: string;
+    riskRating: string;
+    merchantStatus: string;
+    kycStatus: string;
+}
+export interface MerchantCreatedData {
+    merchantCode: string;
+    merchantName: string;
+    merchantStatus: string;
+    kycStatus: string;
+    createdDate: string;
+}
+export interface MerchantDetail {
+    merchantName: string;
+    merchantCode: string;
+    businessCategory: string;
+    settlementAccountNumber: number;
+    settlementCycle: string;
+    settlementCurrency: string;
+    ownerBvn: string;
+    tin: string;
+    verifiedMerchant: string;
+    merchantStatus: string;
+    kycStatus: string;
+    kycExpiryDate: string;
+    riskRating: string;
+    chargebackRatio: string;
+    holdSettlement: string;
+    issueFlags: boolean;
+    monthlyTransactionVolume: number;
+    lastSettlementDate: string;
+    createdDate: string;
+    updatedDate: string;
+}
+export interface UpdateMerchantStatusBody {
+    status: string;
+    reason: string;
+    performedBy: string;
+}
+export interface MerchantStatusUpdateData {
+    merchantCode: string;
+    merchantStatus: string;
+    holdSettlement: string;
+    issueFlags: boolean;
+    updatedDate: string;
+}
+export interface InitiateMerchantSettlementBody {
+    initiatedBy: string;
+    note: string;
+}
+export interface InitiateMerchantSettlementData {
+    merchantCode: string;
+    holdSettlement: string;
+    issueFlags: boolean;
+    lastSettlementDate: string;
+    updatedDate: string;
+}
+export interface BulkMerchantSettlementHoldFilters {
+    search?: string;
+    merchantStatus?: string;
+    kycStatus?: string;
+    riskRating?: string;
+    businessCategory?: string;
+    settlementCycle?: string;
+    issueFlag?: boolean;
+    kycReviewDue?: string;
+}
+export interface BulkMerchantSettlementHoldBody {
+    merchantCodes?: string[];
+    filters?: BulkMerchantSettlementHoldFilters;
+}
+export interface BulkMerchantSettlementHoldQueryParams {
+    scope?: string;
+}
+export interface BulkMerchantSettlementHoldData {
+    affectedCount: number;
+    updatedAt: string;
+}
+export type MerchantsListSuccessResponse = ApiSuccessResponse<PaginatedData<MerchantListItem>>;
+export type CreateMerchantSuccessResponse = ApiSuccessResponse<MerchantCreatedData>;
+export type MerchantDetailSuccessResponse = ApiSuccessResponse<MerchantDetail>;
+export type UpdateMerchantStatusSuccessResponse = ApiSuccessResponse<MerchantStatusUpdateData>;
+export type InitiateMerchantSettlementSuccessResponse = ApiSuccessResponse<InitiateMerchantSettlementData>;
+export type BulkMerchantSettlementHoldSuccessResponse = ApiSuccessResponse<BulkMerchantSettlementHoldData>;

package/dist/types/features/providers/api.d.ts

@@ -0,0 +1,8 @@
+import { CreateProviderBody, CreateProviderSuccessResponse, ProviderApplicationsQueryParams, ProviderApplicationsSuccessResponse, ProviderDetailSuccessResponse, ProviderDocumentsQueryParams, ProviderDocumentsSuccessResponse, ProviderMerchantsQueryParams, ProviderMerchantsSuccessResponse, ProvidersListQueryParams, ProvidersListSuccessResponse, RotateProviderKeyBody, RotateProviderKeySuccessResponse } from "./types";
+export declare const listProviders: (params?: ProvidersListQueryParams) => Promise<ProvidersListSuccessResponse>;
+export declare const createProvider: (payload: CreateProviderBody) => Promise<CreateProviderSuccessResponse>;
+export declare const getProviderByCode: (code: string) => Promise<ProviderDetailSuccessResponse>;
+export declare const getProviderDocuments: (code: string, params?: ProviderDocumentsQueryParams) => Promise<ProviderDocumentsSuccessResponse>;
+export declare const rotateProviderKey: (code: string, payload: RotateProviderKeyBody) => Promise<RotateProviderKeySuccessResponse>;
+export declare const getProviderMerchants: (code: string, params?: ProviderMerchantsQueryParams) => Promise<ProviderMerchantsSuccessResponse>;
+export declare const getProviderApplications: (code: string, params?: ProviderApplicationsQueryParams) => Promise<ProviderApplicationsSuccessResponse>;

package/dist/types/features/providers/types.d.ts

@@ -0,0 +1,136 @@
+import { ApiSuccessResponse, PaginatedData, PaginationParams, PartialPaginatedData } from "../../shared/types";
+export interface ProvidersListQueryParams extends PaginationParams {
+    search?: string;
+    tppStatus?: string;
+    tppType?: string;
+    riskRating?: string;
+    cbnLicenseStatus?: string;
+    technicalStatus?: string;
+    onboardingStatus?: string;
+    complianceStatus?: string;
+    certificationStatus?: string;
+    recertificationDue?: string;
+}
+export interface ProviderListItem {
+    tppName: string;
+    tppCode: string;
+    tppType: string;
+    activeApplications: string;
+    cbnLicenseNumber: string;
+    cbnLicenseStatus: string;
+    tppStatus: string;
+    riskRating: string;
+    systemHealthStatus: string;
+    onboardingStatus: string;
+    complianceStatus: string;
+    certificationStatus: string;
+    certificationExpiryDate: string;
+}
+export type ProviderOnboardingDocument = string | Blob;
+export interface CreateProviderBodyFields {
+    tppName: string;
+    tppCode: string;
+    clientUuid: string;
+    dpoName: string;
+    tppType: string;
+    cbnLicenseNumber: string;
+    cbnLicenseExpiryDate: string;
+    complianceStatus: string;
+    onboardingDocuments: ProviderOnboardingDocument[];
+}
+export type CreateProviderBody = FormData | CreateProviderBodyFields;
+export interface ProviderCreatedData {
+    tppCode: string;
+    tppName: string;
+    onboardingStatus: string;
+    tppStatus: string;
+    createdDate: string;
+}
+export interface ProviderDetail {
+    tppName: string;
+    tppCode: string;
+    clientUuid: string;
+    tppType: string;
+    dpoName: string;
+    onboardingStatus: string;
+    tppStatus: string;
+    riskRating: string;
+    highRiskTpp: string;
+    cbnLicenseNumber: string;
+    cbnLicenseStatus: string;
+    cbnLicenseExpiryDate: string;
+    kycStatus: string;
+    dueDiligenceStatus: string;
+    complianceStatus: string;
+    certificationStatus: string;
+    certificationExpiryDate: string;
+    isActive: boolean;
+    systemHealthStatus: string;
+    averageApiLatencyMs: number;
+    todayApiCallCount: number;
+    dailyApiQuota: number;
+    quotaUtilization: number;
+    apiKeyVersion: string;
+    lastKeyRotationDate: string;
+    createdDate: string;
+    updatedDate: string;
+}
+export interface ProviderDocumentsQueryParams {
+    category?: string;
+    status?: string;
+}
+export interface ProviderDocument {
+    documentUuid: string;
+    name: string;
+    type: string;
+    size: string;
+    category: string;
+    status: string;
+    uploadedAt: string;
+    downloadUrl?: string;
+}
+export interface ProviderDocumentsData {
+    documents: ProviderDocument[];
+}
+export interface RotateProviderKeyBody {
+    performedBy: string;
+    reason: string;
+}
+export interface RotateProviderKeyData {
+    tppCode: string;
+    apiKeyVersion: string;
+    lastKeyRotationDate: string;
+    updatedDate: string;
+}
+export interface ProviderMerchantsQueryParams extends PaginationParams {
+    status?: string;
+    riskRating?: string;
+}
+export interface ProviderMerchantItem {
+    merchantName: string;
+    merchantCode: string;
+    createdDate: string;
+    kycExpiryDate: string;
+    merchantStatus: string;
+    riskRating: string;
+}
+export interface ProviderApplicationsQueryParams extends PaginationParams {
+    status?: string;
+    accessLevel?: string;
+}
+export interface ProviderApplicationItem {
+    applicationDisplayName: string;
+    applicationCode: string;
+    applicationCategory: string;
+    apiAccessLevel: string;
+    applicationStatus: string;
+    riskRating: string;
+    cbnApproved: string;
+}
+export type ProvidersListSuccessResponse = ApiSuccessResponse<PaginatedData<ProviderListItem>>;
+export type CreateProviderSuccessResponse = ApiSuccessResponse<ProviderCreatedData>;
+export type ProviderDetailSuccessResponse = ApiSuccessResponse<ProviderDetail>;
+export type ProviderDocumentsSuccessResponse = ApiSuccessResponse<ProviderDocumentsData>;
+export type RotateProviderKeySuccessResponse = ApiSuccessResponse<RotateProviderKeyData>;
+export type ProviderMerchantsSuccessResponse = ApiSuccessResponse<PartialPaginatedData<ProviderMerchantItem>>;
+export type ProviderApplicationsSuccessResponse = ApiSuccessResponse<PartialPaginatedData<ProviderApplicationItem>>;

package/dist/types/features/purposes/api.d.ts

@@ -0,0 +1,8 @@
+import { BulkPurposeStatusUpdateBody, BulkPurposeStatusUpdateSuccessResponse, CreatePurposeBody, CreatePurposeSuccessResponse, PurposeDetailSuccessResponse, PurposeUsageQueryParams, PurposeUsageSuccessResponse, PurposesListQueryParams, PurposesListSuccessResponse, UpdatePurposeBody, UpdatePurposeStatusBody, UpdatePurposeStatusSuccessResponse, UpdatePurposeSuccessResponse } from "./types";
+export declare const listPurposes: (params?: PurposesListQueryParams) => Promise<PurposesListSuccessResponse>;
+export declare const createPurpose: (payload: CreatePurposeBody) => Promise<CreatePurposeSuccessResponse>;
+export declare const getPurposeByCode: (code: string) => Promise<PurposeDetailSuccessResponse>;
+export declare const updatePurpose: (code: string, payload: UpdatePurposeBody) => Promise<UpdatePurposeSuccessResponse>;
+export declare const updatePurposeStatus: (code: string, payload: UpdatePurposeStatusBody) => Promise<UpdatePurposeStatusSuccessResponse>;
+export declare const getPurposeUsage: (code: string, params?: PurposeUsageQueryParams) => Promise<PurposeUsageSuccessResponse>;
+export declare const bulkUpdatePurposeStatus: (payload: BulkPurposeStatusUpdateBody) => Promise<BulkPurposeStatusUpdateSuccessResponse>;

package/dist/types/features/purposes/types.d.ts

@@ -0,0 +1,135 @@
+import { ApiSuccessResponse, PaginatedData, PaginationParams } from "../../shared/types";
+export interface PurposesListQueryParams extends PaginationParams {
+    search?: string;
+    purposeStatus?: string;
+    amlRiskLevel?: string;
+    purposeCategory?: string;
+    regulatoryAction?: string;
+    applicableChannel?: string;
+    systemDefined?: string | boolean;
+}
+export interface PurposeListItem {
+    purposeName: string;
+    purposeCode: string;
+    cbnPurposeCode: string;
+    purposeCategory: string;
+    purposeType: string;
+    purposeStatus: string;
+    amlRiskLevel: string;
+    applicableChannels: string;
+    usageCount30d: number;
+    lastUsedAt: string;
+    createdDate: string;
+    updatedDate: string;
+    systemDefined: string;
+    requiresDocumentation: string;
+    requiresApproval: string;
+    requiresEdd: string;
+    dailyTransactionLimit: number;
+    limitCurrency: number;
+}
+export interface CreatePurposeBody {
+    purposeName: string;
+    purposeCode: string;
+    description: string;
+    purposeCategory: string;
+    purposeType: string;
+    cbnPurposeCode: string;
+    amlRiskLevel: string;
+    purposeStatus: string;
+    requiresDocumentation: string;
+    requiresApproval: string;
+    requiresEdd: string;
+    applicableChannels: string[];
+    dailyTransactionLimit: number;
+    limitCurrency: number;
+    effectiveStartDate: string;
+    effectiveEndDate: string;
+    systemDefined: string;
+}
+export type UpdatePurposeBody = CreatePurposeBody;
+export interface PurposeCreatedData {
+    uuid: string;
+    purposeCode: string;
+    purposeName: string;
+    purposeStatus: string;
+    createdDate: string;
+    updatedDate: string;
+}
+export interface PurposeDetail {
+    purposeName: string;
+    purposeCode: string;
+    cbnPurposeCode: string;
+    purposeCategory: string;
+    purposeType: string;
+    applicableChannels: string;
+    dailyTransactionLimit: number;
+    limitCurrency: number;
+    description: string;
+    purposeStatus: string;
+    amlRiskLevel: string;
+    systemDefined: string;
+    requiresDocumentation: string;
+    requiresApproval: string;
+    requiresEdd: string;
+    effectiveStartDate: string;
+    effectiveEndDate: string;
+    usageCount30d: number;
+    lastUsedAt: string;
+    createdDate: string;
+    updatedDate: string;
+}
+export interface PurposeUpdatedData {
+    purposeCode: string;
+    purposeName: string;
+    purposeStatus: string;
+    amlRiskLevel: string;
+    applicableChannels: string;
+    updatedDate: string;
+}
+export interface UpdatePurposeStatusBody {
+    status: string;
+    reason: string;
+    performedBy: string;
+}
+export interface PurposeStatusUpdateData {
+    purposeCode: string;
+    purposeStatus: string;
+    updatedDate: string;
+}
+export interface PurposeUsageQueryParams {
+    window?: "30d" | "90d";
+}
+export interface PurposeUsageData {
+    purposeCode: string;
+    usageCount30d: number;
+    lastUsedAt: string;
+    channelBreakdown?: string;
+    applicationBreakdown?: string;
+    trendSeries?: string;
+}
+export interface BulkPurposeStatusUpdateFilters {
+    search?: string;
+    purposeStatus?: string;
+    amlRiskLevel?: string;
+    purposeCategory?: string;
+    regulatoryAction?: string;
+    applicableChannel?: string;
+    systemDefined?: string | boolean;
+}
+export interface BulkPurposeStatusUpdateBody {
+    status: string;
+    purposeCodes?: string[];
+    filters?: BulkPurposeStatusUpdateFilters;
+}
+export interface BulkPurposeStatusUpdateData {
+    affectedCount: number;
+    updatedAt: string;
+}
+export type PurposesListSuccessResponse = ApiSuccessResponse<PaginatedData<PurposeListItem>>;
+export type CreatePurposeSuccessResponse = ApiSuccessResponse<PurposeCreatedData>;
+export type PurposeDetailSuccessResponse = ApiSuccessResponse<PurposeDetail>;
+export type UpdatePurposeSuccessResponse = ApiSuccessResponse<PurposeUpdatedData>;
+export type UpdatePurposeStatusSuccessResponse = ApiSuccessResponse<PurposeStatusUpdateData>;
+export type PurposeUsageSuccessResponse = ApiSuccessResponse<PurposeUsageData>;
+export type BulkPurposeStatusUpdateSuccessResponse = ApiSuccessResponse<BulkPurposeStatusUpdateData>;

package/dist/types/index.d.ts

@@ -0,0 +1,20 @@
+export * from "./shared/config/api.config";
+export * from "./shared/api/client";
+export * from "./shared/api/endpoints";
+export * from "./shared/types";
+export * as ApplicationsApi from "./features/applications/api";
+export * as ConsentsApi from "./features/consents/api";
+export * as CustomersApi from "./features/customers/api";
+export * as DashboardApi from "./features/dashboard/api";
+export * as HealthApi from "./features/health/api";
+export * as MerchantsApi from "./features/merchants/api";
+export * as ProvidersApi from "./features/providers/api";
+export * as PurposesApi from "./features/purposes/api";
+export type * from "./features/applications/types";
+export type * from "./features/consents/types";
+export type * from "./features/customers/types";
+export type * from "./features/dashboard/types";
+export type * from "./features/health/types";
+export type * from "./features/merchants/types";
+export type * from "./features/providers/types";
+export type * from "./features/purposes/types";

package/dist/types/shared/api/client.d.ts

@@ -0,0 +1,2 @@
+import { AxiosInstance } from "axios";
+export declare const apiClient: AxiosInstance;

package/dist/types/shared/api/endpoints/applications.endpoints.d.ts

@@ -0,0 +1,7 @@
+export declare const applicationsEndpoints: {
+    readonly list: "/ob/applications";
+    readonly create: "/ob/applications";
+    readonly detail: (code: string) => string;
+    readonly updateStatus: (code: string) => string;
+    readonly updateConfiguration: (code: string) => string;
+};

package/dist/types/shared/api/endpoints/consents.endpoints.d.ts

@@ -0,0 +1,7 @@
+export declare const consentsEndpoints: {
+    readonly list: "/ob/consents";
+    readonly detail: (reference: string) => string;
+    readonly updateStatus: (reference: string) => string;
+    readonly notify: (reference: string) => string;
+    readonly bulkRevoke: "/ob/consents/bulk-revoke";
+};

package/dist/types/shared/api/endpoints/customers.endpoints.d.ts

@@ -0,0 +1,13 @@
+export declare const customersEndpoints: {
+    readonly list: "/ob/customers";
+    readonly create: "/ob/customers";
+    readonly detail: (reference: string) => string;
+    readonly identification: (reference: string) => string;
+    readonly contactAddress: (reference: string) => string;
+    readonly employmentBusiness: (reference: string) => string;
+    readonly reviewKyc: (reference: string) => string;
+    readonly reviewSteps: (reference: string) => string;
+    readonly consentHistory: (reference: string) => string;
+    readonly revokeConsent: (reference: string) => string;
+    readonly interactions: (reference: string) => string;
+};

package/dist/types/shared/api/endpoints/dashboard.endpoints.d.ts

@@ -0,0 +1,7 @@
+export declare const dashboardEndpoints: {
+    readonly summary: "/ob/dashboard/summary";
+    readonly apiPerformance: "/ob/dashboard/analytics/api-performance";
+    readonly topApis: "/ob/dashboard/analytics/top-apis";
+    readonly topTpps: "/ob/dashboard/analytics/top-tpps";
+    readonly recentAlarms: "/ob/dashboard/alarms/recent";
+};

package/dist/types/shared/api/endpoints/health.endpoints.d.ts

@@ -0,0 +1,3 @@
+export declare const healthEndpoints: {
+    readonly check: "/healthz";
+};

package/dist/types/shared/api/endpoints/index.d.ts

@@ -0,0 +1,66 @@
+export declare const API_ENDPOINTS: {
+    readonly applications: {
+        readonly list: "/ob/applications";
+        readonly create: "/ob/applications";
+        readonly detail: (code: string) => string;
+        readonly updateStatus: (code: string) => string;
+        readonly updateConfiguration: (code: string) => string;
+    };
+    readonly consents: {
+        readonly list: "/ob/consents";
+        readonly detail: (reference: string) => string;
+        readonly updateStatus: (reference: string) => string;
+        readonly notify: (reference: string) => string;
+        readonly bulkRevoke: "/ob/consents/bulk-revoke";
+    };
+    readonly customers: {
+        readonly list: "/ob/customers";
+        readonly create: "/ob/customers";
+        readonly detail: (reference: string) => string;
+        readonly identification: (reference: string) => string;
+        readonly contactAddress: (reference: string) => string;
+        readonly employmentBusiness: (reference: string) => string;
+        readonly reviewKyc: (reference: string) => string;
+        readonly reviewSteps: (reference: string) => string;
+        readonly consentHistory: (reference: string) => string;
+        readonly revokeConsent: (reference: string) => string;
+        readonly interactions: (reference: string) => string;
+    };
+    readonly dashboard: {
+        readonly summary: "/ob/dashboard/summary";
+        readonly apiPerformance: "/ob/dashboard/analytics/api-performance";
+        readonly topApis: "/ob/dashboard/analytics/top-apis";
+        readonly topTpps: "/ob/dashboard/analytics/top-tpps";
+        readonly recentAlarms: "/ob/dashboard/alarms/recent";
+    };
+    readonly health: {
+        readonly check: "/healthz";
+    };
+    readonly merchants: {
+        readonly list: "/ob/merchants";
+        readonly create: "/ob/merchants";
+        readonly detail: (code: string) => string;
+        readonly updateStatus: (code: string) => string;
+        readonly initiateSettlement: (code: string) => string;
+        readonly bulkSettlementHold: "/ob/merchants/settlements/hold";
+    };
+    readonly providers: {
+        readonly list: "/ob/providers";
+        readonly create: "/ob/providers";
+        readonly detail: (code: string) => string;
+        readonly documents: (code: string) => string;
+        readonly rotateKey: (code: string) => string;
+        readonly merchants: (code: string) => string;
+        readonly applications: (code: string) => string;
+    };
+    readonly purposes: {
+        readonly list: "/ob/purposes";
+        readonly create: "/ob/purposes";
+        readonly detail: (code: string) => string;
+        readonly update: (code: string) => string;
+        readonly updateStatus: (code: string) => string;
+        readonly usage: (code: string) => string;
+        readonly bulkStatusUpdate: "/ob/purposes/status/bulk";
+    };
+};
+export type ApiEndpoints = typeof API_ENDPOINTS;

package/dist/types/shared/api/endpoints/merchants.endpoints.d.ts

@@ -0,0 +1,8 @@
+export declare const merchantsEndpoints: {
+    readonly list: "/ob/merchants";
+    readonly create: "/ob/merchants";
+    readonly detail: (code: string) => string;
+    readonly updateStatus: (code: string) => string;
+    readonly initiateSettlement: (code: string) => string;
+    readonly bulkSettlementHold: "/ob/merchants/settlements/hold";
+};

package/dist/types/shared/api/endpoints/providers.endpoints.d.ts

@@ -0,0 +1,9 @@
+export declare const providersEndpoints: {
+    readonly list: "/ob/providers";
+    readonly create: "/ob/providers";
+    readonly detail: (code: string) => string;
+    readonly documents: (code: string) => string;
+    readonly rotateKey: (code: string) => string;
+    readonly merchants: (code: string) => string;
+    readonly applications: (code: string) => string;
+};

package/dist/types/shared/api/endpoints/purposes.endpoints.d.ts

@@ -0,0 +1,9 @@
+export declare const purposesEndpoints: {
+    readonly list: "/ob/purposes";
+    readonly create: "/ob/purposes";
+    readonly detail: (code: string) => string;
+    readonly update: (code: string) => string;
+    readonly updateStatus: (code: string) => string;
+    readonly usage: (code: string) => string;
+    readonly bulkStatusUpdate: "/ob/purposes/status/bulk";
+};

package/dist/types/shared/api/endpoints.d.ts

@@ -0,0 +1 @@
+export * from "./endpoints/index";

package/dist/types/shared/config/api.config.d.ts

@@ -0,0 +1,22 @@
+export type AccessTokenProvider = () => string | undefined | Promise<string | undefined>;
+export interface BackofficeOpenBankingSdkConfig {
+    baseURL?: string;
+    timeout?: number;
+    headers?: Record<string, string>;
+    getAccessToken?: AccessTokenProvider;
+    requireAuth?: boolean;
+    onUnauthorized?: (error: unknown) => void | Promise<void>;
+}
+export declare class MissingAccessTokenError extends Error {
+    constructor();
+}
+export declare function setApiBaseUrl(url: string): void;
+export declare function setAccessTokenProvider(provider: AccessTokenProvider | undefined): void;
+export declare function configureBackofficeOpenBankingSdk(config: BackofficeOpenBankingSdkConfig): void;
+export declare function getApiBaseUrl(): string;
+export declare function getAccessTokenProvider(): AccessTokenProvider | undefined;
+export declare function getDefaultHeaders(): Record<string, string>;
+export declare function getUnauthorizedHandler(): BackofficeOpenBankingSdkConfig["onUnauthorized"] | undefined;
+export declare function getApiTimeout(): number;
+export declare function shouldRequireAuth(): boolean;
+export declare const API_TIMEOUT: number;

package/dist/types/shared/types/index.d.ts

@@ -0,0 +1,37 @@
+export interface PaginationParams {
+    page?: number | string;
+    limit?: number | string;
+}
+export interface PaginatedData<T> {
+    data: T[];
+    total: number;
+    page: number;
+    limit: number;
+}
+export interface PartialPaginatedData<T> {
+    data: T[];
+    total?: number;
+    page?: number;
+    limit?: number;
+}
+export type EmptyObject = Record<string, never>;
+export type OpaqueData = Record<string, unknown>;
+export interface ApiSuccessResponse<T> {
+    status: "success";
+    data: T;
+}
+export interface ApiFailResponse {
+    status: "fail";
+    data: Record<string, string>;
+}
+export interface ApiErrorResponse {
+    status: "error";
+    message: string;
+    code: string;
+}
+export type ApiResponse<T> = ApiSuccessResponse<T> | ApiFailResponse | ApiErrorResponse;
+export interface ApiError {
+    message: string;
+    code: string;
+    details?: Record<string, unknown>;
+}