vesant-sdk 1.6.0 → 1.6.2

package/dist/index.d.ts

@@ -1,14 +1,15 @@
-import { L as Logger, B as BaseClient, a as BaseClientConfig, R as RequestOptions } from './client-CIon-bGS.js';
-export { d as CGSConfig, i as CircuitBreaker, C as CircuitBreakerConfig, g as CircuitBreakerState, h as CircuitBreakerStatus, j as RateLimitStatus, k as RateLimitTracker, b as RequestInterceptor, f as RequiredBaseClientConfig, e as RequiredCGSConfig, c as RequiredVesantConfig, V as VesantConfig } from './client-CIon-bGS.js';
+import { L as Logger, B as BaseClient, a as BaseClientConfig, R as RequestOptions } from './client-ePzhQKp9.js';
+export { d as CGSConfig, i as CircuitBreaker, C as CircuitBreakerConfig, g as CircuitBreakerState, h as CircuitBreakerStatus, j as RateLimitStatus, k as RateLimitTracker, b as RequestInterceptor, f as RequiredBaseClientConfig, e as RequiredCGSConfig, c as RequiredVesantConfig, V as VesantConfig } from './client-ePzhQKp9.js';
 import { T as Timestamp } from './types-B4Ezqo7V.js';
 export { A as APIResponse, C as CustomerStatus, E as EntityType, b as ErrorResponse, L as LocationCompliance, a as PaginatedResponse, P as PaginationParams, c as Result, R as RiskLevel, S as SuccessResponse, U as UUID, V as VerificationEventType } from './types-B4Ezqo7V.js';
 export { BaseWebhookEvent, ComplianceCheckFailedPayload, DecisionRecordedPayload, GeolocationBlockedPayload, GeolocationVerifiedPayload, KycStatusChangedPayload, LabelAppliedPayload, LocationRequestCompletedPayload, ProfileCreatedPayload, ProfileUpdatedPayload, RiskCategoryChangedPayload, RiskScoreChangedPayload, WebhookAnyHandler, WebhookEvent, WebhookEventHandler, WebhookEventType, WebhookHandler, WebhookHandlerConfig, WebhookMiddlewareOptions, createNextWebhookHandler, createWebhookMiddleware, verifyWebhookSignature } from './webhooks/index.js';
