vesant-sdk 1.6.6 → 1.7.0-dev.059da4f

package/dist/tax/index.d.mts

@@ -1,4 +1,4 @@
-import { B as BaseClient, R as RequestOptions } from '../client-ePzhQKp9.mjs';
+import { B as BaseClient, R as RequestOptions } from '../client-BolQlL5e.mjs';
 
 /**
  * TypeScript type definitions for Vesant Tax Service API
@@ -49,14 +49,6 @@ interface CustomerTaxProfileRecord {
     backup_withholding: boolean;
     b_notice_received: boolean;
     e_delivery_consent: boolean;
-    /** B-Notice lifecycle stage. 'none' until IRS issues a CP2100. */
-    b_notice_stage: 'none' | 'first' | 'second';
-    b_notice_sent_at?: string;
-    b_notice_second_sent_at?: string;
-    /** ISO date the CP2100 notice was received from the IRS. */
-    cp2100_received_at?: string;
-    /** Set when the customer is flagged for fraud or tax non-compliance. */
-    b_notice_flag_reason?: 'fraud' | 'tax_non_compliance';
     withholding_enabled_by?: string;
     withholding_enabled_at?: string;
     tin_due_date?: string;
@@ -70,16 +62,16 @@ interface CustomerTaxProfileRecord {
 /**
  * Input for POST /api/v1/tax/customer-tax-profiles/{id}/re-request-form
  */
-interface CustomerTaxProfileDocuments {
-    w_form: string;
-    '1099_form': string;
-}
 interface ReRequestTaxFormInput {
     /** Customer email address — required */
     email: string;
     /** Customer full name — optional */
     name?: string;
 }
+interface CustomerTaxProfileDocuments {
+    w_form: string;
+    '1099_form': string;
+}
 /**
  * Input for POST /api/v1/tax/customer-tax-profiles/{id}/enable-withholding
  */
@@ -129,6 +121,12 @@ interface TaxRules {
     email_sending_method: EmailSendingMethod;
     display_tin_links_on_platform: boolean;
     tax_treaty_support: boolean;
+    /**
+     * Restricts tax evaluation to sweepstakes withdrawals only.
+     * When true (default), cash withdrawals bypass TIN/W-9 checks and withholding.
+     * Read-only: not editable via UpdateTaxRulesInput.
+     */
+    tax_scope_sweepstakes_only: boolean;
     created_at: string;
     updated_at: string;
 }
@@ -155,6 +153,16 @@ interface UpdateTaxRulesInput {
     display_tin_links_on_platform: boolean;
     tax_treaty_support: boolean;
 }
+/**
+ * Result of POST /api/v1/tax/reminders/run — the manual W-9/tax-form
+ * reminder job trigger. Counts are for the current tenant only.
+ */
+interface RemindersRunResult {
+    tenant_id: string;
+    sent_count: number;
+    skipped_count: number;
+    error_count: number;
+}
 type TaxRuleApprovalStatus = 'pending' | 'approved' | 'rejected';
 interface TaxRuleVersion {
     id: string;
@@ -237,6 +245,28 @@ interface TreatyCountryListResponse {
     treaty_countries: TreatyCountry[];
     count: number;
 }
+interface RequestTaxFormWithProfileInput {
+    customer_id: string;
+    email: string;
+    first_name?: string;
+    last_name?: string;
+    date_of_birth?: string;
+    phone_number?: string;
+    country?: string;
+    state?: string;
+    city?: string;
+    zip_code?: string;
+    address?: string;
+    ip_address?: string;
+    form_type?: string;
+}
+interface RequestTaxFormWithProfileOutput {
+    profile?: CustomerTaxProfileRecord;
+    request_id?: string;
+    reference_id?: string;
+    form_id?: string;
+    public_url?: string;
+}
 interface TaxClientConfig {
     /** Base URL of the Transaction Monitoring Service API (e.g., "http://localhost:8097") */
     baseURL: string;
@@ -247,49 +277,24 @@ interface TaxClientConfig {
     debug?: boolean;
     environment?: 'production' | 'sandbox';
 }
-interface RunRemindersResponse {
-    tenant_id: string;
-    sent_count: number;
-    skipped_count: number;
-    error_count: number;
-}
-/**
- * Input for TaxClient.updateReminderConfig().
- * Only updates reminder-specific fields; all other tax rule settings are preserved.
- * Caller must be authenticated as a Tenant Super Admin.
- */
-interface UpdateReminderConfigInput {
-    /** Days between reminders. Must be >= 7. */
-    reminder_frequency_days: number;
-    /** Max reminders per customer before stopping. Must be > 0. */
-    reminder_max_count: number;
-}
 
 declare class TaxClient extends BaseClient {
     constructor(config: TaxClientConfig);
     getCustomerTaxProfileRecord(customerID: string): Promise<CustomerTaxProfileRecord>;
     requestTaxForm(customerID: string): Promise<CustomerTaxProfileRecord>;
+    requestTaxFormWithProfile(input: RequestTaxFormWithProfileInput): Promise<RequestTaxFormWithProfileOutput>;
     checkTINStatus(customerID: string): Promise<TINCheckResult>;
     reRequestTaxForm(customerID: string, input: ReRequestTaxFormInput): Promise<CustomerTaxProfileRecord>;
     enableBackupWithholding(customerID: string, input: EnableWithholdingInput): Promise<EnableWithholdingResponse>;
     getCustomerDocuments(customerID: string): Promise<CustomerTaxProfileDocuments>;
     downloadTaxForm(customerID: string, requestOptions?: RequestOptions): Promise<ArrayBuffer>;
-    runReminders(): Promise<RunRemindersResponse>;
-    /**
-     * Update only the reminder configuration (frequency + max count) without
-     * touching any other tax rule settings. Fetches current rules first and
-     * merges the reminder fields before sending the update.
-     *
-     * Requires the caller to be authenticated as a Tenant Super Admin.
-     * Throws VesantError with status 403 if the role requirement is not met.
-     */
-    updateReminderConfig(input: UpdateReminderConfigInput): Promise<TaxRuleVersion>;
     getTaxRules(): Promise<TaxRules>;
     updateTaxRules(input: UpdateTaxRulesInput): Promise<TaxRuleVersion>;
+    runReminders(): Promise<RemindersRunResult>;
     getComplianceStats(filters?: ComplianceStatsFilters): Promise<ComplianceStats>;
     getCurrentGlobalTaxRule(): Promise<GlobalTaxRule>;
     listTreatyCountries(): Promise<TreatyCountryListResponse>;
     getTreatyCountry(code: string): Promise<TreatyCountry>;
 }
 
-export { type CTPFormStatus, type CTPTINStatus, type ComplianceStats, type ComplianceStatsFilters, type CustomerTaxProfileDocuments, type CustomerTaxProfileRecord, type CustomerType, type DocumentRequestBreakdown, type EmailSendingMethod, type EnableWithholdingInput, type EnableWithholdingResponse, type GlobalTaxRule, type ReRequestTaxFormInput, type RunRemindersResponse, type TINCheckResult, type TINStatusBreakdown, TaxClient, type TaxClientConfig, type TaxRuleApprovalStatus, type TaxRuleVersion, type TaxRules, type TransactionAction, type TreatyCountry, type TreatyCountryListResponse, type UpdateReminderConfigInput, type UpdateTaxRulesInput, type WFormCountBreakdown, type WFormStatusBreakdown };
+export { type CTPFormStatus, type CTPTINStatus, type ComplianceStats, type ComplianceStatsFilters, type CustomerTaxProfileDocuments, type CustomerTaxProfileRecord, type CustomerType, type DocumentRequestBreakdown, type EmailSendingMethod, type EnableWithholdingInput, type EnableWithholdingResponse, type GlobalTaxRule, type ReRequestTaxFormInput, type RemindersRunResult, type RequestTaxFormWithProfileInput, type RequestTaxFormWithProfileOutput, type TINCheckResult, type TINStatusBreakdown, TaxClient, type TaxClientConfig, type TaxRuleApprovalStatus, type TaxRuleVersion, type TaxRules, type TransactionAction, type TreatyCountry, type TreatyCountryListResponse, type UpdateTaxRulesInput, type WFormCountBreakdown, type WFormStatusBreakdown };

package/dist/tax/index.d.ts

@@ -1,4 +1,4 @@
-import { B as BaseClient, R as RequestOptions } from '../client-ePzhQKp9.js';
+import { B as BaseClient, R as RequestOptions } from '../client-BolQlL5e.js';
 
 /**
  * TypeScript type definitions for Vesant Tax Service API
@@ -49,14 +49,6 @@ interface CustomerTaxProfileRecord {
     backup_withholding: boolean;
     b_notice_received: boolean;
     e_delivery_consent: boolean;
-    /** B-Notice lifecycle stage. 'none' until IRS issues a CP2100. */
-    b_notice_stage: 'none' | 'first' | 'second';
-    b_notice_sent_at?: string;
-    b_notice_second_sent_at?: string;
-    /** ISO date the CP2100 notice was received from the IRS. */
-    cp2100_received_at?: string;
-    /** Set when the customer is flagged for fraud or tax non-compliance. */
-    b_notice_flag_reason?: 'fraud' | 'tax_non_compliance';
     withholding_enabled_by?: string;
     withholding_enabled_at?: string;
     tin_due_date?: string;
@@ -70,16 +62,16 @@ interface CustomerTaxProfileRecord {
 /**
  * Input for POST /api/v1/tax/customer-tax-profiles/{id}/re-request-form
  */
-interface CustomerTaxProfileDocuments {
-    w_form: string;
-    '1099_form': string;
-}
 interface ReRequestTaxFormInput {
     /** Customer email address — required */
     email: string;
     /** Customer full name — optional */
     name?: string;
 }
+interface CustomerTaxProfileDocuments {
+    w_form: string;
+    '1099_form': string;
+}
 /**
  * Input for POST /api/v1/tax/customer-tax-profiles/{id}/enable-withholding
  */
@@ -129,6 +121,12 @@ interface TaxRules {
     email_sending_method: EmailSendingMethod;
     display_tin_links_on_platform: boolean;
     tax_treaty_support: boolean;
+    /**
+     * Restricts tax evaluation to sweepstakes withdrawals only.
+     * When true (default), cash withdrawals bypass TIN/W-9 checks and withholding.
+     * Read-only: not editable via UpdateTaxRulesInput.
+     */
+    tax_scope_sweepstakes_only: boolean;
     created_at: string;
     updated_at: string;
 }
@@ -155,6 +153,16 @@ interface UpdateTaxRulesInput {
     display_tin_links_on_platform: boolean;
     tax_treaty_support: boolean;
 }
+/**
+ * Result of POST /api/v1/tax/reminders/run — the manual W-9/tax-form
+ * reminder job trigger. Counts are for the current tenant only.
+ */
+interface RemindersRunResult {
+    tenant_id: string;
+    sent_count: number;
+    skipped_count: number;
+    error_count: number;
+}
 type TaxRuleApprovalStatus = 'pending' | 'approved' | 'rejected';
 interface TaxRuleVersion {
     id: string;
@@ -237,6 +245,28 @@ interface TreatyCountryListResponse {
     treaty_countries: TreatyCountry[];
     count: number;
 }
+interface RequestTaxFormWithProfileInput {
+    customer_id: string;
+    email: string;
+    first_name?: string;
+    last_name?: string;
+    date_of_birth?: string;
+    phone_number?: string;
+    country?: string;
+    state?: string;
+    city?: string;
+    zip_code?: string;
+    address?: string;
+    ip_address?: string;
+    form_type?: string;
+}
+interface RequestTaxFormWithProfileOutput {
+    profile?: CustomerTaxProfileRecord;
+    request_id?: string;
+    reference_id?: string;
+    form_id?: string;
+    public_url?: string;
+}
 interface TaxClientConfig {
     /** Base URL of the Transaction Monitoring Service API (e.g., "http://localhost:8097") */
     baseURL: string;
@@ -247,49 +277,24 @@ interface TaxClientConfig {
     debug?: boolean;
     environment?: 'production' | 'sandbox';
 }
-interface RunRemindersResponse {
-    tenant_id: string;
-    sent_count: number;
-    skipped_count: number;
-    error_count: number;
-}
-/**
- * Input for TaxClient.updateReminderConfig().
- * Only updates reminder-specific fields; all other tax rule settings are preserved.
- * Caller must be authenticated as a Tenant Super Admin.
- */
-interface UpdateReminderConfigInput {
-    /** Days between reminders. Must be >= 7. */
-    reminder_frequency_days: number;
-    /** Max reminders per customer before stopping. Must be > 0. */
-    reminder_max_count: number;
-}
 
 declare class TaxClient extends BaseClient {
     constructor(config: TaxClientConfig);
     getCustomerTaxProfileRecord(customerID: string): Promise<CustomerTaxProfileRecord>;
     requestTaxForm(customerID: string): Promise<CustomerTaxProfileRecord>;
+    requestTaxFormWithProfile(input: RequestTaxFormWithProfileInput): Promise<RequestTaxFormWithProfileOutput>;
     checkTINStatus(customerID: string): Promise<TINCheckResult>;
     reRequestTaxForm(customerID: string, input: ReRequestTaxFormInput): Promise<CustomerTaxProfileRecord>;
     enableBackupWithholding(customerID: string, input: EnableWithholdingInput): Promise<EnableWithholdingResponse>;
     getCustomerDocuments(customerID: string): Promise<CustomerTaxProfileDocuments>;
     downloadTaxForm(customerID: string, requestOptions?: RequestOptions): Promise<ArrayBuffer>;
-    runReminders(): Promise<RunRemindersResponse>;
-    /**
-     * Update only the reminder configuration (frequency + max count) without
-     * touching any other tax rule settings. Fetches current rules first and
-     * merges the reminder fields before sending the update.
-     *
-     * Requires the caller to be authenticated as a Tenant Super Admin.
-     * Throws VesantError with status 403 if the role requirement is not met.
-     */
-    updateReminderConfig(input: UpdateReminderConfigInput): Promise<TaxRuleVersion>;
     getTaxRules(): Promise<TaxRules>;
     updateTaxRules(input: UpdateTaxRulesInput): Promise<TaxRuleVersion>;
+    runReminders(): Promise<RemindersRunResult>;
     getComplianceStats(filters?: ComplianceStatsFilters): Promise<ComplianceStats>;
     getCurrentGlobalTaxRule(): Promise<GlobalTaxRule>;
     listTreatyCountries(): Promise<TreatyCountryListResponse>;
     getTreatyCountry(code: string): Promise<TreatyCountry>;
 }
 
-export { type CTPFormStatus, type CTPTINStatus, type ComplianceStats, type ComplianceStatsFilters, type CustomerTaxProfileDocuments, type CustomerTaxProfileRecord, type CustomerType, type DocumentRequestBreakdown, type EmailSendingMethod, type EnableWithholdingInput, type EnableWithholdingResponse, type GlobalTaxRule, type ReRequestTaxFormInput, type RunRemindersResponse, type TINCheckResult, type TINStatusBreakdown, TaxClient, type TaxClientConfig, type TaxRuleApprovalStatus, type TaxRuleVersion, type TaxRules, type TransactionAction, type TreatyCountry, type TreatyCountryListResponse, type UpdateReminderConfigInput, type UpdateTaxRulesInput, type WFormCountBreakdown, type WFormStatusBreakdown };
+export { type CTPFormStatus, type CTPTINStatus, type ComplianceStats, type ComplianceStatsFilters, type CustomerTaxProfileDocuments, type CustomerTaxProfileRecord, type CustomerType, type DocumentRequestBreakdown, type EmailSendingMethod, type EnableWithholdingInput, type EnableWithholdingResponse, type GlobalTaxRule, type ReRequestTaxFormInput, type RemindersRunResult, type RequestTaxFormWithProfileInput, type RequestTaxFormWithProfileOutput, type TINCheckResult, type TINStatusBreakdown, TaxClient, type TaxClientConfig, type TaxRuleApprovalStatus, type TaxRuleVersion, type TaxRules, type TransactionAction, type TreatyCountry, type TreatyCountryListResponse, type UpdateTaxRulesInput, type WFormCountBreakdown, type WFormStatusBreakdown };

package/dist/tax/index.js

@@ -216,7 +216,7 @@ function createConsoleLogger() {
 }
 
 // src/core/version.ts
-var SDK_VERSION = "1.6.6";
+var SDK_VERSION = "1.7.0";
 
 // src/shared/browser-utils.ts
 function generateUUID() {
@@ -572,6 +572,15 @@ var TaxClient = class extends BaseClient {
       { method: "POST" }
     );
   }
+  async requestTaxFormWithProfile(input) {
+    return this.request(
+      "/api/v1/tax/customer-tax-profiles/request-form-with-profile",
+      {
+        method: "POST",
+        body: JSON.stringify(input)
+      }
+    );
+  }
   async checkTINStatus(customerID) {
     return this.requestWithRetry(
       `/api/v1/tax/customer-tax-profiles/${customerID}/check-tin`,
@@ -609,41 +618,6 @@ var TaxClient = class extends BaseClient {
       { ...requestOptions, responseType: "arraybuffer" }
     );
   }
-  async runReminders() {
-    return this.request("/api/v1/tax/reminders/run", {
-      method: "POST"
-    });
-  }
-  /**
-   * Update only the reminder configuration (frequency + max count) without
-   * touching any other tax rule settings. Fetches current rules first and
-   * merges the reminder fields before sending the update.
-   *
-   * Requires the caller to be authenticated as a Tenant Super Admin.
-   * Throws VesantError with status 403 if the role requirement is not met.
-   */
-  async updateReminderConfig(input) {
-    const current = await this.getTaxRules();
-    return this.updateTaxRules({
-      trigger_account_creation: current.trigger_account_creation,
-      trigger_first_withdrawal: current.trigger_first_withdrawal,
-      trigger_threshold: current.trigger_threshold,
-      trigger_manual: current.trigger_manual,
-      trigger_tin_invalid: current.trigger_tin_invalid,
-      trigger_w8ben_expiry: current.trigger_w8ben_expiry,
-      trigger_tin_expired: current.trigger_tin_expired,
-      us_withholding_enabled: current.us_withholding_enabled,
-      non_us_withholding_enabled: current.non_us_withholding_enabled,
-      transaction_action: current.transaction_action,
-      w8ben_expiry_warning_days: current.w8ben_expiry_warning_days,
-      tin_verification_due_date: current.tin_verification_due_date,
-      email_sending_method: current.email_sending_method,
-      display_tin_links_on_platform: current.display_tin_links_on_platform,
-      tax_treaty_support: current.tax_treaty_support,
-      reminder_frequency_days: input.reminder_frequency_days,
-      reminder_max_count: input.reminder_max_count
-    });
-  }
   // ==========================================================================
   // P2 — Tenant Tax Rules
   // ==========================================================================
@@ -658,6 +632,9 @@ var TaxClient = class extends BaseClient {
     });
     return res.version;
   }
+  async runReminders() {
+    return this.request("/api/v1/tax/reminders/run", { method: "POST" });
+  }
   async getComplianceStats(filters) {
     const params = {};
     if (filters?.time_range) params.time_range = filters.time_range;