@retaila/shared-types 1.1.119 → 1.1.120
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.
- package/dist/index.d.mts +159 -1
- package/dist/index.d.ts +159 -1
- package/dist/index.js +35 -0
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +31 -0
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
package/dist/index.d.mts
CHANGED
|
@@ -170,6 +170,31 @@ declare enum AccountDomainStatus {
|
|
|
170
170
|
INACTIVE = "INACTIVE"
|
|
171
171
|
}
|
|
172
172
|
|
|
173
|
+
/** Balance for a calendar month (1-31). */
|
|
174
|
+
interface SellerPeriodBalance {
|
|
175
|
+
year: number;
|
|
176
|
+
month: number;
|
|
177
|
+
balance: number;
|
|
178
|
+
}
|
|
179
|
+
interface Seller {
|
|
180
|
+
id: string;
|
|
181
|
+
name: string;
|
|
182
|
+
commissionPercent: number;
|
|
183
|
+
createdAt: Date;
|
|
184
|
+
updatedAt: Date;
|
|
185
|
+
deletedAt?: Date;
|
|
186
|
+
/** Balance by calendar month (1-31). Present when requested from API. */
|
|
187
|
+
balanceByPeriod?: SellerPeriodBalance[];
|
|
188
|
+
}
|
|
189
|
+
interface ChargeSellerAllocation {
|
|
190
|
+
id: string;
|
|
191
|
+
accountServiceBillingChargeId: string;
|
|
192
|
+
sellerId: string;
|
|
193
|
+
amount: number;
|
|
194
|
+
commissionPercentUsed: number;
|
|
195
|
+
createdAt: Date;
|
|
196
|
+
}
|
|
197
|
+
|
|
173
198
|
interface Account {
|
|
174
199
|
id: string;
|
|
175
200
|
name: string;
|
|
@@ -186,6 +211,8 @@ interface Account {
|
|
|
186
211
|
createdAt: Date;
|
|
187
212
|
updatedAt: Date;
|
|
188
213
|
deletedAt?: Date;
|
|
214
|
+
sellerId?: string;
|
|
215
|
+
seller?: Seller;
|
|
189
216
|
accountDomains?: AccountDomain[];
|
|
190
217
|
}
|
|
191
218
|
declare enum AccountStatus {
|
|
@@ -3187,4 +3214,135 @@ interface UpdateNotificationSettingsDTO {
|
|
|
3187
3214
|
recipientEmails?: string[];
|
|
3188
3215
|
}
|
|
3189
3216
|
|
|
3190
|
-
|
|
3217
|
+
declare enum BillingInterval {
|
|
3218
|
+
MONTHLY = "MONTHLY",
|
|
3219
|
+
SEMIANNUAL = "SEMIANNUAL",
|
|
3220
|
+
ANNUAL = "ANNUAL"
|
|
3221
|
+
}
|
|
3222
|
+
/** Single item in a spec category (display-like structure). */
|
|
3223
|
+
interface ServiceBillingPlanSpecItem {
|
|
3224
|
+
key: string;
|
|
3225
|
+
label: string;
|
|
3226
|
+
}
|
|
3227
|
+
/** Category for the plan comparison table (display only). */
|
|
3228
|
+
interface ServiceBillingPlanSpecCategory {
|
|
3229
|
+
id: string;
|
|
3230
|
+
label: string;
|
|
3231
|
+
/** Keys to show. Legacy when items is set. */
|
|
3232
|
+
itemKeys?: string[];
|
|
3233
|
+
/** Display-like: each item has key and label. When set, used instead of itemKeys + labels. */
|
|
3234
|
+
items?: ServiceBillingPlanSpecItem[];
|
|
3235
|
+
}
|
|
3236
|
+
/** Defines comparison table: structure and optional values. Stored in service_billing_plan.specs. */
|
|
3237
|
+
interface ServiceBillingPlanSpec {
|
|
3238
|
+
categories: ServiceBillingPlanSpecCategory[];
|
|
3239
|
+
/** Map key -> label. Used when category uses itemKeys (legacy). */
|
|
3240
|
+
labels?: Record<string, string>;
|
|
3241
|
+
/** Values for this plan; when set, used for comparison instead of limits. */
|
|
3242
|
+
values?: Record<string, unknown>;
|
|
3243
|
+
}
|
|
3244
|
+
interface ServiceBillingPlanLimits {
|
|
3245
|
+
maxProducts?: number | null;
|
|
3246
|
+
maxBranches?: number | null;
|
|
3247
|
+
maxAccountUsers?: number | null;
|
|
3248
|
+
maxProductCategories?: number | null;
|
|
3249
|
+
maxDeliveryOptions?: number | null;
|
|
3250
|
+
maxIntegrations?: number | null;
|
|
3251
|
+
maxStorageMb?: number | null;
|
|
3252
|
+
customDomainAllowed?: boolean;
|
|
3253
|
+
bulkImportAllowed?: boolean;
|
|
3254
|
+
maxBulkImportRows?: number | null;
|
|
3255
|
+
advancedAnalytics?: boolean;
|
|
3256
|
+
maxOrdersPerMonth?: number | null;
|
|
3257
|
+
/** Soporte: "Estándar" | "Prioritario" | "Dedicado" */
|
|
3258
|
+
supportLevel?: string | null;
|
|
3259
|
+
marketingIncluded?: boolean;
|
|
3260
|
+
customApiIntegrations?: boolean;
|
|
3261
|
+
storeCustomization?: boolean;
|
|
3262
|
+
customEmail?: boolean;
|
|
3263
|
+
reportsAndExport?: boolean;
|
|
3264
|
+
multiCurrency?: boolean;
|
|
3265
|
+
webhooks?: boolean;
|
|
3266
|
+
eInvoicing?: boolean;
|
|
3267
|
+
trainingOnboarding?: boolean;
|
|
3268
|
+
whiteLabel?: boolean;
|
|
3269
|
+
}
|
|
3270
|
+
interface ServiceBillingPlan {
|
|
3271
|
+
id: string;
|
|
3272
|
+
name: string;
|
|
3273
|
+
slug: string;
|
|
3274
|
+
currency: string;
|
|
3275
|
+
description?: string | null;
|
|
3276
|
+
order: number;
|
|
3277
|
+
/** Enforced and display values (maxProducts, maxBranches, feature flags, etc.). */
|
|
3278
|
+
limits?: ServiceBillingPlanLimits | null;
|
|
3279
|
+
/** Optional: comparison table structure (categories, order, labels). If null, backoffice uses default. */
|
|
3280
|
+
specs?: ServiceBillingPlanSpec | null;
|
|
3281
|
+
createdAt: Date;
|
|
3282
|
+
updatedAt: Date;
|
|
3283
|
+
}
|
|
3284
|
+
interface ServiceBillingPlanPrice {
|
|
3285
|
+
id: string;
|
|
3286
|
+
serviceBillingPlanId: string;
|
|
3287
|
+
billingInterval: BillingInterval;
|
|
3288
|
+
amount: number;
|
|
3289
|
+
aiImageCreditsIncluded: number;
|
|
3290
|
+
aiTextCreditsIncluded: number;
|
|
3291
|
+
createdAt: Date;
|
|
3292
|
+
updatedAt: Date;
|
|
3293
|
+
}
|
|
3294
|
+
declare enum AccountServicePlanStatus {
|
|
3295
|
+
ACTIVE = "ACTIVE",
|
|
3296
|
+
ENDED = "ENDED",
|
|
3297
|
+
CANCELLED = "CANCELLED"
|
|
3298
|
+
}
|
|
3299
|
+
interface AccountServicePlan {
|
|
3300
|
+
id: string;
|
|
3301
|
+
accountId: string;
|
|
3302
|
+
serviceBillingPlanId: string;
|
|
3303
|
+
status: AccountServicePlanStatus;
|
|
3304
|
+
customAmount?: number | null;
|
|
3305
|
+
billingInterval?: BillingInterval | null;
|
|
3306
|
+
freePeriodsRemaining: number;
|
|
3307
|
+
installationFee?: number | null;
|
|
3308
|
+
installationFeePaidAt?: Date | null;
|
|
3309
|
+
startedAt: Date;
|
|
3310
|
+
endedAt?: Date | null;
|
|
3311
|
+
notes?: string | null;
|
|
3312
|
+
createdAt: Date;
|
|
3313
|
+
updatedAt: Date;
|
|
3314
|
+
serviceBillingPlan?: ServiceBillingPlan;
|
|
3315
|
+
prices?: ServiceBillingPlanPrice[];
|
|
3316
|
+
}
|
|
3317
|
+
declare enum ChargeType {
|
|
3318
|
+
SUBSCRIPTION = "SUBSCRIPTION",
|
|
3319
|
+
INSTALLATION = "INSTALLATION",
|
|
3320
|
+
ADJUSTMENT = "ADJUSTMENT",
|
|
3321
|
+
OTHER = "OTHER"
|
|
3322
|
+
}
|
|
3323
|
+
declare enum ChargeStatus {
|
|
3324
|
+
PENDING = "PENDING",
|
|
3325
|
+
PAID = "PAID",
|
|
3326
|
+
CANCELLED = "CANCELLED"
|
|
3327
|
+
}
|
|
3328
|
+
interface AccountServiceBillingCharge {
|
|
3329
|
+
id: string;
|
|
3330
|
+
accountId: string;
|
|
3331
|
+
accountServicePlanId?: string | null;
|
|
3332
|
+
amount: number;
|
|
3333
|
+
currency: string;
|
|
3334
|
+
type: ChargeType;
|
|
3335
|
+
billingInterval?: BillingInterval | null;
|
|
3336
|
+
periodStart?: Date | null;
|
|
3337
|
+
periodEnd?: Date | null;
|
|
3338
|
+
dueDate?: Date | null;
|
|
3339
|
+
paidAt?: Date | null;
|
|
3340
|
+
status: ChargeStatus;
|
|
3341
|
+
externalReference?: string | null;
|
|
3342
|
+
description?: string | null;
|
|
3343
|
+
createdAt: Date;
|
|
3344
|
+
updatedAt: Date;
|
|
3345
|
+
deletedAt?: Date | null;
|
|
3346
|
+
}
|
|
3347
|
+
|
|
3348
|
+
export { type Account, type AccountAiCreditTransaction, type AccountAiCredits, type AccountBranch, type AccountBranchSchedule, AccountBranchScheduleDay, AccountBranchScheduleStatus, AccountBranchStatus, type AccountCurrencyConfig, type AccountDeliveryOption, type AccountDeliveryOptionCalculatedCost, AccountDeliveryOptionPriceLogic, AccountDeliveryOptionStatus, type AccountDeliveryOptionZone, AccountDeliveryOptionZoneStatus, type AccountDomain, AccountDomainStatus, type AccountExchangeRate, type AccountExchangeRateListResponse, type AccountExchangeRateMetadata, type AccountExchangeRateQueryDto, type AccountExchangeRateResponse, AccountExchangeRateType, type AccountExchangeRateWithEffectiveRate, type AccountIntegration, type AccountIntegrationConfigDTO, AccountIntegrationConnectionStatus, AccountIntegrationEnvironment, AccountIntegrationStatus, type AccountPaymentMethod, AccountPaymentMethodStatus, type AccountServiceBillingCharge, type AccountServicePlan, AccountServicePlanStatus, AccountStatus, type AccountUserRoleLink, type ActiveSession, type Address, type AdminOrderStatusChangeDto, AiCreditSource, AiCreditTransactionReason, AiCreditType, type AiCreditsBalance, type AnalyticsEvent, AnalyticsEventType, type AnalyticsFunnelStep, type AnalyticsOverview, type AnalyticsPageview, type AnalyticsPagination, type AnalyticsQueryParams, type AnalyticsSession, type BaseEntity, type BaseEntityWithAccount, type BaseEntityWithAccountAndUser, type BaseEntityWithUser, BillingInterval, type ButtonStyle, COUNTRY_DEFAULTS, type Campaign, type CampaignBudget, CampaignBudgetType, type CampaignBudgetUsage, type CampaignData, type CampaignPerformance, CampaignStatus, type Cart, type CartConfirmDto, type CartDeliveryMethod, type CartDeliveryMethodAdjustment, type CartDeliveryMethodCreateData, type CartDeliveryMethodCreateDto, type CartDeliveryMethodFindParams, type CartDeliveryMethodResponse, type CartDeliveryMethodUpdateData, type CartDeliveryMethodUpdateDto, CartDeliveryType, type CartItem, type CartItemAddDto, type CartItemAttributeDetail, CartItemErrorCode, type CartItemRemoveDto, type CartItemUpdateDto, type CartItemValidation, type CartLineItemAdjustment, type CartPromotion, CartSource, CartStatus, type CartUpdateDto, type ChargeSellerAllocation, ChargeStatus, ChargeType, type Collection, type CollectionMedia, type CollectionProductLink, type CollectionRule, CollectionRuleField, CollectionRuleFieldLabels, CollectionRuleOperator, CollectionRuleOperatorLabels, CollectionRulesLogic, CollectionStatus, CollectionStatusLabels, CollectionType, CollectionTypeLabels, type ColorVariant, type CountryDefaultBranchAddress, type CountryDefaultConfig, type CountryDefaultTax, type CreateAccountDeliveryOptionDTO, type CreateAccountExchangeRateDto, type CreateAnalyticsSessionDto, type CreateCollectionDTO, type CreateDeliveryOptionDto, type CreateExchangeRateDto, type CreateFulfillmentDto, type CreateFulfillmentItemDto, type CreatePromotionDTO, type CreateRoleDTO, type CreateStoreComponentTemplateDTO, type CreateStoreTemplateDTO, Currency, type CurrencyConversion, type Customer, CustomerStatus, type CustomerUpsertDto, DayOfWeek, DeliveryType, type DeliveryZoneInput, type DesignTokens, DeviceType, type EffectiveExchangeRate, type ExchangeRate, type ExchangeRateListResponse, type ExchangeRateMetadata, type ExchangeRateQueryDto, type ExchangeRateResponse, type Fulfillment, type FulfillmentDeliveryOption, type FulfillmentItem, type FulfillmentLabel, type FulfillmentLabelCreateData, type FulfillmentLabelUpdateData, type FulfillmentProviderAdapter, type FulfillmentProviderContext, type FulfillmentProviderCreateInput, type FulfillmentProviderCreateOutput, type FulfillmentProviderKey, type FulfillmentProviderProcessWebhookInput, type FulfillmentProviderProcessWebhookOutput, type FulfillmentRecollectionCapabilities, type FulfillmentRecollectionConfig, type FulfillmentRecollectionMode, type FulfillmentRecollectionSchedule, FulfillmentStatus, type FulfillmentTrackingEvent, type FunnelData, FunnelStep, type FunnelStepData, type GeoZone, type GeoZoneInput, GeoZoneStatus, type HistoricalDataPoint, type Integration, IntegrationCategory, type IntegrationDeliveryZone, IntegrationDeliveryZoneStatus, IntegrationStatus, type InternalNotificationConfig, InternalNotificationType, type LinkButtonStyle, type MapPosition, type Media, MediaType, NavigationItemType, type NavigationMenuConfig, type NavigationMenuItem, type NeutralColorScale, type NextStatusAction, type Order, type OrderCreateFromCartDto, type OrderDeliveryMethod, type OrderDeliveryMethodAdjustment, type OrderDeliveryMethodCreateData, type OrderDeliveryMethodUpdateData, OrderDeliveryType, type OrderItem, type OrderItemSnapshot, type OrderLineItemAdjustment, OrderPaymentStatus, type OrderPromotion, OrderSource, OrderStatus, type PageData, PageType, type Payment, type PaymentCardBrand, PaymentCardBrandKey, type PaymentConversion, PaymentMethodType, type PaymentProviderAdapter, type PaymentProviderCaptureInput, type PaymentProviderCaptureOutput, type PaymentProviderContext, type PaymentProviderInitInput, type PaymentProviderInitOutput, type PaymentProviderKey, type PaymentProviderRefundInput, type PaymentProviderRefundOutput, type PaymentProviderWebhookResult, PaymentStatus, type Permission, type Phone, type PickupLocation, type Product, type ProductAnalyticsData, type ProductAnalyticsItem, type ProductAttribute, type ProductAttributeOption, ProductAttributeStatus, ProductAttributeType, type ProductCategory, ProductCategoryStatus, ProductStatus, ProductType, type ProductVariant, ProductVariantStatus, type Promotion, type PromotionApplicationMethod, type PromotionApplicationMethodInput, type PromotionApplicationMethodPromotionRule, PromotionApplicationType, type PromotionListFilters, type PromotionPromotionRule, type PromotionRule, type PromotionRuleInput, PromotionRuleOperator, type PromotionRuleValue, PromotionStatus, PromotionTargetType, PromotionType, PubSubTopics, type RealtimeAnalytics, type RecentEvent, type Role, type RolePermissionLink, type RoundingConfig, RoundingMethod, RoundingRule, SUPPORTED_COUNTRIES, type Seller, type SellerPeriodBalance, type ServiceBillingPlan, type ServiceBillingPlanLimits, type ServiceBillingPlanPrice, type ServiceBillingPlanSpec, type ServiceBillingPlanSpecCategory, type ServiceBillingPlanSpecItem, type SessionHeartbeatDto, type StandardCategory, StandardCategoryStatus, type StatusChangeHistory, type StatusFlow, type StoreBanner, StoreBannerStatus, type StoreComponentTemplate, type StoreCustomization, type StoreCustomizationComponentSettings, type StoreCustomizationFooterZone, type StoreCustomizationHeaderZone, type StoreCustomizationLayout, type StoreCustomizationLayoutComponent, type StoreCustomizationLayoutLegacy, type StoreCustomizationPage, type StoreCustomizationPageComponent, type StoreCustomizationSeo, type StoreCustomizationThemeButtons, type StoreCustomizationThemeColors, type StoreCustomizationThemeTypography, type StorePage, StorePageStatus, StorePageType, type StoreSettings, type StoreTemplate, type StoreTemplateMocks, type SupportConversation, SupportConversationChannel, type SupportConversationMessage, SupportConversationMessageAiAnalysisStatus, SupportConversationMessageDeliveryStatus, SupportConversationMessageDirection, SupportConversationMessageSenderType, SupportConversationPriority, SupportConversationStatus, SupportConversationVisibility, type SupportedCountryCode, type SurfaceColors, type ThemeBorderRadius, type ThemeBorderWidth, type ThemeBorders, type ThemeButtonSize, type ThemeButtonSizes, type ThemeButtonVariant, type ThemeButtonVariants, type ThemeButtons, type ThemeColorPalette, type ThemeConfig, type ThemeFonts, type ThemeProductCard, type ThemeShadows, type ThemeSpacing, type ThemeTypography, type ThemeTypographySizes, type ThemeTypographyStyles, type TopPagesData, type TrackEventDto, type TrackPageviewDto, TrafficSource, type TrafficSourceItem, type TrafficSourcesData, type TypographyStyle, type UpdateAccountDeliveryOptionDTO, type UpdateAccountExchangeRateAllDto, type UpdateAccountExchangeRateDto, type UpdateCollectionDTO, type UpdateExchangeRateDto, type UpdateFulfillmentDto, type UpdateNotificationSettingsDTO, type UpdatePromotionDTO, type UpdateRoleDTO, type UpdateStoreComponentTemplateDTO, type UpdateStoreTemplateDTO, type Webhook, type WebhookPayload, getAccountPaymentMethodStatusInfo, getCountryDefaults, getCurrencySymbol, getFulfillmentStatusInfo, getIntegrationCategoryName, getOrderPaymentStatusInfo, getOrderStatusInfo, getPaymentCardBrand, getPaymentStatusInfo, getProductStatusInfo, isLegacyLayout, isSupportedCountry, isZonedLayout, parsePriceFormatPattern };
|
package/dist/index.d.ts
CHANGED
|
@@ -170,6 +170,31 @@ declare enum AccountDomainStatus {
|
|
|
170
170
|
INACTIVE = "INACTIVE"
|
|
171
171
|
}
|
|
172
172
|
|
|
173
|
+
/** Balance for a calendar month (1-31). */
|
|
174
|
+
interface SellerPeriodBalance {
|
|
175
|
+
year: number;
|
|
176
|
+
month: number;
|
|
177
|
+
balance: number;
|
|
178
|
+
}
|
|
179
|
+
interface Seller {
|
|
180
|
+
id: string;
|
|
181
|
+
name: string;
|
|
182
|
+
commissionPercent: number;
|
|
183
|
+
createdAt: Date;
|
|
184
|
+
updatedAt: Date;
|
|
185
|
+
deletedAt?: Date;
|
|
186
|
+
/** Balance by calendar month (1-31). Present when requested from API. */
|
|
187
|
+
balanceByPeriod?: SellerPeriodBalance[];
|
|
188
|
+
}
|
|
189
|
+
interface ChargeSellerAllocation {
|
|
190
|
+
id: string;
|
|
191
|
+
accountServiceBillingChargeId: string;
|
|
192
|
+
sellerId: string;
|
|
193
|
+
amount: number;
|
|
194
|
+
commissionPercentUsed: number;
|
|
195
|
+
createdAt: Date;
|
|
196
|
+
}
|
|
197
|
+
|
|
173
198
|
interface Account {
|
|
174
199
|
id: string;
|
|
175
200
|
name: string;
|
|
@@ -186,6 +211,8 @@ interface Account {
|
|
|
186
211
|
createdAt: Date;
|
|
187
212
|
updatedAt: Date;
|
|
188
213
|
deletedAt?: Date;
|
|
214
|
+
sellerId?: string;
|
|
215
|
+
seller?: Seller;
|
|
189
216
|
accountDomains?: AccountDomain[];
|
|
190
217
|
}
|
|
191
218
|
declare enum AccountStatus {
|
|
@@ -3187,4 +3214,135 @@ interface UpdateNotificationSettingsDTO {
|
|
|
3187
3214
|
recipientEmails?: string[];
|
|
3188
3215
|
}
|
|
3189
3216
|
|
|
3190
|
-
|
|
3217
|
+
declare enum BillingInterval {
|
|
3218
|
+
MONTHLY = "MONTHLY",
|
|
3219
|
+
SEMIANNUAL = "SEMIANNUAL",
|
|
3220
|
+
ANNUAL = "ANNUAL"
|
|
3221
|
+
}
|
|
3222
|
+
/** Single item in a spec category (display-like structure). */
|
|
3223
|
+
interface ServiceBillingPlanSpecItem {
|
|
3224
|
+
key: string;
|
|
3225
|
+
label: string;
|
|
3226
|
+
}
|
|
3227
|
+
/** Category for the plan comparison table (display only). */
|
|
3228
|
+
interface ServiceBillingPlanSpecCategory {
|
|
3229
|
+
id: string;
|
|
3230
|
+
label: string;
|
|
3231
|
+
/** Keys to show. Legacy when items is set. */
|
|
3232
|
+
itemKeys?: string[];
|
|
3233
|
+
/** Display-like: each item has key and label. When set, used instead of itemKeys + labels. */
|
|
3234
|
+
items?: ServiceBillingPlanSpecItem[];
|
|
3235
|
+
}
|
|
3236
|
+
/** Defines comparison table: structure and optional values. Stored in service_billing_plan.specs. */
|
|
3237
|
+
interface ServiceBillingPlanSpec {
|
|
3238
|
+
categories: ServiceBillingPlanSpecCategory[];
|
|
3239
|
+
/** Map key -> label. Used when category uses itemKeys (legacy). */
|
|
3240
|
+
labels?: Record<string, string>;
|
|
3241
|
+
/** Values for this plan; when set, used for comparison instead of limits. */
|
|
3242
|
+
values?: Record<string, unknown>;
|
|
3243
|
+
}
|
|
3244
|
+
interface ServiceBillingPlanLimits {
|
|
3245
|
+
maxProducts?: number | null;
|
|
3246
|
+
maxBranches?: number | null;
|
|
3247
|
+
maxAccountUsers?: number | null;
|
|
3248
|
+
maxProductCategories?: number | null;
|
|
3249
|
+
maxDeliveryOptions?: number | null;
|
|
3250
|
+
maxIntegrations?: number | null;
|
|
3251
|
+
maxStorageMb?: number | null;
|
|
3252
|
+
customDomainAllowed?: boolean;
|
|
3253
|
+
bulkImportAllowed?: boolean;
|
|
3254
|
+
maxBulkImportRows?: number | null;
|
|
3255
|
+
advancedAnalytics?: boolean;
|
|
3256
|
+
maxOrdersPerMonth?: number | null;
|
|
3257
|
+
/** Soporte: "Estándar" | "Prioritario" | "Dedicado" */
|
|
3258
|
+
supportLevel?: string | null;
|
|
3259
|
+
marketingIncluded?: boolean;
|
|
3260
|
+
customApiIntegrations?: boolean;
|
|
3261
|
+
storeCustomization?: boolean;
|
|
3262
|
+
customEmail?: boolean;
|
|
3263
|
+
reportsAndExport?: boolean;
|
|
3264
|
+
multiCurrency?: boolean;
|
|
3265
|
+
webhooks?: boolean;
|
|
3266
|
+
eInvoicing?: boolean;
|
|
3267
|
+
trainingOnboarding?: boolean;
|
|
3268
|
+
whiteLabel?: boolean;
|
|
3269
|
+
}
|
|
3270
|
+
interface ServiceBillingPlan {
|
|
3271
|
+
id: string;
|
|
3272
|
+
name: string;
|
|
3273
|
+
slug: string;
|
|
3274
|
+
currency: string;
|
|
3275
|
+
description?: string | null;
|
|
3276
|
+
order: number;
|
|
3277
|
+
/** Enforced and display values (maxProducts, maxBranches, feature flags, etc.). */
|
|
3278
|
+
limits?: ServiceBillingPlanLimits | null;
|
|
3279
|
+
/** Optional: comparison table structure (categories, order, labels). If null, backoffice uses default. */
|
|
3280
|
+
specs?: ServiceBillingPlanSpec | null;
|
|
3281
|
+
createdAt: Date;
|
|
3282
|
+
updatedAt: Date;
|
|
3283
|
+
}
|
|
3284
|
+
interface ServiceBillingPlanPrice {
|
|
3285
|
+
id: string;
|
|
3286
|
+
serviceBillingPlanId: string;
|
|
3287
|
+
billingInterval: BillingInterval;
|
|
3288
|
+
amount: number;
|
|
3289
|
+
aiImageCreditsIncluded: number;
|
|
3290
|
+
aiTextCreditsIncluded: number;
|
|
3291
|
+
createdAt: Date;
|
|
3292
|
+
updatedAt: Date;
|
|
3293
|
+
}
|
|
3294
|
+
declare enum AccountServicePlanStatus {
|
|
3295
|
+
ACTIVE = "ACTIVE",
|
|
3296
|
+
ENDED = "ENDED",
|
|
3297
|
+
CANCELLED = "CANCELLED"
|
|
3298
|
+
}
|
|
3299
|
+
interface AccountServicePlan {
|
|
3300
|
+
id: string;
|
|
3301
|
+
accountId: string;
|
|
3302
|
+
serviceBillingPlanId: string;
|
|
3303
|
+
status: AccountServicePlanStatus;
|
|
3304
|
+
customAmount?: number | null;
|
|
3305
|
+
billingInterval?: BillingInterval | null;
|
|
3306
|
+
freePeriodsRemaining: number;
|
|
3307
|
+
installationFee?: number | null;
|
|
3308
|
+
installationFeePaidAt?: Date | null;
|
|
3309
|
+
startedAt: Date;
|
|
3310
|
+
endedAt?: Date | null;
|
|
3311
|
+
notes?: string | null;
|
|
3312
|
+
createdAt: Date;
|
|
3313
|
+
updatedAt: Date;
|
|
3314
|
+
serviceBillingPlan?: ServiceBillingPlan;
|
|
3315
|
+
prices?: ServiceBillingPlanPrice[];
|
|
3316
|
+
}
|
|
3317
|
+
declare enum ChargeType {
|
|
3318
|
+
SUBSCRIPTION = "SUBSCRIPTION",
|
|
3319
|
+
INSTALLATION = "INSTALLATION",
|
|
3320
|
+
ADJUSTMENT = "ADJUSTMENT",
|
|
3321
|
+
OTHER = "OTHER"
|
|
3322
|
+
}
|
|
3323
|
+
declare enum ChargeStatus {
|
|
3324
|
+
PENDING = "PENDING",
|
|
3325
|
+
PAID = "PAID",
|
|
3326
|
+
CANCELLED = "CANCELLED"
|
|
3327
|
+
}
|
|
3328
|
+
interface AccountServiceBillingCharge {
|
|
3329
|
+
id: string;
|
|
3330
|
+
accountId: string;
|
|
3331
|
+
accountServicePlanId?: string | null;
|
|
3332
|
+
amount: number;
|
|
3333
|
+
currency: string;
|
|
3334
|
+
type: ChargeType;
|
|
3335
|
+
billingInterval?: BillingInterval | null;
|
|
3336
|
+
periodStart?: Date | null;
|
|
3337
|
+
periodEnd?: Date | null;
|
|
3338
|
+
dueDate?: Date | null;
|
|
3339
|
+
paidAt?: Date | null;
|
|
3340
|
+
status: ChargeStatus;
|
|
3341
|
+
externalReference?: string | null;
|
|
3342
|
+
description?: string | null;
|
|
3343
|
+
createdAt: Date;
|
|
3344
|
+
updatedAt: Date;
|
|
3345
|
+
deletedAt?: Date | null;
|
|
3346
|
+
}
|
|
3347
|
+
|
|
3348
|
+
export { type Account, type AccountAiCreditTransaction, type AccountAiCredits, type AccountBranch, type AccountBranchSchedule, AccountBranchScheduleDay, AccountBranchScheduleStatus, AccountBranchStatus, type AccountCurrencyConfig, type AccountDeliveryOption, type AccountDeliveryOptionCalculatedCost, AccountDeliveryOptionPriceLogic, AccountDeliveryOptionStatus, type AccountDeliveryOptionZone, AccountDeliveryOptionZoneStatus, type AccountDomain, AccountDomainStatus, type AccountExchangeRate, type AccountExchangeRateListResponse, type AccountExchangeRateMetadata, type AccountExchangeRateQueryDto, type AccountExchangeRateResponse, AccountExchangeRateType, type AccountExchangeRateWithEffectiveRate, type AccountIntegration, type AccountIntegrationConfigDTO, AccountIntegrationConnectionStatus, AccountIntegrationEnvironment, AccountIntegrationStatus, type AccountPaymentMethod, AccountPaymentMethodStatus, type AccountServiceBillingCharge, type AccountServicePlan, AccountServicePlanStatus, AccountStatus, type AccountUserRoleLink, type ActiveSession, type Address, type AdminOrderStatusChangeDto, AiCreditSource, AiCreditTransactionReason, AiCreditType, type AiCreditsBalance, type AnalyticsEvent, AnalyticsEventType, type AnalyticsFunnelStep, type AnalyticsOverview, type AnalyticsPageview, type AnalyticsPagination, type AnalyticsQueryParams, type AnalyticsSession, type BaseEntity, type BaseEntityWithAccount, type BaseEntityWithAccountAndUser, type BaseEntityWithUser, BillingInterval, type ButtonStyle, COUNTRY_DEFAULTS, type Campaign, type CampaignBudget, CampaignBudgetType, type CampaignBudgetUsage, type CampaignData, type CampaignPerformance, CampaignStatus, type Cart, type CartConfirmDto, type CartDeliveryMethod, type CartDeliveryMethodAdjustment, type CartDeliveryMethodCreateData, type CartDeliveryMethodCreateDto, type CartDeliveryMethodFindParams, type CartDeliveryMethodResponse, type CartDeliveryMethodUpdateData, type CartDeliveryMethodUpdateDto, CartDeliveryType, type CartItem, type CartItemAddDto, type CartItemAttributeDetail, CartItemErrorCode, type CartItemRemoveDto, type CartItemUpdateDto, type CartItemValidation, type CartLineItemAdjustment, type CartPromotion, CartSource, CartStatus, type CartUpdateDto, type ChargeSellerAllocation, ChargeStatus, ChargeType, type Collection, type CollectionMedia, type CollectionProductLink, type CollectionRule, CollectionRuleField, CollectionRuleFieldLabels, CollectionRuleOperator, CollectionRuleOperatorLabels, CollectionRulesLogic, CollectionStatus, CollectionStatusLabels, CollectionType, CollectionTypeLabels, type ColorVariant, type CountryDefaultBranchAddress, type CountryDefaultConfig, type CountryDefaultTax, type CreateAccountDeliveryOptionDTO, type CreateAccountExchangeRateDto, type CreateAnalyticsSessionDto, type CreateCollectionDTO, type CreateDeliveryOptionDto, type CreateExchangeRateDto, type CreateFulfillmentDto, type CreateFulfillmentItemDto, type CreatePromotionDTO, type CreateRoleDTO, type CreateStoreComponentTemplateDTO, type CreateStoreTemplateDTO, Currency, type CurrencyConversion, type Customer, CustomerStatus, type CustomerUpsertDto, DayOfWeek, DeliveryType, type DeliveryZoneInput, type DesignTokens, DeviceType, type EffectiveExchangeRate, type ExchangeRate, type ExchangeRateListResponse, type ExchangeRateMetadata, type ExchangeRateQueryDto, type ExchangeRateResponse, type Fulfillment, type FulfillmentDeliveryOption, type FulfillmentItem, type FulfillmentLabel, type FulfillmentLabelCreateData, type FulfillmentLabelUpdateData, type FulfillmentProviderAdapter, type FulfillmentProviderContext, type FulfillmentProviderCreateInput, type FulfillmentProviderCreateOutput, type FulfillmentProviderKey, type FulfillmentProviderProcessWebhookInput, type FulfillmentProviderProcessWebhookOutput, type FulfillmentRecollectionCapabilities, type FulfillmentRecollectionConfig, type FulfillmentRecollectionMode, type FulfillmentRecollectionSchedule, FulfillmentStatus, type FulfillmentTrackingEvent, type FunnelData, FunnelStep, type FunnelStepData, type GeoZone, type GeoZoneInput, GeoZoneStatus, type HistoricalDataPoint, type Integration, IntegrationCategory, type IntegrationDeliveryZone, IntegrationDeliveryZoneStatus, IntegrationStatus, type InternalNotificationConfig, InternalNotificationType, type LinkButtonStyle, type MapPosition, type Media, MediaType, NavigationItemType, type NavigationMenuConfig, type NavigationMenuItem, type NeutralColorScale, type NextStatusAction, type Order, type OrderCreateFromCartDto, type OrderDeliveryMethod, type OrderDeliveryMethodAdjustment, type OrderDeliveryMethodCreateData, type OrderDeliveryMethodUpdateData, OrderDeliveryType, type OrderItem, type OrderItemSnapshot, type OrderLineItemAdjustment, OrderPaymentStatus, type OrderPromotion, OrderSource, OrderStatus, type PageData, PageType, type Payment, type PaymentCardBrand, PaymentCardBrandKey, type PaymentConversion, PaymentMethodType, type PaymentProviderAdapter, type PaymentProviderCaptureInput, type PaymentProviderCaptureOutput, type PaymentProviderContext, type PaymentProviderInitInput, type PaymentProviderInitOutput, type PaymentProviderKey, type PaymentProviderRefundInput, type PaymentProviderRefundOutput, type PaymentProviderWebhookResult, PaymentStatus, type Permission, type Phone, type PickupLocation, type Product, type ProductAnalyticsData, type ProductAnalyticsItem, type ProductAttribute, type ProductAttributeOption, ProductAttributeStatus, ProductAttributeType, type ProductCategory, ProductCategoryStatus, ProductStatus, ProductType, type ProductVariant, ProductVariantStatus, type Promotion, type PromotionApplicationMethod, type PromotionApplicationMethodInput, type PromotionApplicationMethodPromotionRule, PromotionApplicationType, type PromotionListFilters, type PromotionPromotionRule, type PromotionRule, type PromotionRuleInput, PromotionRuleOperator, type PromotionRuleValue, PromotionStatus, PromotionTargetType, PromotionType, PubSubTopics, type RealtimeAnalytics, type RecentEvent, type Role, type RolePermissionLink, type RoundingConfig, RoundingMethod, RoundingRule, SUPPORTED_COUNTRIES, type Seller, type SellerPeriodBalance, type ServiceBillingPlan, type ServiceBillingPlanLimits, type ServiceBillingPlanPrice, type ServiceBillingPlanSpec, type ServiceBillingPlanSpecCategory, type ServiceBillingPlanSpecItem, type SessionHeartbeatDto, type StandardCategory, StandardCategoryStatus, type StatusChangeHistory, type StatusFlow, type StoreBanner, StoreBannerStatus, type StoreComponentTemplate, type StoreCustomization, type StoreCustomizationComponentSettings, type StoreCustomizationFooterZone, type StoreCustomizationHeaderZone, type StoreCustomizationLayout, type StoreCustomizationLayoutComponent, type StoreCustomizationLayoutLegacy, type StoreCustomizationPage, type StoreCustomizationPageComponent, type StoreCustomizationSeo, type StoreCustomizationThemeButtons, type StoreCustomizationThemeColors, type StoreCustomizationThemeTypography, type StorePage, StorePageStatus, StorePageType, type StoreSettings, type StoreTemplate, type StoreTemplateMocks, type SupportConversation, SupportConversationChannel, type SupportConversationMessage, SupportConversationMessageAiAnalysisStatus, SupportConversationMessageDeliveryStatus, SupportConversationMessageDirection, SupportConversationMessageSenderType, SupportConversationPriority, SupportConversationStatus, SupportConversationVisibility, type SupportedCountryCode, type SurfaceColors, type ThemeBorderRadius, type ThemeBorderWidth, type ThemeBorders, type ThemeButtonSize, type ThemeButtonSizes, type ThemeButtonVariant, type ThemeButtonVariants, type ThemeButtons, type ThemeColorPalette, type ThemeConfig, type ThemeFonts, type ThemeProductCard, type ThemeShadows, type ThemeSpacing, type ThemeTypography, type ThemeTypographySizes, type ThemeTypographyStyles, type TopPagesData, type TrackEventDto, type TrackPageviewDto, TrafficSource, type TrafficSourceItem, type TrafficSourcesData, type TypographyStyle, type UpdateAccountDeliveryOptionDTO, type UpdateAccountExchangeRateAllDto, type UpdateAccountExchangeRateDto, type UpdateCollectionDTO, type UpdateExchangeRateDto, type UpdateFulfillmentDto, type UpdateNotificationSettingsDTO, type UpdatePromotionDTO, type UpdateRoleDTO, type UpdateStoreComponentTemplateDTO, type UpdateStoreTemplateDTO, type Webhook, type WebhookPayload, getAccountPaymentMethodStatusInfo, getCountryDefaults, getCurrencySymbol, getFulfillmentStatusInfo, getIntegrationCategoryName, getOrderPaymentStatusInfo, getOrderStatusInfo, getPaymentCardBrand, getPaymentStatusInfo, getProductStatusInfo, isLegacyLayout, isSupportedCountry, isZonedLayout, parsePriceFormatPattern };
|
package/dist/index.js
CHANGED
|
@@ -33,11 +33,13 @@ __export(index_exports, {
|
|
|
33
33
|
AccountIntegrationEnvironment: () => AccountIntegrationEnvironment,
|
|
34
34
|
AccountIntegrationStatus: () => AccountIntegrationStatus,
|
|
35
35
|
AccountPaymentMethodStatus: () => AccountPaymentMethodStatus,
|
|
36
|
+
AccountServicePlanStatus: () => AccountServicePlanStatus,
|
|
36
37
|
AccountStatus: () => AccountStatus,
|
|
37
38
|
AiCreditSource: () => AiCreditSource,
|
|
38
39
|
AiCreditTransactionReason: () => AiCreditTransactionReason,
|
|
39
40
|
AiCreditType: () => AiCreditType,
|
|
40
41
|
AnalyticsEventType: () => AnalyticsEventType,
|
|
42
|
+
BillingInterval: () => BillingInterval,
|
|
41
43
|
COUNTRY_DEFAULTS: () => COUNTRY_DEFAULTS,
|
|
42
44
|
CampaignBudgetType: () => CampaignBudgetType,
|
|
43
45
|
CampaignStatus: () => CampaignStatus,
|
|
@@ -45,6 +47,8 @@ __export(index_exports, {
|
|
|
45
47
|
CartItemErrorCode: () => CartItemErrorCode,
|
|
46
48
|
CartSource: () => CartSource,
|
|
47
49
|
CartStatus: () => CartStatus,
|
|
50
|
+
ChargeStatus: () => ChargeStatus,
|
|
51
|
+
ChargeType: () => ChargeType,
|
|
48
52
|
CollectionRuleField: () => CollectionRuleField,
|
|
49
53
|
CollectionRuleFieldLabels: () => CollectionRuleFieldLabels,
|
|
50
54
|
CollectionRuleOperator: () => CollectionRuleOperator,
|
|
@@ -1086,6 +1090,33 @@ var InternalNotificationType = /* @__PURE__ */ ((InternalNotificationType2) => {
|
|
|
1086
1090
|
InternalNotificationType2["CONTACT_FORM_SUBMITTED"] = "CONTACT_FORM_SUBMITTED";
|
|
1087
1091
|
return InternalNotificationType2;
|
|
1088
1092
|
})(InternalNotificationType || {});
|
|
1093
|
+
|
|
1094
|
+
// src/serviceBilling/types.ts
|
|
1095
|
+
var BillingInterval = /* @__PURE__ */ ((BillingInterval2) => {
|
|
1096
|
+
BillingInterval2["MONTHLY"] = "MONTHLY";
|
|
1097
|
+
BillingInterval2["SEMIANNUAL"] = "SEMIANNUAL";
|
|
1098
|
+
BillingInterval2["ANNUAL"] = "ANNUAL";
|
|
1099
|
+
return BillingInterval2;
|
|
1100
|
+
})(BillingInterval || {});
|
|
1101
|
+
var AccountServicePlanStatus = /* @__PURE__ */ ((AccountServicePlanStatus2) => {
|
|
1102
|
+
AccountServicePlanStatus2["ACTIVE"] = "ACTIVE";
|
|
1103
|
+
AccountServicePlanStatus2["ENDED"] = "ENDED";
|
|
1104
|
+
AccountServicePlanStatus2["CANCELLED"] = "CANCELLED";
|
|
1105
|
+
return AccountServicePlanStatus2;
|
|
1106
|
+
})(AccountServicePlanStatus || {});
|
|
1107
|
+
var ChargeType = /* @__PURE__ */ ((ChargeType2) => {
|
|
1108
|
+
ChargeType2["SUBSCRIPTION"] = "SUBSCRIPTION";
|
|
1109
|
+
ChargeType2["INSTALLATION"] = "INSTALLATION";
|
|
1110
|
+
ChargeType2["ADJUSTMENT"] = "ADJUSTMENT";
|
|
1111
|
+
ChargeType2["OTHER"] = "OTHER";
|
|
1112
|
+
return ChargeType2;
|
|
1113
|
+
})(ChargeType || {});
|
|
1114
|
+
var ChargeStatus = /* @__PURE__ */ ((ChargeStatus2) => {
|
|
1115
|
+
ChargeStatus2["PENDING"] = "PENDING";
|
|
1116
|
+
ChargeStatus2["PAID"] = "PAID";
|
|
1117
|
+
ChargeStatus2["CANCELLED"] = "CANCELLED";
|
|
1118
|
+
return ChargeStatus2;
|
|
1119
|
+
})(ChargeStatus || {});
|
|
1089
1120
|
// Annotate the CommonJS export names for ESM import in node:
|
|
1090
1121
|
0 && (module.exports = {
|
|
1091
1122
|
AccountBranchScheduleDay,
|
|
@@ -1100,11 +1131,13 @@ var InternalNotificationType = /* @__PURE__ */ ((InternalNotificationType2) => {
|
|
|
1100
1131
|
AccountIntegrationEnvironment,
|
|
1101
1132
|
AccountIntegrationStatus,
|
|
1102
1133
|
AccountPaymentMethodStatus,
|
|
1134
|
+
AccountServicePlanStatus,
|
|
1103
1135
|
AccountStatus,
|
|
1104
1136
|
AiCreditSource,
|
|
1105
1137
|
AiCreditTransactionReason,
|
|
1106
1138
|
AiCreditType,
|
|
1107
1139
|
AnalyticsEventType,
|
|
1140
|
+
BillingInterval,
|
|
1108
1141
|
COUNTRY_DEFAULTS,
|
|
1109
1142
|
CampaignBudgetType,
|
|
1110
1143
|
CampaignStatus,
|
|
@@ -1112,6 +1145,8 @@ var InternalNotificationType = /* @__PURE__ */ ((InternalNotificationType2) => {
|
|
|
1112
1145
|
CartItemErrorCode,
|
|
1113
1146
|
CartSource,
|
|
1114
1147
|
CartStatus,
|
|
1148
|
+
ChargeStatus,
|
|
1149
|
+
ChargeType,
|
|
1115
1150
|
CollectionRuleField,
|
|
1116
1151
|
CollectionRuleFieldLabels,
|
|
1117
1152
|
CollectionRuleOperator,
|