-export { M as APIError, u as AlertFilters, v as AlertListResponse, r as AlertSeverity, A as AlertStatus, s as AlertType, j as CipherTextCustomerData, C as CipherTextOptions, g as CipherTextPayload, h as CipherTextReason, f as CipherTextResult, q as ComplianceCheckResponse, F as CreateGeofenceRuleRequest, x as CreateJurisdictionRequest, W as CreateLocationRequestRequest, w as DashboardMetrics, i as DecryptedCipherText, o as DeviceFingerprint, D as DeviceFingerprintRequest, p as DeviceTrustResult, m as GeoIPResult, B as GeofenceAction, n as GeofenceEvaluation, E as GeofenceRule, z as GeofenceRuleType, t as GeolocationAlert, G as GeolocationClient, O as GeolocationClientConfig, N as GeolocationConfigResponse, K as GeolocationRecord, J as JurisdictionConfig, a0 as LocationCaptureRequest, a2 as LocationCaptureResponse, T as LocationRequest, S as LocationRequestChannel, Y as LocationRequestFilters, Z as LocationRequestListResponse, X as LocationRequestResult, R as LocationRequestStatus, a1 as LocationShareInfo, L as LocationVerification, _ as ResendLocationRequestRequest, I as UpdateDeviceTrustRequest, H as UpdateGeofenceRuleRequest, y as UpdateJurisdictionRequest, P as UseAlertsOptions, Q as UseAlertsResult, U as UseGeolocationOptions, a as UseGeolocationResult, d as UseLocationCaptureOptions, e as UseLocationCaptureResult, b as UseLocationRequestsOptions, c as UseLocationRequestsResult, V as ValidateCipherTextRequest, k as ValidateCipherTextResponse, l as VerifyIPRequest, $ as WiFiNetwork } from './client-Bd9a5o0C.js';
+export { B as APIError, p as AlertFilters, q as AlertListResponse, m as AlertSeverity, A as AlertStatus, n as AlertType, e as CipherTextCustomerData, b as CipherTextOptions, C as CipherTextPayload, a as CipherTextReason, c as CipherTextResult, l as ComplianceCheckResponse, w as CreateGeofenceRuleRequest, s as CreateJurisdictionRequest, Q as CreateLocationRequestRequest, r as DashboardMetrics, d as DecryptedCipherText, j as DeviceFingerprint, D as DeviceFingerprintRequest, k as DeviceTrustResult, h as GeoIPResult, u as GeofenceAction, i as GeofenceEvaluation, v as GeofenceRule, t as GeofenceRuleType, o as GeolocationAlert, G as GeolocationClient, F as GeolocationClientConfig, E as GeolocationConfigResponse, z as GeolocationRecord, J as JurisdictionConfig, Y as LocationCaptureRequest, _ as LocationCaptureResponse, P as LocationRequest, O as LocationRequestChannel, S as LocationRequestFilters, T as LocationRequestListResponse, R as LocationRequestResult, N as LocationRequestStatus, Z as LocationShareInfo, L as LocationVerification, W as ResendLocationRequestRequest, y as UpdateDeviceTrustRequest, x as UpdateGeofenceRuleRequest, U as UpdateJurisdictionRequest, K as UseAlertsOptions, M as UseAlertsResult, H as UseGeolocationOptions, I as UseGeolocationResult, a1 as UseLocationCaptureOptions, a2 as UseLocationCaptureResult, $ as UseLocationRequestsOptions, a0 as UseLocationRequestsResult, V as ValidateCipherTextRequest, f as ValidateCipherTextResponse, g as VerifyIPRequest, X as WiFiNetwork } from './client-C_A7QLcB.js';
 export { decodeCipherText, generateCipherText, isCipherTextExpired } from './geolocation/index.js';
 export { RiskProfileClient } from './risk-profile/index.js';
 export { d as CreateCustomerProfileRequest, d as CreateProfileRequest, C as CustomerProfile, e as CustomerProfileFilters, f as CustomerProfileListResponse, E as EmploymentType, L as LegalForm, P as ProfileDetailsResponse, e as ProfileFilters, f as ProfileListResponse, R as RiskCategory, h as RiskConfiguration, g as RiskDashboardMetrics, a as RiskFactor, b as RiskFactorType, c as RiskHistory, S as ScreeningStatus, U as UpdateProfileRequest } from './types-X5Md_dD_.js';
 export { ComplianceClient, ComplianceLocationRequestInput, ComplianceLocationRequestResult, CurrencyRates, DEFAULT_CURRENCY_RATES, EventVerificationRequest, EventVerificationResponse, LoginVerificationRequest, LoginVerificationResponse, RegistrationVerificationRequest, RegistrationVerificationResponse, TransactionRiskResult, TransactionVerificationRequest, TransactionVerificationResponse } from './compliance/index.js';
 export { CheckKycStatusRequest, CheckKycStatusResponse, CreateReuseKycSessionRequest, CreateReuseKycSessionResponse, DocumentType, DocumentVerificationRequest, DocumentVerificationResponse, FaceProof, KycAlert, KycAlertFilters, KycAlertListResponse, KycAlertStatus, KycAlertType, KycClient, KycClientConfig, KycCustomerProfile, KycOverview, KycPagination, KycPreferences, KycRequest, KycRequestFilters, KycRequestListResponse, KycStatus, Name, Proof, ProofDownloadURL, ProofType, RequestAdditionalDocumentsRequest, RequestKycSubmitLinkRequest, RequestKycSubmitLinkResponse, SubmitReuseKycSessionRequest, SubmittedDocument, SupportedDocumentType, UpdateKycAlertRequest, UpdateKycPreferencesRequest, UpdateKycStatusRequest, UseKycAlertsOptions, UseKycAlertsResult, UseKycOverviewOptions, UseKycOverviewResult, UseKycPreferencesResult, UseKycRequestsOptions, UseKycRequestsResult, UseKycSubmissionOptions, UseKycSubmissionResult } from './kyc/index.js';
