@basedone/core 0.2.6 → 0.2.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,4 +1,4 @@
1
- import { MarginTables, PerpsAssetCtx, InfoClient, SpotToken, SpotMeta } from '@nktkas/hyperliquid';
1
+ import { MarginTables, PerpsAssetCtx, PerpDex as PerpDex$1, InfoClient, SpotToken, SpotMeta } from '@nktkas/hyperliquid';
2
2
 
3
3
  interface PerpsMeta {
4
4
  collateralToken: number;
@@ -33,6 +33,9 @@ interface PerpsUniverse {
33
33
  /** Margin mode for the universe. */
34
34
  marginMode?: "strictIsolated" | "noCross";
35
35
  }
36
+ interface PerpDex extends PerpDex$1 {
37
+ deployerFeeScale: string;
38
+ }
36
39
  type AllPerpsMeta = PerpsMeta[];
37
40
  declare function getAllPerpsMeta(infoClient: InfoClient): Promise<AllPerpsMeta>;
38
41
 
@@ -176,4 +179,4 @@ declare class InstrumentClient {
176
179
  private extractDexNameFromMeta;
177
180
  }
178
181
 
179
- export { type AllPerpsMeta as A, type BaseInstrument as B, InstrumentClient as I, type MarketInstrument as M, type PerpsMeta as P, type SpotInstrument as S, type PerpsMetaAndAssetCtxs as a, type PerpsUniverse as b, type PerpsInstrument as c, AssetIdUtils as d, getAllPerpsMeta as g };
182
+ export { type AllPerpsMeta as A, type BaseInstrument as B, InstrumentClient as I, type MarketInstrument as M, type PerpsMeta as P, type SpotInstrument as S, type PerpsMetaAndAssetCtxs as a, type PerpsUniverse as b, type PerpDex as c, type PerpsInstrument as d, AssetIdUtils as e, getAllPerpsMeta as g };
@@ -1,4 +1,4 @@
1
- import { MarginTables, PerpsAssetCtx, InfoClient, SpotToken, SpotMeta } from '@nktkas/hyperliquid';
1
+ import { MarginTables, PerpsAssetCtx, PerpDex as PerpDex$1, InfoClient, SpotToken, SpotMeta } from '@nktkas/hyperliquid';
2
2
 
3
3
  interface PerpsMeta {
4
4
  collateralToken: number;
@@ -33,6 +33,9 @@ interface PerpsUniverse {
33
33
  /** Margin mode for the universe. */
34
34
  marginMode?: "strictIsolated" | "noCross";
35
35
  }
36
+ interface PerpDex extends PerpDex$1 {
37
+ deployerFeeScale: string;
38
+ }
36
39
  type AllPerpsMeta = PerpsMeta[];
37
40
  declare function getAllPerpsMeta(infoClient: InfoClient): Promise<AllPerpsMeta>;
38
41
 
@@ -176,4 +179,4 @@ declare class InstrumentClient {
176
179
  private extractDexNameFromMeta;
177
180
  }
178
181
 
179
- export { type AllPerpsMeta as A, type BaseInstrument as B, InstrumentClient as I, type MarketInstrument as M, type PerpsMeta as P, type SpotInstrument as S, type PerpsMetaAndAssetCtxs as a, type PerpsUniverse as b, type PerpsInstrument as c, AssetIdUtils as d, getAllPerpsMeta as g };
182
+ export { type AllPerpsMeta as A, type BaseInstrument as B, InstrumentClient as I, type MarketInstrument as M, type PerpsMeta as P, type SpotInstrument as S, type PerpsMetaAndAssetCtxs as a, type PerpsUniverse as b, type PerpDex as c, type PerpsInstrument as d, AssetIdUtils as e, getAllPerpsMeta as g };
@@ -236,6 +236,36 @@ declare enum MerchantStatus {
236
236
  /** Merchant is pending approval */
237
237
  PENDING = "PENDING"
238
238
  }
239
+ /**
240
+ * Merchant business type enum
241
+ */
242
+ declare enum MerchantBusinessType {
243
+ /** Individual seller */
244
+ INDIVIDUAL = "INDIVIDUAL",
245
+ /** Registered company */
246
+ COMPANY = "COMPANY",
247
+ /** Partnership */
248
+ PARTNERSHIP = "PARTNERSHIP",
249
+ /** Non-profit organization */
250
+ NON_PROFIT = "NON_PROFIT"
251
+ }
252
+ /**
253
+ * Merchant return policy type enum
254
+ */
255
+ declare enum MerchantReturnPolicyType {
256
+ /** No returns accepted */
257
+ NO_RETURNS = "NO_RETURNS",
258
+ /** Exchange for same/similar item only */
259
+ EXCHANGE_ONLY = "EXCHANGE_ONLY",
260
+ /** Refund as store credit only */
261
+ STORE_CREDIT = "STORE_CREDIT",
262
+ /** Full refund available */
263
+ FULL_REFUND = "FULL_REFUND",
264
+ /** Partial refund (restocking fee may apply) */
265
+ PARTIAL_REFUND = "PARTIAL_REFUND",
266
+ /** Handled on a case-by-case basis */
267
+ CASE_BY_CASE = "CASE_BY_CASE"
268
+ }
239
269
  /**
240
270
  * Shipment status enum
241
271
  */
@@ -532,6 +562,21 @@ interface ProductVariant extends BaseEntity {
532
562
  /** Sort order */
533
563
  sortOrder: number;
534
564
  }
565
+ /**
566
+ * Social links for merchant profile
567
+ */
568
+ interface MerchantSocialLinks {
569
+ /** Twitter/X profile URL */
570
+ twitter?: string | null;
571
+ /** Instagram profile URL */
572
+ instagram?: string | null;
573
+ /** Facebook page URL */
574
+ facebook?: string | null;
575
+ /** Discord server invite URL */
576
+ discord?: string | null;
577
+ /** Telegram channel/group URL */
578
+ telegram?: string | null;
579
+ }
535
580
  /**
536
581
  * Merchant entity
537
582
  */
@@ -546,6 +591,32 @@ interface Merchant extends BaseEntity {
546
591
  payoutAddress: string;
547
592
  /** Merchant status */
548
593
  status: MerchantStatus;
594
+ /** Contact email for notifications and customer inquiries */
595
+ email?: string | null;
596
+ /** Contact phone number */
597
+ phone?: string | null;
598
+ /** Store website URL */
599
+ website?: string | null;
600
+ /** Business type (individual, company, etc.) */
601
+ businessType?: MerchantBusinessType;
602
+ /** Store logo/avatar URL */
603
+ logoUrl?: string | null;
604
+ /** Store banner image URL */
605
+ bannerUrl?: string | null;
606
+ /** Social media links */
607
+ socialLinks?: MerchantSocialLinks | null;
608
+ /** Return policy type */
609
+ returnPolicyType?: MerchantReturnPolicyType;
610
+ /** Custom return policy details/text */
611
+ returnPolicyDetails?: string | null;
612
+ /** Return window in days (e.g., 30) */
613
+ returnWindowDays?: number | null;
614
+ /** ISO 2-letter country code (for tax/shipping) */
615
+ country?: string | null;
616
+ /** City name */
617
+ city?: string | null;
618
+ /** Street address */
619
+ addressLine1?: string | null;
549
620
  }
550
621
  /**
551
622
  * Shipping address
@@ -1404,6 +1475,11 @@ interface CreateOrderRequest {
1404
1475
  * SECURITY: The cost is never trusted from the frontend.
1405
1476
  */
1406
1477
  shippingRateId?: string;
1478
+ /**
1479
+ * Shipping method name (e.g., "On-site Collection")
1480
+ * Sent as fallback when validation is disabled, so the method name can still be stored.
1481
+ */
1482
+ shippingMethodName?: string;
1407
1483
  /** @deprecated Use shippingRateId instead. This value is ignored by the server. */
1408
1484
  shippingMethod?: string;
1409
1485
  /** @deprecated Use shippingRateId instead. This value is ignored by the server. */
@@ -1419,6 +1495,8 @@ interface CreateOrderRequest {
1419
1495
  interface ListOrdersParams extends PaginationParams {
1420
1496
  /** Filter by status */
1421
1497
  status?: OrderStatus;
1498
+ /** Filter by merchant ID (for godview access) */
1499
+ merchantId?: string;
1422
1500
  }
1423
1501
  /**
1424
1502
  * Update order status request
@@ -3120,6 +3198,27 @@ interface DeleteBrowsingLocationResponse {
3120
3198
  /** Success message */
3121
3199
  message: string;
3122
3200
  }
3201
+ /**
3202
+ * Cash account balance response
3203
+ */
3204
+ interface CashAccountBalanceResponse {
3205
+ /** Balance amount */
3206
+ balance: string;
3207
+ /** Currency code (e.g., "USD") */
3208
+ currency: string;
3209
+ }
3210
+ interface DeliveryAddressResponse {
3211
+ name: string;
3212
+ phoneNumber: string;
3213
+ deliveryAddress: {
3214
+ addressLine1: string;
3215
+ addressLine2?: string | null;
3216
+ postalCode: string;
3217
+ city: string | null;
3218
+ region: string | null;
3219
+ country: string;
3220
+ };
3221
+ }
3123
3222
 
3124
3223
  /**
3125
3224
  * Customer/End-User Ecommerce API Client
@@ -3886,6 +3985,34 @@ declare class CustomerEcommerceClient extends BaseEcommerceClient {
3886
3985
  * ```
3887
3986
  */
3888
3987
  clearBrowsingLocation(): Promise<DeleteBrowsingLocationResponse>;
3988
+ /**
3989
+ * Get user's cash account balance for BASEDPAY
3990
+ *
3991
+ * Returns the current balance in the user's BasedPay cash account.
3992
+ *
3993
+ * @returns Cash account balance with currency
3994
+ *
3995
+ * @example
3996
+ * ```typescript
3997
+ * const balance = await client.getCashAccountBalance();
3998
+ * console.log(`Balance: ${balance.balance} ${balance.currency}`);
3999
+ * ```
4000
+ */
4001
+ getCashAccountBalance(): Promise<CashAccountBalanceResponse>;
4002
+ /**
4003
+ * Get user's delivery address for BASEDPAY
4004
+ *
4005
+ * Returns the user's delivery address for BASEDPAY.
4006
+ *
4007
+ * @returns Delivery address
4008
+ *
4009
+ * @example
4010
+ * ```typescript
4011
+ * const address = await client.getDeliveryAddress();
4012
+ * console.log(`Address: ${address.address}`);
4013
+ * ```
4014
+ */
4015
+ getDeliveryAddress(): Promise<DeliveryAddressResponse>;
3889
4016
  }
3890
4017
 
3891
4018
  /**
@@ -5600,4 +5727,4 @@ declare function calculateDiscountAmount(price: number, discountType: "PERCENTAG
5600
5727
  */
5601
5728
  declare function calculateFinalPrice(price: number, discountType: "PERCENTAGE" | "FIXED_AMOUNT", discountValue: number): number;
5602
5729
 
5603
- export { type ActiveFlashSalesResponse, type AnalyticsOverview, type ApiResponse, type AppliedDiscount, type Banner, type BannerResponse, BannerType, BaseEcommerceClient, type BaseEntity, type BrowsingLocation, type CalculateCartDiscountsRequest, type CalculateCartDiscountsResponse, type CalculateShippingRequest, type CalculateShippingResponse, type CalculateTaxRequest, type CalculateTaxResponse, type CartItem, type ConfirmEscrowDepositResponse, type Coupon, type CouponResponse, type CouponUsage, type CreateBannerRequest, type CreateCouponRequest, type CreateFlashSaleRequest, type CreateOrderEventRequest, type CreateOrderEventResponse, type CreateOrderRequest, type CreateOrderResponse, type CreateProductRequest, type CreateProductVariantRequest, type CreateReviewRequest, type CreateShippingMethodRequest, type CreateShippingRateRequest, type CreateShippingZoneRequest, type CreateTaxNexusRequest, type CreateTaxRuleRequest, CustomerEcommerceClient, type CustomerMessagesResponse, type CustomerSummary, type DeleteBrowsingLocationResponse, DiscountMethod, DiscountScope, DiscountType, EcommerceApiError, type EcommerceClientConfig, type ExpiringGemBatch, type FlashSale, type FlashSaleAllowanceInfo, type FlashSaleItem, type FlashSaleItemInput, type FollowActionResponse, type FollowStatusResponse, type FollowedMerchantSummary, type GemHistoryItem, type GemHistoryType, type GemHistoryTypeFilter, type GemSource, type GenerateTaxReportRequest, type GetAnalyticsParams, type GetAnalyticsResponse, type GetBrowsingLocationResponse, type GetCouponResponse, type GetExpiringGemsParams, type GetExpiringGemsResponse, type GetFlashSaleAllowanceParams, type GetFlashSaleAllowanceResponse, type GetGemBalanceResponse, type GetGemHistoryParams, type GetGemHistoryResponse, type GetOrderResponse, type GetPaymentMethodsResponse, type GetProductMetricsResponse, type GetProductResponse, type GetTaxReportResponse, InventoryAuditAction, type InventoryAuditEntry, type ListActiveBannersParams, type ListActiveFlashSalesParams, type ListBannersResponse, type ListCouponsResponse, type ListCustomersParams, type ListCustomersResponse, type ListFollowingParams, type ListFollowingResponse, type ListInventoryAuditResponse, type ListMediaAssetsResponse, type ListMerchantProductsParams, type ListMessagesResponse, type ListOrdersParams, type ListOrdersResponse, type ListProductVariantsResponse, type ListProductsParams, type ListProductsResponse, type ListReturnsResponse, type ListReviewsParams, type ListReviewsResponse, type ListShipmentsResponse, type ListShippingAddressesResponse, type ListShippingMethodsResponse, type ListShippingRatesResponse, type ListShippingZonesResponse, type ListTaxNexusResponse, type ListTaxReportsParams, type ListTaxReportsResponse, type ListTaxRulesResponse, type MediaAsset, type MediaAssetResponse, type Merchant, MerchantEcommerceClient, type MerchantProductsResponse, type MerchantProfileRequest, type MerchantProfileResponse, type MerchantShippingSettings, MerchantStatus, type Message, type MessageResponse, type MessageStatsResponse, type Order, type OrderEvent, type OrderItem, type OrderReceiptResponse, OrderStatus, type OrdersByStatus, type PaginatedResponse, type PaginationParams, type Payment, PaymentMethod, type PaymentMethodInfo, PaymentStatus, type ProcessPaymentRequest, type ProcessPaymentResponse, type Product, type ProductDimensions, type ProductDiscountsResponse, type ProductMetrics, type ProductResponse, type ProductReview, ProductSortBy, type ProductVariant, type ProductVariantResponse, type PublicMerchantProfile, type PublicMerchantProfileResponse, type RecentOrderSummary, type RespondToReviewRequest, type Return, type ReturnItem, type ReturnResponse, ReturnStatus, type RevenueByDay, type ReviewResponse, ReviewSortBy, ReviewStatus, type SaveBrowsingLocationRequest, type SaveBrowsingLocationResponse, type SendMessageRequest, type Settlement, type Shipment, type ShipmentResponse, ShipmentStatus, type ShippingAddress$1 as ShippingAddress, type ShippingAddressRequest, type ShippingAddressResponse, type ShippingMethod, type ShippingMethodResponse, type ShippingOption, type ShippingRate, type ShippingRateResponse, type ShippingSettingsResponse, type ShippingZone, type ShippingZoneResponse, SortOrder, type SuccessResponse, TaxBehavior, type TaxBreakdownItem, type TaxNexus, type TaxNexusResponse, type TaxReport, type TaxReportDetails, TaxReportPeriodType, type TaxReportResponse, TaxReportStatus, type TaxRule, type TaxRuleResponse, type TaxSettings, type TaxSettingsResponse, TaxType, type TopProduct, type TrackBannerRequest, type UpdateBannerRequest, type UpdateCouponRequest, type UpdateFlashSaleRequest, type UpdateOrderResponse, type UpdateOrderStatusRequest, type UpdateProductRequest, type UpdateProductVariantRequest, type UpdateShipmentRequest, type UpdateShippingMethodRequest, type UpdateShippingRateRequest, type UpdateShippingSettingsRequest, type UpdateShippingZoneRequest, type UpdateTaxNexusRequest, type UpdateTaxReportStatusRequest, type UpdateTaxRuleRequest, type UpdateTaxSettingsRequest, type UserShippingAddress, type ValidateDiscountRequest, type ValidateDiscountResponse, buildQueryString, calculateDiscountAmount, calculateFinalPrice, formatPrice, getBackoffDelay, isRetryableError, isValidAddress, isValidEmail, parseError, retryWithBackoff, sleep, truncateAddress };
5730
+ export { type ActiveFlashSalesResponse, type AnalyticsOverview, type ApiResponse, type AppliedDiscount, type Banner, type BannerResponse, BannerType, BaseEcommerceClient, type BaseEntity, type BrowsingLocation, type CalculateCartDiscountsRequest, type CalculateCartDiscountsResponse, type CalculateShippingRequest, type CalculateShippingResponse, type CalculateTaxRequest, type CalculateTaxResponse, type CartItem, type CashAccountBalanceResponse, type ConfirmEscrowDepositResponse, type Coupon, type CouponResponse, type CouponUsage, type CreateBannerRequest, type CreateCouponRequest, type CreateFlashSaleRequest, type CreateOrderEventRequest, type CreateOrderEventResponse, type CreateOrderRequest, type CreateOrderResponse, type CreateProductRequest, type CreateProductVariantRequest, type CreateReviewRequest, type CreateShippingMethodRequest, type CreateShippingRateRequest, type CreateShippingZoneRequest, type CreateTaxNexusRequest, type CreateTaxRuleRequest, CustomerEcommerceClient, type CustomerMessagesResponse, type CustomerSummary, type DeleteBrowsingLocationResponse, type DeliveryAddressResponse, DiscountMethod, DiscountScope, DiscountType, EcommerceApiError, type EcommerceClientConfig, type ExpiringGemBatch, type FlashSale, type FlashSaleAllowanceInfo, type FlashSaleItem, type FlashSaleItemInput, type FollowActionResponse, type FollowStatusResponse, type FollowedMerchantSummary, type GemHistoryItem, type GemHistoryType, type GemHistoryTypeFilter, type GemSource, type GenerateTaxReportRequest, type GetAnalyticsParams, type GetAnalyticsResponse, type GetBrowsingLocationResponse, type GetCouponResponse, type GetExpiringGemsParams, type GetExpiringGemsResponse, type GetFlashSaleAllowanceParams, type GetFlashSaleAllowanceResponse, type GetGemBalanceResponse, type GetGemHistoryParams, type GetGemHistoryResponse, type GetOrderResponse, type GetPaymentMethodsResponse, type GetProductMetricsResponse, type GetProductResponse, type GetTaxReportResponse, InventoryAuditAction, type InventoryAuditEntry, type ListActiveBannersParams, type ListActiveFlashSalesParams, type ListBannersResponse, type ListCouponsResponse, type ListCustomersParams, type ListCustomersResponse, type ListFollowingParams, type ListFollowingResponse, type ListInventoryAuditResponse, type ListMediaAssetsResponse, type ListMerchantProductsParams, type ListMessagesResponse, type ListOrdersParams, type ListOrdersResponse, type ListProductVariantsResponse, type ListProductsParams, type ListProductsResponse, type ListReturnsResponse, type ListReviewsParams, type ListReviewsResponse, type ListShipmentsResponse, type ListShippingAddressesResponse, type ListShippingMethodsResponse, type ListShippingRatesResponse, type ListShippingZonesResponse, type ListTaxNexusResponse, type ListTaxReportsParams, type ListTaxReportsResponse, type ListTaxRulesResponse, type MediaAsset, type MediaAssetResponse, type Merchant, MerchantBusinessType, MerchantEcommerceClient, type MerchantProductsResponse, type MerchantProfileRequest, type MerchantProfileResponse, MerchantReturnPolicyType, type MerchantShippingSettings, type MerchantSocialLinks, MerchantStatus, type Message, type MessageResponse, type MessageStatsResponse, type Order, type OrderEvent, type OrderItem, type OrderReceiptResponse, OrderStatus, type OrdersByStatus, type PaginatedResponse, type PaginationParams, type Payment, PaymentMethod, type PaymentMethodInfo, PaymentStatus, type ProcessPaymentRequest, type ProcessPaymentResponse, type Product, type ProductDimensions, type ProductDiscountsResponse, type ProductMetrics, type ProductResponse, type ProductReview, ProductSortBy, type ProductVariant, type ProductVariantResponse, type PublicMerchantProfile, type PublicMerchantProfileResponse, type RecentOrderSummary, type RespondToReviewRequest, type Return, type ReturnItem, type ReturnResponse, ReturnStatus, type RevenueByDay, type ReviewResponse, ReviewSortBy, ReviewStatus, type SaveBrowsingLocationRequest, type SaveBrowsingLocationResponse, type SendMessageRequest, type Settlement, type Shipment, type ShipmentResponse, ShipmentStatus, type ShippingAddress$1 as ShippingAddress, type ShippingAddressRequest, type ShippingAddressResponse, type ShippingMethod, type ShippingMethodResponse, type ShippingOption, type ShippingRate, type ShippingRateResponse, type ShippingSettingsResponse, type ShippingZone, type ShippingZoneResponse, SortOrder, type SuccessResponse, TaxBehavior, type TaxBreakdownItem, type TaxNexus, type TaxNexusResponse, type TaxReport, type TaxReportDetails, TaxReportPeriodType, type TaxReportResponse, TaxReportStatus, type TaxRule, type TaxRuleResponse, type TaxSettings, type TaxSettingsResponse, TaxType, type TopProduct, type TrackBannerRequest, type UpdateBannerRequest, type UpdateCouponRequest, type UpdateFlashSaleRequest, type UpdateOrderResponse, type UpdateOrderStatusRequest, type UpdateProductRequest, type UpdateProductVariantRequest, type UpdateShipmentRequest, type UpdateShippingMethodRequest, type UpdateShippingRateRequest, type UpdateShippingSettingsRequest, type UpdateShippingZoneRequest, type UpdateTaxNexusRequest, type UpdateTaxReportStatusRequest, type UpdateTaxRuleRequest, type UpdateTaxSettingsRequest, type UserShippingAddress, type ValidateDiscountRequest, type ValidateDiscountResponse, buildQueryString, calculateDiscountAmount, calculateFinalPrice, formatPrice, getBackoffDelay, isRetryableError, isValidAddress, isValidEmail, parseError, retryWithBackoff, sleep, truncateAddress };
@@ -236,6 +236,36 @@ declare enum MerchantStatus {
236
236
  /** Merchant is pending approval */
237
237
  PENDING = "PENDING"
238
238
  }
239
+ /**
240
+ * Merchant business type enum
241
+ */
242
+ declare enum MerchantBusinessType {
243
+ /** Individual seller */
244
+ INDIVIDUAL = "INDIVIDUAL",
245
+ /** Registered company */
246
+ COMPANY = "COMPANY",
247
+ /** Partnership */
248
+ PARTNERSHIP = "PARTNERSHIP",
249
+ /** Non-profit organization */
250
+ NON_PROFIT = "NON_PROFIT"
251
+ }
252
+ /**
253
+ * Merchant return policy type enum
254
+ */
255
+ declare enum MerchantReturnPolicyType {
256
+ /** No returns accepted */
257
+ NO_RETURNS = "NO_RETURNS",
258
+ /** Exchange for same/similar item only */
259
+ EXCHANGE_ONLY = "EXCHANGE_ONLY",
260
+ /** Refund as store credit only */
261
+ STORE_CREDIT = "STORE_CREDIT",
262
+ /** Full refund available */
263
+ FULL_REFUND = "FULL_REFUND",
264
+ /** Partial refund (restocking fee may apply) */
265
+ PARTIAL_REFUND = "PARTIAL_REFUND",
266
+ /** Handled on a case-by-case basis */
267
+ CASE_BY_CASE = "CASE_BY_CASE"
268
+ }
239
269
  /**
240
270
  * Shipment status enum
241
271
  */
@@ -532,6 +562,21 @@ interface ProductVariant extends BaseEntity {
532
562
  /** Sort order */
533
563
  sortOrder: number;
534
564
  }
565
+ /**
566
+ * Social links for merchant profile
567
+ */
568
+ interface MerchantSocialLinks {
569
+ /** Twitter/X profile URL */
570
+ twitter?: string | null;
571
+ /** Instagram profile URL */
572
+ instagram?: string | null;
573
+ /** Facebook page URL */
574
+ facebook?: string | null;
575
+ /** Discord server invite URL */
576
+ discord?: string | null;
577
+ /** Telegram channel/group URL */
578
+ telegram?: string | null;
579
+ }
535
580
  /**
536
581
  * Merchant entity
537
582
  */
@@ -546,6 +591,32 @@ interface Merchant extends BaseEntity {
546
591
  payoutAddress: string;
547
592
  /** Merchant status */
548
593
  status: MerchantStatus;
594
+ /** Contact email for notifications and customer inquiries */
595
+ email?: string | null;
596
+ /** Contact phone number */
597
+ phone?: string | null;
598
+ /** Store website URL */
599
+ website?: string | null;
600
+ /** Business type (individual, company, etc.) */
601
+ businessType?: MerchantBusinessType;
602
+ /** Store logo/avatar URL */
603
+ logoUrl?: string | null;
604
+ /** Store banner image URL */
605
+ bannerUrl?: string | null;
606
+ /** Social media links */
607
+ socialLinks?: MerchantSocialLinks | null;
608
+ /** Return policy type */
609
+ returnPolicyType?: MerchantReturnPolicyType;
610
+ /** Custom return policy details/text */
611
+ returnPolicyDetails?: string | null;
612
+ /** Return window in days (e.g., 30) */
613
+ returnWindowDays?: number | null;
614
+ /** ISO 2-letter country code (for tax/shipping) */
615
+ country?: string | null;
616
+ /** City name */
617
+ city?: string | null;
618
+ /** Street address */
619
+ addressLine1?: string | null;
549
620
  }
550
621
  /**
551
622
  * Shipping address
@@ -1404,6 +1475,11 @@ interface CreateOrderRequest {
1404
1475
  * SECURITY: The cost is never trusted from the frontend.
1405
1476
  */
1406
1477
  shippingRateId?: string;
1478
+ /**
1479
+ * Shipping method name (e.g., "On-site Collection")
1480
+ * Sent as fallback when validation is disabled, so the method name can still be stored.
1481
+ */
1482
+ shippingMethodName?: string;
1407
1483
  /** @deprecated Use shippingRateId instead. This value is ignored by the server. */
1408
1484
  shippingMethod?: string;
1409
1485
  /** @deprecated Use shippingRateId instead. This value is ignored by the server. */
@@ -1419,6 +1495,8 @@ interface CreateOrderRequest {
1419
1495
  interface ListOrdersParams extends PaginationParams {
1420
1496
  /** Filter by status */
1421
1497
  status?: OrderStatus;
1498
+ /** Filter by merchant ID (for godview access) */
1499
+ merchantId?: string;
1422
1500
  }
1423
1501
  /**
1424
1502
  * Update order status request
@@ -3120,6 +3198,27 @@ interface DeleteBrowsingLocationResponse {
3120
3198
  /** Success message */
3121
3199
  message: string;
3122
3200
  }
3201
+ /**
3202
+ * Cash account balance response
3203
+ */
3204
+ interface CashAccountBalanceResponse {
3205
+ /** Balance amount */
3206
+ balance: string;
3207
+ /** Currency code (e.g., "USD") */
3208
+ currency: string;
3209
+ }
3210
+ interface DeliveryAddressResponse {
3211
+ name: string;
3212
+ phoneNumber: string;
3213
+ deliveryAddress: {
3214
+ addressLine1: string;
3215
+ addressLine2?: string | null;
3216
+ postalCode: string;
3217
+ city: string | null;
3218
+ region: string | null;
3219
+ country: string;
3220
+ };
3221
+ }
3123
3222
 
3124
3223
  /**
3125
3224
  * Customer/End-User Ecommerce API Client
@@ -3886,6 +3985,34 @@ declare class CustomerEcommerceClient extends BaseEcommerceClient {
3886
3985
  * ```
3887
3986
  */
3888
3987
  clearBrowsingLocation(): Promise<DeleteBrowsingLocationResponse>;
3988
+ /**
3989
+ * Get user's cash account balance for BASEDPAY
3990
+ *
3991
+ * Returns the current balance in the user's BasedPay cash account.
3992
+ *
3993
+ * @returns Cash account balance with currency
3994
+ *
3995
+ * @example
3996
+ * ```typescript
3997
+ * const balance = await client.getCashAccountBalance();
3998
+ * console.log(`Balance: ${balance.balance} ${balance.currency}`);
3999
+ * ```
4000
+ */
4001
+ getCashAccountBalance(): Promise<CashAccountBalanceResponse>;
4002
+ /**
4003
+ * Get user's delivery address for BASEDPAY
4004
+ *
4005
+ * Returns the user's delivery address for BASEDPAY.
4006
+ *
4007
+ * @returns Delivery address
4008
+ *
4009
+ * @example
4010
+ * ```typescript
4011
+ * const address = await client.getDeliveryAddress();
4012
+ * console.log(`Address: ${address.address}`);
4013
+ * ```
4014
+ */
4015
+ getDeliveryAddress(): Promise<DeliveryAddressResponse>;
3889
4016
  }
