@havenpay/server 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,479 @@
+import { AccountRole, AccountCapabilities, AccountStatus, Environment, Currency, LedgerEntryType, ProviderId, PaymentMethodType, ProjectAppearance, WebhookEventType, WebhookEndpointStatus, WebhookEventStatus, PaymentIntentStatus, ProjectStatus, ProviderCredentialStatus, RefundStatus } from '@havenpay/core';
+import { ApiV1OperationId } from '@havenpay/core/api-v1';
+
+interface HavenpayApiErrorDetails {
+    code?: string;
+    message?: string;
+    requestId?: string;
+    type?: string;
+}
+interface HavenpayApiErrorOptions {
+    body: string;
+    error?: HavenpayApiErrorDetails;
+    requestId?: string;
+    status: number;
+}
+declare class HavenpayApiError extends Error {
+    readonly body: string;
+    readonly code?: string;
+    readonly error?: HavenpayApiErrorDetails;
+    readonly requestId?: string;
+    readonly status: number;
+    readonly type?: string;
+    constructor(options: HavenpayApiErrorOptions);
+}
+declare class HavenpayTimeoutError extends Error {
+    readonly timeoutMs: number;
+    constructor(timeoutMs: number);
+}
+
+interface HavenpayConfig {
+    secretKey: string;
+    apiVersion?: string;
+    baseUrl?: string;
+    onRequestEvent?: (event: HavenpayRequestEvent) => void;
+    retry?: HavenpayRetryConfig;
+    timeoutMs?: number;
+}
+interface HavenpayRequestEvent {
+    attempt: number;
+    errorKind?: 'api_error' | 'network_error' | 'timeout';
+    method: string;
+    operationName?: ApiV1OperationId;
+    path: string;
+    requestId?: string;
+    status?: number;
+    type: 'request_error' | 'request_retry' | 'request_start' | 'request_success';
+}
+interface HavenpayRetryConfig {
+    initialDelayMs?: number;
+    maxAttempts?: number;
+    maxDelayMs?: number;
+    sleep?: (delayMs: number) => Promise<void>;
+}
+interface CreatePaymentIntentParams {
+    projectId: string;
+    amount: number;
+    currency: Currency;
+    customer: {
+        phone?: string;
+        email?: string;
+    };
+    metadata?: Record<string, string>;
+    mobileMoney: {
+        provider: ProviderId;
+        phone: string;
+    };
+    idempotencyKey?: string;
+}
+interface PaymentIntentResponse {
+    id: string;
+    amount: number;
+    currency: Currency;
+    status: PaymentIntentStatus;
+    clientSecret: string;
+    requestId?: string;
+    customer?: {
+        phone?: string;
+        email?: string;
+    };
+    nextAction?: Record<string, unknown>;
+}
+interface CreateRefundParams {
+    paymentIntentId: string;
+    amount?: number;
+    reason?: string;
+    idempotencyKey?: string;
+}
+interface RetrieveRefundParams {
+    projectId?: string;
+}
+interface ListRefundsParams {
+    idempotencyKey?: string;
+    limit?: number;
+    projectId?: string;
+    providerRefundReference?: string;
+    startingAfter?: string;
+}
+interface RefundResponse {
+    id: string;
+    amount: number;
+    currency: Currency;
+    idempotencyKey: string;
+    ledgerEntryId: string | null;
+    paymentIntentId: string;
+    projectId: string;
+    provider: ProviderId;
+    providerErrorCode: string | null;
+    providerExecution: 'attempted' | 'disabled';
+    providerRefundReference: string | null;
+    reason: string | null;
+    requestId?: string;
+    status: RefundStatus;
+}
+interface RefundListResponse {
+    data: RefundResponse[];
+    hasMore: boolean;
+    nextCursor?: string;
+    requestId?: string;
+}
+interface CreateProviderAccountParams {
+    encryptedCredentialRef: string;
+    keyFingerprint: string;
+    metadata?: Record<string, unknown>;
+    projectId: string;
+    provider: ProviderId;
+}
+interface RotateProviderAccountParams {
+    encryptedCredentialRef: string;
+    keyFingerprint: string;
+    metadata?: Record<string, unknown>;
+}
+interface ListProviderAccountsParams {
+    limit?: number;
+    projectId?: string;
+    startingAfter?: string;
+}
+interface ProviderAccountResponse {
+    accountId: string;
+    createdAt: string;
+    environment: Environment;
+    id: string;
+    keyFingerprint: string;
+    metadata: Record<string, unknown>;
+    projectId: string;
+    provider: ProviderId;
+    requestId?: string;
+    revokedAt: string | null;
+    rotatedFrom?: string;
+    status: ProviderCredentialStatus;
+    updatedAt: string;
+}
+interface ProviderAccountListResponse {
+    data: ProviderAccountResponse[];
+    hasMore: boolean;
+    nextCursor?: string;
+    requestId?: string;
+}
+interface ListBalanceTransactionsParams {
+    currency?: Currency;
+    limit?: number;
+    paymentIntentId?: string;
+    projectId?: string;
+    startingAfter?: string;
+}
+interface BalanceTransactionResponse {
+    accountId: string;
+    amount: number;
+    balanceAfter: number;
+    balanceBefore: number;
+    createdAt: string;
+    currency: Currency;
+    description: string;
+    id: string;
+    metadata: Record<string, unknown>;
+    paymentIntentId: string | null;
+    projectId: string | null;
+    requestId?: string;
+    type: LedgerEntryType;
+}
+interface BalanceTransactionListResponse {
+    data: BalanceTransactionResponse[];
+    hasMore: boolean;
+    nextCursor?: string;
+    requestId?: string;
+}
+interface CreateProjectParams {
+    allowedBundleIds?: string[];
+    allowedCurrencies?: Currency[];
+    allowedOrigins?: string[];
+    allowedPaymentMethods?: PaymentMethodType[];
+    allowedReturnUrls?: string[];
+    appearance?: ProjectAppearance;
+    displayName: string;
+    environment: Environment;
+    rateLimitProfile?: string;
+}
+interface UpdateProjectParams {
+    allowedBundleIds?: string[];
+    allowedCurrencies?: Currency[];
+    allowedOrigins?: string[];
+    allowedPaymentMethods?: PaymentMethodType[];
+    allowedReturnUrls?: string[];
+    appearance?: ProjectAppearance;
+    displayName?: string;
+    rateLimitProfile?: string;
+    status?: ProjectStatus;
+}
+interface ListProjectsParams {
+    limit?: number;
+    startingAfter?: string;
+}
+interface ProjectResponse {
+    accountId?: string;
+    allowedBundleIds?: string[];
+    allowedCurrencies: Currency[];
+    allowedOrigins?: string[];
+    allowedPaymentMethods: PaymentMethodType[];
+    allowedReturnUrls?: string[];
+    appearance: ProjectAppearance;
+    archived?: boolean;
+    createdAt?: string;
+    deleted?: boolean;
+    displayName: string;
+    environment: Environment;
+    id: string;
+    paymentHistoryCount?: number;
+    rateLimitProfile?: string;
+    requestId?: string;
+    status: ProjectStatus;
+    updatedAt?: string;
+}
+interface ProjectListResponse {
+    data: ProjectResponse[];
+    hasMore: boolean;
+    nextCursor?: string;
+    requestId?: string;
+}
+interface CreateApiKeyParams {
+    displayName: string;
+    scopes?: string[];
+}
+interface ListApiKeysParams {
+    accountId?: string;
+    limit?: number;
+    startingAfter?: string;
+}
+interface ApiKeyResponse {
+    accountId: string;
+    createdAt: string;
+    displayName: string;
+    environment: Environment;
+    expiresAt: string | null;
+    id: string;
+    lastUsedAt: string | null;
+    prefix: string;
+    requestId?: string;
+    revokedAt: string | null;
+    scopes: string[];
+    secretKey?: string;
+}
+interface ApiKeyListResponse {
+    data: ApiKeyResponse[];
+    hasMore: boolean;
+    nextCursor?: string;
+    requestId?: string;
+}
+interface CreateAccountParams {
+    capabilities?: Partial<AccountCapabilities>;
+    displayName: string;
+    email: string;
+    metadata?: Record<string, unknown>;
+}
+interface UpdateAccountParams {
+    capabilities?: Partial<AccountCapabilities>;
+    displayName?: string;
+    email?: string;
+    livemode?: boolean;
+    metadata?: Record<string, unknown>;
+    status?: AccountStatus;
+}
+interface ListAccountsParams {
+    limit?: number;
+    startingAfter?: string;
+}
+interface AccountResponse {
+    accountRole: AccountRole;
+    capabilities: AccountCapabilities;
+    createdAt: string;
+    displayName: string;
+    email: string;
+    id: string;
+    livemode: boolean;
+    metadata: Record<string, unknown>;
+    ownerAccountId: string | null;
+    requestId?: string;
+    status: AccountStatus;
+    updatedAt: string;
+}
+interface AccountListResponse {
+    data: AccountResponse[];
+    hasMore: boolean;
+    nextCursor?: string;
+    requestId?: string;
+}
+interface CreateWebhookEndpointParams {
+    apiVersion?: string;
+    description?: string;
+    enabledEvents?: WebhookEventType[];
+    status?: WebhookEndpointStatus;
+    url: string;
+}
+interface UpdateWebhookEndpointParams {
+    apiVersion?: string;
+    description?: string;
+    enabledEvents?: WebhookEventType[];
+    status?: WebhookEndpointStatus;
+    url?: string;
+}
+interface ListWebhookEndpointsParams {
+    accountId?: string;
+    limit?: number;
+    startingAfter?: string;
+}
+interface WebhookEndpointResponse {
+    accountId: string;
+    apiVersion: string;
+    createdAt: string;
+    deleted?: boolean;
+    description?: string;
+    enabledEvents: WebhookEventType[];
+    id: string;
+    requestId?: string;
+    signingSecret?: string;
+    status: WebhookEndpointStatus;
+    updatedAt: string;
+    url: string;
+}
+interface WebhookEndpointListResponse {
+    data: WebhookEndpointResponse[];
+    hasMore: boolean;
+    nextCursor?: string;
+    requestId?: string;
+}
+interface ListEventsParams {
+    limit?: number;
+    projectId?: string;
+    startingAfter?: string;
+}
+interface EventResponse {
+    accountId: string;
+    apiVersion: string;
+    created: string;
+    data: Record<string, unknown>;
+    id: string;
+    livemode: boolean;
+    objectId: string;
+    pendingWebhookEndpoints: string[];
+    projectId: string;
+    requestId?: string;
+    status: WebhookEventStatus;
+    type: WebhookEventType;
+}
+interface EventListResponse {
+    data: EventResponse[];
+    hasMore: boolean;
+    nextCursor?: string;
+    requestId?: string;
+}
+interface ReplayEventResponse {
+    id: string;
+    requestId?: string;
+    status: WebhookEventStatus;
+}
+interface ConstructWebhookEventParams {
+    rawBody: string;
+    signature: string;
+    secret: string;
+    toleranceSeconds?: number;
+}
+interface WebhookEvent {
+    id: string;
+    type: string;
+    created: string;
+    data: Record<string, unknown>;
+}
+
+declare class Accounts {
+    private config;
+    constructor(config: HavenpayConfig);
+    create(params: CreateAccountParams): Promise<AccountResponse>;
+    list(params?: ListAccountsParams): Promise<AccountListResponse>;
+    update(id: string, params: UpdateAccountParams): Promise<AccountResponse>;
+}
+
+declare class ApiKeys {
+    private config;
+    constructor(config: HavenpayConfig);
+    create(params: CreateApiKeyParams): Promise<ApiKeyResponse>;
+    list(params?: ListApiKeysParams): Promise<ApiKeyListResponse>;
+    revoke(id: string): Promise<ApiKeyResponse>;
+}
+
+declare class BalanceTransactions {
+    private config;
+    constructor(config: HavenpayConfig);
+    list(params?: ListBalanceTransactionsParams): Promise<BalanceTransactionListResponse>;
+}
+
+declare class Events {
+    private config;
+    constructor(config: HavenpayConfig);
+    list(params?: ListEventsParams): Promise<EventListResponse>;
+    replay(id: string): Promise<ReplayEventResponse>;
+}
+
+declare class PaymentIntents {
+    private config;
+    constructor(config: HavenpayConfig);
+    create(params: CreatePaymentIntentParams): Promise<PaymentIntentResponse>;
+    retrieve(id: string): Promise<PaymentIntentResponse>;
+}
+
+declare class Projects {
+    private config;
+    constructor(config: HavenpayConfig);
+    create(params: CreateProjectParams): Promise<ProjectResponse>;
+    list(params?: ListProjectsParams): Promise<ProjectListResponse>;
+    update(id: string, params: UpdateProjectParams): Promise<ProjectResponse>;
+    archive(id: string): Promise<ProjectResponse>;
+    getConfig(id: string): Promise<ProjectResponse>;
+}
+
+declare class ProviderAccounts {
+    private config;
+    constructor(config: HavenpayConfig);
+    create(params: CreateProviderAccountParams): Promise<ProviderAccountResponse>;
+    list(params?: ListProviderAccountsParams): Promise<ProviderAccountListResponse>;
+    rotate(id: string, params: RotateProviderAccountParams): Promise<ProviderAccountResponse>;
+    revoke(id: string): Promise<ProviderAccountResponse>;
+}
+
+declare class Refunds {
+    private config;
+    constructor(config: HavenpayConfig);
+    create(params: CreateRefundParams): Promise<RefundResponse>;
+    retrieve(id: string, params?: RetrieveRefundParams): Promise<RefundResponse>;
+    list(params?: ListRefundsParams): Promise<RefundListResponse>;
+}
+
+declare class WebhookEndpoints {
+    private config;
+    constructor(config: HavenpayConfig);
+    create(params: CreateWebhookEndpointParams): Promise<WebhookEndpointResponse>;
+    list(params?: ListWebhookEndpointsParams): Promise<WebhookEndpointListResponse>;
+    update(id: string, params: UpdateWebhookEndpointParams): Promise<WebhookEndpointResponse>;
+    rotateSecret(id: string): Promise<WebhookEndpointResponse>;
+    delete(id: string): Promise<WebhookEndpointResponse>;
+}
+
+declare class Webhooks {
+    constructEvent(params: ConstructWebhookEventParams): WebhookEvent;
+}
+
+declare class Havenpay {
+    private config;
+    accounts: Accounts;
+    apiKeys: ApiKeys;
+    balanceTransactions: BalanceTransactions;
+    events: Events;
+    paymentIntents: PaymentIntents;
+    projects: Projects;
+    providerAccounts: ProviderAccounts;
+    refunds: Refunds;
+    webhookEndpoints: WebhookEndpoints;
+    webhooks: Webhooks;
+    constructor(config: HavenpayConfig);
+}
+
+export { type AccountListResponse, type AccountResponse, type ApiKeyListResponse, type ApiKeyResponse, type BalanceTransactionListResponse, type BalanceTransactionResponse, type ConstructWebhookEventParams, type CreateAccountParams, type CreateApiKeyParams, type CreatePaymentIntentParams, type CreateProjectParams, type CreateProviderAccountParams, type CreateRefundParams, type CreateWebhookEndpointParams, type EventListResponse, type EventResponse, Havenpay, HavenpayApiError, type HavenpayConfig, type HavenpayRequestEvent, type HavenpayRetryConfig, HavenpayTimeoutError, type ListAccountsParams, type ListApiKeysParams, type ListBalanceTransactionsParams, type ListEventsParams, type ListProjectsParams, type ListProviderAccountsParams, type ListRefundsParams, type ListWebhookEndpointsParams, type PaymentIntentResponse, type ProjectListResponse, type ProjectResponse, type ProviderAccountListResponse, type ProviderAccountResponse, type RefundListResponse, type RefundResponse, type ReplayEventResponse, type RetrieveRefundParams, type RotateProviderAccountParams, type UpdateAccountParams, type UpdateProjectParams, type UpdateWebhookEndpointParams, type WebhookEndpointListResponse, type WebhookEndpointResponse, type WebhookEvent };