+export { CTPFormStatus, CTPTINStatus, ComplianceStats, ComplianceStatsFilters, CustomerTaxProfileRecord, CustomerType, DocumentRequestBreakdown, EmailSendingMethod, EnableWithholdingInput, EnableWithholdingResponse, GlobalTaxRule, ReRequestTaxFormInput, TINCheckResult, TINStatusBreakdown, TaxClient, TaxClientConfig, TaxRuleApprovalStatus, TaxRuleVersion, TaxRules, TransactionAction, TreatyCountry, TreatyCountryListResponse, UpdateTaxRulesInput, WFormCountBreakdown, WFormStatusBreakdown } from './tax/index.js';
 
 /**
  * Error hierarchy for Vesant SDK
@@ -65,378 +66,7 @@ declare const noopLogger: Logger;
 /**
  * Single source of truth for the SDK version.
  */
-declare const SDK_VERSION = "1.6.0";
-
-/**
- * TypeScript type definitions for Vesant Tax Service API
- *
- * These types match the Go API structures in:
- * - services/transaction-monitoring-service/internal/domain/
- * - services/transaction-monitoring-service/internal/service/
- * - services/transaction-monitoring-service/internal/handler/
- */
-interface TaxConfig {
-    /** Whether tax compliance features are enabled for this tenant */
-    tax_enabled: boolean;
-}
-interface UpdateTaxConfigRequest {
-    tax_enabled: boolean;
-}
-interface TaxConfigResponse {
-    tax_config: TaxConfig;
-}
-type SolicitationTriggerType = 'account_creation' | 'first_withdrawal' | 'threshold_based' | 'manual_admin' | 'irs_compliance_fallback' | 'w8ben_validity_expiry';
-interface SolicitationTrigger {
-    type: SolicitationTriggerType;
-    enabled: boolean;
-    label: string;
-    description: string;
-    /** Dollar threshold for threshold_based trigger */
-    threshold_amount?: number;
-}
-interface UpdateSolicitationTriggersRequest {
-    solicitation_triggers: SolicitationTrigger[];
-}
-interface ReminderConfig {
-    enabled: boolean;
-    max_reminders: number;
-    frequency_days: number;
-}
-interface UpdateReminderConfigRequest {
-    reminder_config: ReminderConfig;
-}
-type TaxFormType = 'W-9' | 'W-8BEN' | 'W-8BEN-E';
-type TaxFormStatus = 'Requested' | 'Pending' | 'Submitted' | 'Failed' | 'Verified';
-type TINStatus = 'Pending' | 'Verified' | 'Rejected' | 'Deceased' | 'NotSubmitted';
-type CustomerType = 'US_PERSON' | 'NON_US_PERSON' | 'NON_US_ENTITY';
-interface TaxForm {
-    id: string;
-    tenant_id: string;
-    customer_id: string;
-    form_type: TaxFormType;
-    form_status: TaxFormStatus;
-    customer_type?: CustomerType;
-    tin?: string;
-    tin_type?: string;
-    tin_status: TINStatus;
-    tin_verified_at?: string;
-    tin_verification_error?: string;
-    name?: string;
-    business_name?: string;
-    address?: string;
-    city?: string;
-    state?: string;
-    zip_code?: string;
-    country?: string;
-    country_of_citizenship?: string;
-    country_of_incorporation?: string;
-    foreign_tin?: string;
-    entity_type?: string;
-    entity_name?: string;
-    signer_name?: string;
-    signer_capacity?: string;
-    email?: string;
-    phone?: string;
-    e_delivery_consent: boolean;
-    backup_withholding: boolean;
-    form_file_url?: string;
-    validated_form_url?: string;
-    file_name?: string;
-    address_verified: 'verified' | 'mismatch' | 'unverified';
-    avalara_form_id?: string;
-    avalara_payee_id?: string;
-    avalara_company_id?: string;
-    requested_at: string;
-    submitted_at?: string;
-    due_date?: string;
-    last_reminder_sent_at?: string;
-    reminder_count: number;
-    is_re_request: boolean;
-    previous_form_id?: string;
-    re_request_reason?: string;
-    created_at: string;
-    updated_at: string;
-}
-interface TaxFormFilters {
-    customer_id?: string;
-    form_type?: TaxFormType;
-    form_status?: TaxFormStatus;
-    tin_status?: TINStatus;
-    avalara_company_id?: string;
-    search?: string;
-    start_date?: string;
-    end_date?: string;
-    page?: number;
-    page_size?: number;
-}
-interface TaxFormListResponse {
-    data: TaxForm[];
-    total: number;
-    page: number;
-    page_size: number;
-}
-interface TaxFormLifecycleEvent {
-    id: string;
-    tenant_id: string;
-    tax_form_id: string;
-    customer_id: string;
-    event_type: string;
-    event_status?: string;
-    event_data?: Record<string, unknown>;
-    error_message?: string;
-    created_by?: string;
-    created_at: string;
-}
-interface TaxCompany {
-    id: string;
-    tenant_id: string;
-    avalara_company_id: string;
-    name: string;
-    dba_name?: string;
-    email?: string;
-    address: string;
-    city: string;
-    state?: string;
-    zip?: string;
-    telephone?: string;
-    tin?: string;
-    reference_id?: string;
-    group_name?: string;
-    country_code: string;
-    is_foreign: boolean;
-    resend_requests: boolean;
-    resend_interval_days: number;
-    max_reminder_attempts: number;
-    created_at: string;
-    updated_at: string;
-}
-interface TaxCompanyListResponse {
-    data: TaxCompany[];
-    total: number;
-    page: number;
-    page_size: number;
-}
-/** form_status values for CustomerTaxProfileRecord */
-type CTPFormStatus = 'not_requested' | 'requested' | 'pending' | 'submitted' | 'verified' | 'rejected' | 'expired' | 're_requested' | 're_submitted';
-/** tin_status values for CustomerTaxProfileRecord */
-type CTPTINStatus = 'not_required' | 'pending' | 'submitted' | 'verified' | 'rejected' | 'error';
-/**
- * CustomerTaxProfileRecord mirrors the customer_tax_profiles table in
- * transaction-monitoring-service.
- *
- * One record per customer — tracks the entire tax lifecycle from first form
- * request through TIN verification to year-end 1099 filing.
- */
-interface CustomerTaxProfileRecord {
-    id: string;
-    tenant_id: string;
-    customer_id: string;
-    form_type?: TaxFormType;
-    form_status: CTPFormStatus;
-    tin_status: CTPTINStatus;
-    tin_value?: string;
-    avalara_form_id?: string;
-    avalara_company_id?: string;
-    signed_at?: string;
-    verified_at?: string;
-    /** ISO date — for W-8BEN / W-8BEN-E (3 years from signed_at) */
-    expiry_date?: string;
-    backup_withholding: boolean;
-    b_notice_received: boolean;
-    e_delivery_consent: boolean;
-    reminders_sent: number;
-    last_reminder_at?: string;
-    created_at: string;
-    updated_at: string;
-}
-/**
- * Request body for POST /api/v1/tax/customer-tax-profiles/{customerID}/request-form
- *
- * Customer data should be sourced from customer_profiles
- * (customer-risk-profile-service) before calling this endpoint.
- */
-interface RequestTaxFormRequest {
-    /** Customer email address — Avalara sends the form invitation here */
-    email: string;
-    /** Customer full name (or business name for entities) */
-    name: string;
-    /**
-     * Customer type — drives which IRS form is sent.
-     * US_PERSON → W-9 | NON_US_PERSON → W-8BEN | NON_US_ENTITY → W-8BEN-E
-     */
-    customer_type: CustomerType | 'us_individual' | 'non_us_individual' | 'non_us_entity';
-}
-/** @deprecated Use CustomerTaxProfileRecord for the per-customer DB record. */
-interface CustomerTaxProfile {
-    customer_id: string;
-    tax_forms: TaxForm[];
-    lifecycle_events: TaxFormLifecycleEvent[];
-}
-interface TaxClientConfig {
-    /** Base URL of the Transaction Monitoring Service API (e.g., "http://localhost:8085") */
-    baseURL: string;
-    /** Tenant ID for multi-tenancy */
-    tenantId: string;
-    /** API key or JWT token for authentication */
-    apiKey?: string;
-    /** Custom headers to include in every request */
-    headers?: Record<string, string>;
-    /** Request timeout in milliseconds (default: 10000) */
-    timeout?: number;
-    /** Enable debug logging */
-    debug?: boolean;
-    /** Environment mode */
-    environment?: 'production' | 'sandbox';
-}
-
-/**
- * TaxClient - TypeScript SDK for Vesant Tax Compliance Service
- *
- * Provides type-safe methods to interact with the Tax Compliance service API.
- * Extends BaseClient for consistent retry logic, timeout handling, and error management.
- */
-
-declare class TaxClient extends BaseClient {
-    constructor(config: TaxClientConfig);
-    /**
-     * Get the tax enabled/disabled state for the tenant
-     *
-     * @returns The current tax config (tax_enabled flag)
-     *
-     * @example
-     * ```typescript
-     * const config = await client.getTaxConfig();
-     * console.log(`Tax enabled: ${config.tax_enabled}`);
-     * ```
-     */
-    getTaxConfig(): Promise<TaxConfig>;
-    /**
-     * Enable or disable tax compliance features for the tenant
-     *
-     * @param request - Object with tax_enabled boolean
-     * @returns Updated tax config
-     *
-     * @example
-     * ```typescript
-     * // Enable tax
-     * const config = await client.updateTaxConfig({ tax_enabled: true });
-     *
-     * // Disable tax
-     * const config = await client.updateTaxConfig({ tax_enabled: false });
-     * ```
-     */
-    updateTaxConfig(request: UpdateTaxConfigRequest): Promise<TaxConfig>;
-    /**
-     * Get solicitation triggers for the tenant
-     *
-     * @returns List of solicitation triggers with their enabled state
-     *
-     * @example
-     * ```typescript
-     * const triggers = await client.getSolicitationTriggers();
-     * triggers.forEach(t => console.log(`${t.label}: ${t.enabled}`));
-     * ```
-     */
-    getSolicitationTriggers(): Promise<SolicitationTrigger[]>;
-    /**
-     * Update solicitation triggers for the tenant
-     *
-     * @param triggers - Array of triggers with updated enabled/threshold values
-     * @returns Updated triggers
-     *
-     * @example
-     * ```typescript
-     * const triggers = await client.updateSolicitationTriggers([
-     *   { type: 'first_withdrawal', enabled: true, label: 'First Withdrawal', description: '...' },
-     *   { type: 'threshold_based', enabled: true, label: 'Threshold', description: '...', threshold_amount: 600 },
-     * ]);
-     * ```
-     */
-    updateSolicitationTriggers(triggers: SolicitationTrigger[]): Promise<SolicitationTrigger[]>;
-    /**
-     * Get the reminder configuration for the tenant
-     *
-     * @returns Reminder config (enabled, max_reminders, frequency_days)
-     *
-     * @example
-     * ```typescript
-     * const config = await client.getReminderConfig();
-     * console.log(`Reminders enabled: ${config.enabled}, every ${config.frequency_days} days`);
-     * ```
-     */
-    getReminderConfig(): Promise<ReminderConfig>;
-    /**
-     * Update the reminder configuration for the tenant
-     *
-     * @param config - Reminder configuration to set
-     * @returns Updated reminder config
-     *
-     * @example
-     * ```typescript
-     * const updated = await client.updateReminderConfig({
-     *   enabled: true,
-     *   max_reminders: 3,
-     *   frequency_days: 7,
-     * });
-     * ```
-     */
-    updateReminderConfig(config: ReminderConfig): Promise<ReminderConfig>;
-    /**
-     * List tax forms with optional filters and pagination
-     *
-     * @param filters - Optional filters (customer_id, form_type, form_status, etc.)
-     * @returns Paginated list of tax forms
-     *
-     * @example
-     * ```typescript
-     * const result = await client.listTaxForms({ form_type: 'W-9', form_status: 'Pending' });
-     * console.log(`Found ${result.total} forms`);
-     * ```
-     */
-    listTaxForms(filters?: TaxFormFilters): Promise<TaxFormListResponse>;
-    /**
-     * Get a tax form by ID
-     *
-     * @param formId - Tax form UUID
-     * @returns Tax form details
-     */
-    getTaxForm(formId: string): Promise<TaxForm>;
-    /**
-     * Get lifecycle events for a tax form
-     *
-     * @param formId - Tax form UUID
-     * @returns List of lifecycle events
-     */
-    getTaxFormLifecycleEvents(formId: string): Promise<TaxFormLifecycleEvent[]>;
-    /**
-     * Get the full tax profile for a customer (all forms + lifecycle events)
-     *
-     * @param customerID - Customer ID
-     * @returns Customer tax profile with all forms and events
-     *
-     * @example
-     * ```typescript
-     * const profile = await client.getCustomerTaxProfile('cust_123');
-     * console.log(`Customer has ${profile.tax_forms.length} tax forms`);
-     * ```
-     */
-    getCustomerTaxProfile(customerID: string): Promise<CustomerTaxProfile>;
-    /**
-     * List Avalara tax companies for the tenant
-     *
-     * @param page - Page number (default: 1)
-     * @param pageSize - Items per page (default: 20)
-     * @returns Paginated list of tax companies
-     */
-    listTaxCompanies(page?: number, pageSize?: number): Promise<TaxCompanyListResponse>;
-    /**
-     * Get a tax company by ID
-     *
-     * @param companyId - Tax company UUID
-     * @returns Tax company details
-     */
-    getTaxCompany(companyId: string): Promise<TaxCompany>;
-}
+declare const SDK_VERSION = "1.6.2";
 
 /**
  * TypeScript types for the Transaction Monitoring (TM) Service
@@ -596,4 +226,4 @@ declare class TransactionClient extends BaseClient {
     getTransaction(transactionId: string, requestOptions?: RequestOptions): Promise<void>;
 }
 
-export { AuthenticationError, BaseClient, BaseClientConfig, CGSError, type CTPFormStatus, type CTPTINStatus, CircuitBreakerOpenError, ComplianceBlockedError, ComplianceError, type CustomerTaxProfile, type CustomerTaxProfileRecord, type CustomerType, type JSONB, Logger, NetworkError, RateLimitError, type ReminderConfig, RequestOptions, type RequestTaxFormRequest, SDK_VERSION, ServiceUnavailableError, type SolicitationTrigger, type SolicitationTriggerType, type TINStatus, TaxClient, type TaxClientConfig, type TaxCompany, type TaxCompanyListResponse, type TaxConfig, type TaxConfigResponse, type TaxForm, type TaxFormFilters, type TaxFormLifecycleEvent, type TaxFormListResponse, type TaxFormStatus, type TaxFormType, TimeoutError, Timestamp, type Transaction, TransactionClient, type TransactionClientConfig, type TransactionCreateDTO, type TransactionCreateResponse, type TransactionMode, type TransactionStatus, type TransactionType, type UpdateReminderConfigRequest, type UpdateSolicitationTriggersRequest, type UpdateTaxConfigRequest, ValidationError, VesantError, type WithholdingType, createConsoleLogger, noopLogger };
+export { AuthenticationError, BaseClient, BaseClientConfig, CGSError, CircuitBreakerOpenError, ComplianceBlockedError, ComplianceError, type JSONB, Logger, NetworkError, RateLimitError, RequestOptions, SDK_VERSION, ServiceUnavailableError, TimeoutError, Timestamp, type Transaction, TransactionClient, type TransactionClientConfig, type TransactionCreateDTO, type TransactionCreateResponse, type TransactionMode, type TransactionStatus, type TransactionType, ValidationError, VesantError, type WithholdingType, createConsoleLogger, noopLogger };