3890
4017
 
3891
4018
  /**
@@ -5600,4 +5727,4 @@ declare function calculateDiscountAmount(price: number, discountType: "PERCENTAG
5600
5727
  */
5601
5728
  declare function calculateFinalPrice(price: number, discountType: "PERCENTAGE" | "FIXED_AMOUNT", discountValue: number): number;
5602
5729
 
5603
- export { type ActiveFlashSalesResponse, type AnalyticsOverview, type ApiResponse, type AppliedDiscount, type Banner, type BannerResponse, BannerType, BaseEcommerceClient, type BaseEntity, type BrowsingLocation, type CalculateCartDiscountsRequest, type CalculateCartDiscountsResponse, type CalculateShippingRequest, type CalculateShippingResponse, type CalculateTaxRequest, type CalculateTaxResponse, type CartItem, type ConfirmEscrowDepositResponse, type Coupon, type CouponResponse, type CouponUsage, type CreateBannerRequest, type CreateCouponRequest, type CreateFlashSaleRequest, type CreateOrderEventRequest, type CreateOrderEventResponse, type CreateOrderRequest, type CreateOrderResponse, type CreateProductRequest, type CreateProductVariantRequest, type CreateReviewRequest, type CreateShippingMethodRequest, type CreateShippingRateRequest, type CreateShippingZoneRequest, type CreateTaxNexusRequest, type CreateTaxRuleRequest, CustomerEcommerceClient, type CustomerMessagesResponse, type CustomerSummary, type DeleteBrowsingLocationResponse, DiscountMethod, DiscountScope, DiscountType, EcommerceApiError, type EcommerceClientConfig, type ExpiringGemBatch, type FlashSale, type FlashSaleAllowanceInfo, type FlashSaleItem, type FlashSaleItemInput, type FollowActionResponse, type FollowStatusResponse, type FollowedMerchantSummary, type GemHistoryItem, type GemHistoryType, type GemHistoryTypeFilter, type GemSource, type GenerateTaxReportRequest, type GetAnalyticsParams, type GetAnalyticsResponse, type GetBrowsingLocationResponse, type GetCouponResponse, type GetExpiringGemsParams, type GetExpiringGemsResponse, type GetFlashSaleAllowanceParams, type GetFlashSaleAllowanceResponse, type GetGemBalanceResponse, type GetGemHistoryParams, type GetGemHistoryResponse, type GetOrderResponse, type GetPaymentMethodsResponse, type GetProductMetricsResponse, type GetProductResponse, type GetTaxReportResponse, InventoryAuditAction, type InventoryAuditEntry, type ListActiveBannersParams, type ListActiveFlashSalesParams, type ListBannersResponse, type ListCouponsResponse, type ListCustomersParams, type ListCustomersResponse, type ListFollowingParams, type ListFollowingResponse, type ListInventoryAuditResponse, type ListMediaAssetsResponse, type ListMerchantProductsParams, type ListMessagesResponse, type ListOrdersParams, type ListOrdersResponse, type ListProductVariantsResponse, type ListProductsParams, type ListProductsResponse, type ListReturnsResponse, type ListReviewsParams, type ListReviewsResponse, type ListShipmentsResponse, type ListShippingAddressesResponse, type ListShippingMethodsResponse, type ListShippingRatesResponse, type ListShippingZonesResponse, type ListTaxNexusResponse, type ListTaxReportsParams, type ListTaxReportsResponse, type ListTaxRulesResponse, type MediaAsset, type MediaAssetResponse, type Merchant, MerchantEcommerceClient, type MerchantProductsResponse, type MerchantProfileRequest, type MerchantProfileResponse, type MerchantShippingSettings, MerchantStatus, type Message, type MessageResponse, type MessageStatsResponse, type Order, type OrderEvent, type OrderItem, type OrderReceiptResponse, OrderStatus, type OrdersByStatus, type PaginatedResponse, type PaginationParams, type Payment, PaymentMethod, type PaymentMethodInfo, PaymentStatus, type ProcessPaymentRequest, type ProcessPaymentResponse, type Product, type ProductDimensions, type ProductDiscountsResponse, type ProductMetrics, type ProductResponse, type ProductReview, ProductSortBy, type ProductVariant, type ProductVariantResponse, type PublicMerchantProfile, type PublicMerchantProfileResponse, type RecentOrderSummary, type RespondToReviewRequest, type Return, type ReturnItem, type ReturnResponse, ReturnStatus, type RevenueByDay, type ReviewResponse, ReviewSortBy, ReviewStatus, type SaveBrowsingLocationRequest, type SaveBrowsingLocationResponse, type SendMessageRequest, type Settlement, type Shipment, type ShipmentResponse, ShipmentStatus, type ShippingAddress$1 as ShippingAddress, type ShippingAddressRequest, type ShippingAddressResponse, type ShippingMethod, type ShippingMethodResponse, type ShippingOption, type ShippingRate, type ShippingRateResponse, type ShippingSettingsResponse, type ShippingZone, type ShippingZoneResponse, SortOrder, type SuccessResponse, TaxBehavior, type TaxBreakdownItem, type TaxNexus, type TaxNexusResponse, type TaxReport, type TaxReportDetails, TaxReportPeriodType, type TaxReportResponse, TaxReportStatus, type TaxRule, type TaxRuleResponse, type TaxSettings, type TaxSettingsResponse, TaxType, type TopProduct, type TrackBannerRequest, type UpdateBannerRequest, type UpdateCouponRequest, type UpdateFlashSaleRequest, type UpdateOrderResponse, type UpdateOrderStatusRequest, type UpdateProductRequest, type UpdateProductVariantRequest, type UpdateShipmentRequest, type UpdateShippingMethodRequest, type UpdateShippingRateRequest, type UpdateShippingSettingsRequest, type UpdateShippingZoneRequest, type UpdateTaxNexusRequest, type UpdateTaxReportStatusRequest, type UpdateTaxRuleRequest, type UpdateTaxSettingsRequest, type UserShippingAddress, type ValidateDiscountRequest, type ValidateDiscountResponse, buildQueryString, calculateDiscountAmount, calculateFinalPrice, formatPrice, getBackoffDelay, isRetryableError, isValidAddress, isValidEmail, parseError, retryWithBackoff, sleep, truncateAddress };
5730
+ export { type ActiveFlashSalesResponse, type AnalyticsOverview, type ApiResponse, type AppliedDiscount, type Banner, type BannerResponse, BannerType, BaseEcommerceClient, type BaseEntity, type BrowsingLocation, type CalculateCartDiscountsRequest, type CalculateCartDiscountsResponse, type CalculateShippingRequest, type CalculateShippingResponse, type CalculateTaxRequest, type CalculateTaxResponse, type CartItem, type CashAccountBalanceResponse, type ConfirmEscrowDepositResponse, type Coupon, type CouponResponse, type CouponUsage, type CreateBannerRequest, type CreateCouponRequest, type CreateFlashSaleRequest, type CreateOrderEventRequest, type CreateOrderEventResponse, type CreateOrderRequest, type CreateOrderResponse, type CreateProductRequest, type CreateProductVariantRequest, type CreateReviewRequest, type CreateShippingMethodRequest, type CreateShippingRateRequest, type CreateShippingZoneRequest, type CreateTaxNexusRequest, type CreateTaxRuleRequest, CustomerEcommerceClient, type CustomerMessagesResponse, type CustomerSummary, type DeleteBrowsingLocationResponse, type DeliveryAddressResponse, DiscountMethod, DiscountScope, DiscountType, EcommerceApiError, type EcommerceClientConfig, type ExpiringGemBatch, type FlashSale, type FlashSaleAllowanceInfo, type FlashSaleItem, type FlashSaleItemInput, type FollowActionResponse, type FollowStatusResponse, type FollowedMerchantSummary, type GemHistoryItem, type GemHistoryType, type GemHistoryTypeFilter, type GemSource, type GenerateTaxReportRequest, type GetAnalyticsParams, type GetAnalyticsResponse, type GetBrowsingLocationResponse, type GetCouponResponse, type GetExpiringGemsParams, type GetExpiringGemsResponse, type GetFlashSaleAllowanceParams, type GetFlashSaleAllowanceResponse, type GetGemBalanceResponse, type GetGemHistoryParams, type GetGemHistoryResponse, type GetOrderResponse, type GetPaymentMethodsResponse, type GetProductMetricsResponse, type GetProductResponse, type GetTaxReportResponse, InventoryAuditAction, type InventoryAuditEntry, type ListActiveBannersParams, type ListActiveFlashSalesParams, type ListBannersResponse, type ListCouponsResponse, type ListCustomersParams, type ListCustomersResponse, type ListFollowingParams, type ListFollowingResponse, type ListInventoryAuditResponse, type ListMediaAssetsResponse, type ListMerchantProductsParams, type ListMessagesResponse, type ListOrdersParams, type ListOrdersResponse, type ListProductVariantsResponse, type ListProductsParams, type ListProductsResponse, type ListReturnsResponse, type ListReviewsParams, type ListReviewsResponse, type ListShipmentsResponse, type ListShippingAddressesResponse, type ListShippingMethodsResponse, type ListShippingRatesResponse, type ListShippingZonesResponse, type ListTaxNexusResponse, type ListTaxReportsParams, type ListTaxReportsResponse, type ListTaxRulesResponse, type MediaAsset, type MediaAssetResponse, type Merchant, MerchantBusinessType, MerchantEcommerceClient, type MerchantProductsResponse, type MerchantProfileRequest, type MerchantProfileResponse, MerchantReturnPolicyType, type MerchantShippingSettings, type MerchantSocialLinks, MerchantStatus, type Message, type MessageResponse, type MessageStatsResponse, type Order, type OrderEvent, type OrderItem, type OrderReceiptResponse, OrderStatus, type OrdersByStatus, type PaginatedResponse, type PaginationParams, type Payment, PaymentMethod, type PaymentMethodInfo, PaymentStatus, type ProcessPaymentRequest, type ProcessPaymentResponse, type Product, type ProductDimensions, type ProductDiscountsResponse, type ProductMetrics, type ProductResponse, type ProductReview, ProductSortBy, type ProductVariant, type ProductVariantResponse, type PublicMerchantProfile, type PublicMerchantProfileResponse, type RecentOrderSummary, type RespondToReviewRequest, type Return, type ReturnItem, type ReturnResponse, ReturnStatus, type RevenueByDay, type ReviewResponse, ReviewSortBy, ReviewStatus, type SaveBrowsingLocationRequest, type SaveBrowsingLocationResponse, type SendMessageRequest, type Settlement, type Shipment, type ShipmentResponse, ShipmentStatus, type ShippingAddress$1 as ShippingAddress, type ShippingAddressRequest, type ShippingAddressResponse, type ShippingMethod, type ShippingMethodResponse, type ShippingOption, type ShippingRate, type ShippingRateResponse, type ShippingSettingsResponse, type ShippingZone, type ShippingZoneResponse, SortOrder, type SuccessResponse, TaxBehavior, type TaxBreakdownItem, type TaxNexus, type TaxNexusResponse, type TaxReport, type TaxReportDetails, TaxReportPeriodType, type TaxReportResponse, TaxReportStatus, type TaxRule, type TaxRuleResponse, type TaxSettings, type TaxSettingsResponse, TaxType, type TopProduct, type TrackBannerRequest, type UpdateBannerRequest, type UpdateCouponRequest, type UpdateFlashSaleRequest, type UpdateOrderResponse, type UpdateOrderStatusRequest, type UpdateProductRequest, type UpdateProductVariantRequest, type UpdateShipmentRequest, type UpdateShippingMethodRequest, type UpdateShippingRateRequest, type UpdateShippingSettingsRequest, type UpdateShippingZoneRequest, type UpdateTaxNexusRequest, type UpdateTaxReportStatusRequest, type UpdateTaxRuleRequest, type UpdateTaxSettingsRequest, type UserShippingAddress, type ValidateDiscountRequest, type ValidateDiscountResponse, buildQueryString, calculateDiscountAmount, calculateFinalPrice, formatPrice, getBackoffDelay, isRetryableError, isValidAddress, isValidEmail, parseError, retryWithBackoff, sleep, truncateAddress };