commerce-kit 0.54.0 → 0.55.0

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.
Files changed (3) hide show
  1. package/dist/api-types.d.ts +160 -375
  2. package/dist/index.d.ts +1 -1
  3. package/package.json +1 -1
package/dist/api-types.d.ts CHANGED
@@ -4641,6 +4641,7 @@ type APIOrdersBrowseResult = {
4641
4641
  status: "completed" | "cancelled" | "created" | "paid" | "processing" | "shipped" | "refunded" | "partially_refunded";
4642
4642
  environment: "live" | "test";
4643
4643
  storeId: string;
4644
+ source: string | null;
4644
4645
  customerId: string | null;
4645
4646
  lookup: number;
4646
4647
  cartId: string | null;
@@ -5117,7 +5118,6 @@ type APIOrdersBrowseResult = {
5117
5118
  }[] | null;
5118
5119
  };
5119
5120
  externalShipmentId: string | null;
5120
- source: string | null;
5121
5121
  paymentDeduplicationId: string | null;
5122
5122
  ticketCode: string | null;
5123
5123
  activeSubscriptionId: string | null;
@@ -5612,6 +5612,7 @@ type APIOrderGetByIdResult = {
5612
5612
  status: "completed" | "cancelled" | "created" | "paid" | "processing" | "shipped" | "refunded" | "partially_refunded";
5613
5613
  environment: "live" | "test";
5614
5614
  storeId: string;
5615
+ source: string | null;
5615
5616
  customerId: string | null;
5616
5617
  lookup: number;
5617
5618
  cartId: string | null;
@@ -6088,7 +6089,6 @@ type APIOrderGetByIdResult = {
6088
6089
  }[] | null;
6089
6090
  };
6090
6091
  externalShipmentId: string | null;
6091
- source: string | null;
6092
6092
  paymentDeduplicationId: string | null;
6093
6093
  ticketCode: string | null;
6094
6094
  activeSubscriptionId: string | null;
@@ -6997,386 +6997,167 @@ type APICollectionGetByIdParams = {
6997
6997
  type APICollectionGetByIdQueryParams = {
6998
6998
  lang?: string;
6999
6999
  };
7000
- type APIMeGetResult = {
7001
- store: NonNullable<{
7002
- settings: {
7003
- enabledTools: {
7004
- blog: boolean;
7005
- newsletter: boolean;
7006
- loyalty: boolean;
7007
- reviews: boolean;
7008
- productSubscriptions: boolean;
7009
- contactForm: boolean;
7010
- wishlist: boolean;
7011
- cookieConsent: boolean;
7012
- auctions: boolean;
7013
- surveys: boolean;
7014
- bookings: boolean;
7015
- productSets: boolean;
7016
- restockNotifications: boolean;
7017
- abandonedCarts: boolean;
7018
- newsletterPopup: boolean;
7019
- stripeTaxes: boolean;
7020
- translations: boolean;
7021
- cartRecommendations: boolean;
7022
- withdrawalButton: boolean;
7023
- events: boolean;
7024
- } | null;
7025
- enabledLanguages: {
7026
- "en-US": boolean;
7027
- "pl-PL": boolean;
7028
- "es-ES": boolean;
7029
- "de-DE": boolean;
7030
- } | null;
7031
- storeName?: string | null | undefined;
7032
- storeDescription?: string | null | undefined;
7033
- socials?: {
7034
- email?: string | null | undefined;
7035
- instagram?: string | null | undefined;
7036
- linkedin?: string | null | undefined;
7037
- x?: string | null | undefined;
7038
- facebook?: string | null | undefined;
7039
- youtube?: string | null | undefined;
7040
- tiktok?: string | null | undefined;
7000
+ type APIMeStore = {
7001
+ id: string;
7002
+ name: string;
7003
+ subdomain: string;
7004
+ domain: string | null;
7005
+ domainVerified: boolean;
7006
+ currency: string;
7007
+ locale: string;
7008
+ published: boolean;
7009
+ environment: "live" | "test";
7010
+ settings: {
7011
+ storeName: string | null | undefined;
7012
+ storeDescription: string | null | undefined;
7013
+ socials: {
7014
+ email?: string | null | undefined;
7015
+ instagram?: string | null | undefined;
7016
+ linkedin?: string | null | undefined;
7017
+ x?: string | null | undefined;
7018
+ facebook?: string | null | undefined;
7019
+ youtube?: string | null | undefined;
7020
+ tiktok?: string | null | undefined;
7021
+ } | null | undefined;
7022
+ freeShippingThreshold: string | number | bigint | null | undefined;
7023
+ freeShippingThresholds: Record<string, string> | null | undefined;
7024
+ pageWidth: "default" | "full" | "narrow" | "wider" | "widest" | null | undefined;
7025
+ fontFamily: "default" | "roboto" | "poppins" | "inter" | "merriweather" | "montserrat" | "nunito" | "inconsolata" | "ibmPlexSans" | "cardo" | "spaceMono" | "buenard" | "titanOne" | "bartok" | "robotoSlab" | "playwritePl" | "jetBrainsMono" | null | undefined;
7026
+ fontFamilyHeadings: "default" | "roboto" | "poppins" | "inter" | "merriweather" | "montserrat" | "nunito" | "inconsolata" | "ibmPlexSans" | "cardo" | "spaceMono" | "buenard" | "titanOne" | "bartok" | "robotoSlab" | "playwritePl" | "jetBrainsMono" | null | undefined;
7027
+ fontSizes: {
7028
+ h2?: number | null | undefined;
7029
+ h3?: number | null | undefined;
7030
+ h4?: number | null | undefined;
7031
+ h5?: number | null | undefined;
7032
+ text?: number | null | undefined;
7033
+ } | null | undefined;
7034
+ logo: string | {
7035
+ imageUrl: string;
7036
+ width?: number | null | undefined;
7037
+ height?: number | null | undefined;
7038
+ } | null | undefined;
7039
+ ogimage: string | null | undefined;
7040
+ favicon: {
7041
+ imageUrl: string;
7042
+ width?: number | null | undefined;
7043
+ height?: number | null | undefined;
7044
+ } | null | undefined;
7045
+ colors: {
7046
+ paletteName?: string | null | undefined;
7047
+ palette?: {
7048
+ theme?: {
7049
+ background?: string | undefined;
7050
+ } | undefined;
7051
+ "theme-primary"?: {
7052
+ DEFAULT?: string | undefined;
7053
+ background?: string | undefined;
7054
+ } | undefined;
7055
+ "theme-button"?: {
7056
+ DEFAULT?: string | undefined;
7057
+ background?: string | undefined;
7058
+ } | undefined;
7059
+ } | undefined;
7060
+ } | null | undefined;
7061
+ buttons: {
7062
+ borderWidth?: number | null | undefined;
7063
+ borderRadius?: "none" | "sm" | "md" | "lg" | "full" | null | undefined;
7064
+ shadow?: "none" | "sm" | "md" | "lg" | null | undefined;
7065
+ colors?: {
7066
+ background?: string | null | undefined;
7067
+ text?: string | null | undefined;
7068
+ backgroundHover?: string | null | undefined;
7069
+ textHover?: string | null | undefined;
7070
+ border?: string | null | undefined;
7041
7071
  } | null | undefined;
7042
- freeShippingThreshold?: string | number | bigint | null | undefined;
7043
- pageWidth?: "default" | "full" | "narrow" | "wider" | "widest" | null | undefined;
7072
+ } | null | undefined;
7073
+ cartIcon: "shopping-bag" | "shopping-cart" | "shopping-basket" | null | undefined;
7074
+ checkoutAppearance: {
7075
+ summaryPosition?: "left" | "right" | null | undefined;
7076
+ summaryBackground?: "custom" | "tint" | "plain" | null | undefined;
7077
+ summaryBackgroundColor?: string | null | undefined;
7078
+ cornerRadius?: "small" | "none" | "medium" | "large" | null | undefined;
7079
+ payButtonLabel?: "pay" | "completeOrder" | "placeOrder" | null | undefined;
7080
+ showHeader?: boolean | null | undefined;
7081
+ showPolicyLinks?: boolean | null | undefined;
7082
+ hideExpressWallets?: boolean | null | undefined;
7044
7083
  fontFamily?: "default" | "roboto" | "poppins" | "inter" | "merriweather" | "montserrat" | "nunito" | "inconsolata" | "ibmPlexSans" | "cardo" | "spaceMono" | "buenard" | "titanOne" | "bartok" | "robotoSlab" | "playwritePl" | "jetBrainsMono" | null | undefined;
7045
- fontFamilyHeadings?: "default" | "roboto" | "poppins" | "inter" | "merriweather" | "montserrat" | "nunito" | "inconsolata" | "ibmPlexSans" | "cardo" | "spaceMono" | "buenard" | "titanOne" | "bartok" | "robotoSlab" | "playwritePl" | "jetBrainsMono" | null | undefined;
7046
- fontSizes?: {
7047
- h2?: number | null | undefined;
7048
- h3?: number | null | undefined;
7049
- h4?: number | null | undefined;
7050
- h5?: number | null | undefined;
7051
- text?: number | null | undefined;
7052
- } | null | undefined;
7053
- logo?: string | {
7054
- imageUrl: string;
7055
- width?: number | null | undefined;
7056
- height?: number | null | undefined;
7057
- } | null | undefined;
7058
- ogimage?: string | null | undefined;
7059
- favicon?: {
7060
- imageUrl: string;
7061
- width?: number | null | undefined;
7062
- height?: number | null | undefined;
7063
- } | null | undefined;
7064
7084
  colors?: {
7065
- paletteName?: string | null | undefined;
7066
- palette?: {
7067
- theme?: {
7068
- background?: string | undefined;
7069
- } | undefined;
7070
- "theme-primary"?: {
7071
- DEFAULT?: string | undefined;
7072
- background?: string | undefined;
7073
- } | undefined;
7074
- "theme-button"?: {
7075
- DEFAULT?: string | undefined;
7076
- background?: string | undefined;
7077
- } | undefined;
7078
- } | undefined;
7079
- } | null | undefined;
7080
- invoiceSettings?: {
7081
- template: string;
7082
- cadence: "monthly" | "yearly";
7083
- enabled?: boolean | null | undefined;
7084
- notes?: string | null | undefined;
7085
- } | null | undefined;
7086
- outboundEmail?: string | null | undefined;
7087
- notificationEmail?: string | null | undefined;
7088
- contactRoutingEmails?: Record<string, string> | null | undefined;
7089
- notifications?: {
7090
- newOrderNotifications: boolean | null;
7091
- lowStockNotifications: boolean | null;
7092
- trackingEmails: boolean | null;
7093
- } | null | undefined;
7094
- buttons?: {
7095
- borderWidth?: number | null | undefined;
7096
- borderRadius?: "none" | "sm" | "md" | "lg" | "full" | null | undefined;
7097
- shadow?: "none" | "sm" | "md" | "lg" | null | undefined;
7098
- colors?: {
7099
- background?: string | null | undefined;
7100
- text?: string | null | undefined;
7101
- backgroundHover?: string | null | undefined;
7102
- textHover?: string | null | undefined;
7103
- border?: string | null | undefined;
7104
- } | null | undefined;
7105
- } | null | undefined;
7106
- cartIcon?: "shopping-bag" | "shopping-cart" | "shopping-basket" | null | undefined;
7107
- checkoutAppearance?: {
7108
- summaryPosition?: "left" | "right" | null | undefined;
7109
- summaryBackground?: "custom" | "tint" | "plain" | null | undefined;
7110
- summaryBackgroundColor?: string | null | undefined;
7111
- cornerRadius?: "small" | "none" | "medium" | "large" | null | undefined;
7112
- payButtonLabel?: "pay" | "completeOrder" | "placeOrder" | null | undefined;
7113
- showHeader?: boolean | null | undefined;
7114
- showPolicyLinks?: boolean | null | undefined;
7115
- hideExpressWallets?: boolean | null | undefined;
7116
- fontFamily?: "default" | "roboto" | "poppins" | "inter" | "merriweather" | "montserrat" | "nunito" | "inconsolata" | "ibmPlexSans" | "cardo" | "spaceMono" | "buenard" | "titanOne" | "bartok" | "robotoSlab" | "playwritePl" | "jetBrainsMono" | null | undefined;
7117
- colors?: {
7118
- buttonBackground?: string | null | undefined;
7119
- buttonText?: string | null | undefined;
7120
- } | null | undefined;
7085
+ buttonBackground?: string | null | undefined;
7086
+ buttonText?: string | null | undefined;
7121
7087
  } | null | undefined;
7122
- productCards?: {
7123
- borderRadius?: "none" | "sm" | "md" | "lg" | "xl" | null | undefined;
7124
- } | null | undefined;
7125
- blogFilterConfig?: {
7126
- mode: "simple" | "faceted";
7127
- facets: {
7128
- id: string;
7129
- label: string;
7130
- type: "single" | "multiple";
7131
- options: {
7132
- value: string;
7133
- label: string;
7134
- }[];
7135
- }[];
7136
- } | null | undefined;
7137
- omnibus?: boolean | null | undefined;
7138
- detectedCountry?: string | null | undefined;
7139
- apiKeys?: {
7088
+ } | null | undefined;
7089
+ productCards: {
7090
+ borderRadius?: "none" | "sm" | "md" | "lg" | "xl" | null | undefined;
7091
+ } | null | undefined;
7092
+ blogFilterConfig: {
7093
+ mode: "simple" | "faceted";
7094
+ facets: {
7140
7095
  id: string;
7141
- apiKeyLookup: string;
7142
- apiKeyHash: string;
7143
- apiKeyDisplay: string;
7144
- createdAt: string;
7145
- name?: string | undefined;
7146
- system?: boolean | undefined;
7147
- }[] | null | undefined;
7148
- loyalty?: {
7149
- pointsPerUnit: number;
7150
- redemptionRate: number;
7151
- minRedemption: number;
7152
- maxRedeemPercent: number;
7153
- pointsExpiryMonths: number | null;
7154
- } | null | undefined;
7155
- bookings?: {
7156
- timezone: string;
7157
- defaultSlotDuration: number;
7158
- bufferTime: number;
7159
- advanceBookingDays: number;
7160
- cancellationHours: number;
7161
- autoConfirm: boolean;
7162
- requireApproval: boolean;
7163
- sendReminders: boolean;
7164
- reminderHours: number;
7165
- } | null | undefined;
7166
- subscriptions?: Record<string, never> | null | undefined;
7167
- dashboard?: {
7168
- widgets: {
7169
- id: string;
7170
- type: "revenue-summary" | "orders-summary" | "aov-summary" | "customers-summary" | "revenue-chart" | "order-status" | "customer-retention" | "top-products";
7171
- position: number;
7172
- size: {
7173
- width: 1 | 2 | 3 | 4;
7174
- height: 1 | 2 | 3 | 4;
7175
- };
7176
- visible: boolean;
7177
- settings?: Record<string, unknown> | undefined;
7096
+ label: string;
7097
+ type: "single" | "multiple";
7098
+ options: {
7099
+ value: string;
7100
+ label: string;
7178
7101
  }[];
7179
- } | null | undefined;
7180
- emailTracking?: {
7181
- trackClicks: boolean;
7182
- trackOpens: boolean;
7183
- } | null | undefined;
7184
- defaultLanguage?: "en-US" | "pl-PL" | "es-ES" | "de-DE" | null | undefined;
7185
- newsletterPopup?: {
7186
- delaySeconds: number;
7187
- heading?: string | undefined;
7188
- subheading?: string | undefined;
7189
- ctaText?: string | undefined;
7190
- teaserText?: string | undefined;
7191
- imageUrl?: string | undefined;
7192
- discountCode?: string | undefined;
7193
- } | null | undefined;
7194
- cartRecommendations?: {
7195
- layout: "inline" | "sidebar";
7196
- } | null | undefined;
7197
- stockHold?: {
7198
- enabled: boolean;
7199
- holdMinutes: number;
7200
- } | null | undefined;
7201
- aiInstructions?: string | null | undefined;
7202
- blogSettings?: {
7203
- modelTier: "extra" | "max" | "regular";
7204
- systemPrompt?: string | null | undefined;
7205
- } | null | undefined;
7206
- enabledCurrencies?: string[] | null | undefined;
7207
- freeShippingThresholds?: Record<string, string> | null | undefined;
7102
+ }[];
7208
7103
  } | null | undefined;
7209
- flags: {
7210
- verifyPKD?: boolean | null | undefined;
7211
- gold?: boolean | null | undefined;
7212
- showReferralBadge?: boolean | null | undefined;
7213
- } | undefined;
7214
- id: string;
7215
- name: string;
7216
- createdAt: string;
7217
- updatedAt: string;
7218
- organizationId: string | null;
7219
- addressId: string | null;
7220
- subdomain: string;
7221
- domain: string | null;
7222
- domainVerified: boolean;
7223
- emailDomain: string | null;
7224
- emailDomainId: string | null;
7225
- emailDomainVerified: boolean;
7226
- locale: string;
7227
- currency: string;
7228
- taxBehavior: "inclusive" | "exclusive";
7229
- clerkOrganizationId: string | null;
7230
- stripeAccountId: string | null;
7231
- stripeCustomerId: string | null;
7232
- environment: "live" | "test";
7233
- subscribed: boolean;
7234
- stripeSubscriptionId: string | null;
7235
- stripeSubscriptionName: "free_monthly" | "free_yearly" | "starter_monthly" | "starter_yearly" | "growth_monthly" | "growth_yearly" | "pro_monthly" | "pro_yearly" | null;
7236
- storeStatus: "active" | "suspended" | "maintenance";
7237
- legacyFreeGracePeriodEnd: string | null;
7238
- customTransactionFee: string | null;
7239
- lastAppliedStoreThemeId: string | null;
7240
- builderType: "aibuilder" | "storebuilder";
7241
- published: boolean;
7242
- builderConfig: {
7243
- method: "internal";
7244
- sandboxId: string;
7245
- sandboxUrl: string;
7246
- wsUrl?: string | undefined;
7247
- vercelProjectId: string;
7248
- gitHubDeployKey: string;
7249
- styles?: {
7250
- colorPalette: {
7251
- id: string;
7252
- name: string;
7253
- colors: {
7254
- background: string;
7255
- accent1: string;
7256
- accent2: string;
7257
- text: string;
7258
- };
7259
- };
7260
- typography: {
7261
- id: string;
7262
- name: string;
7263
- fontFamily: string;
7264
- };
7265
- corners: {
7266
- id: string;
7267
- name: string;
7268
- radius: string;
7269
- };
7270
- theme?: {
7271
- background: string;
7272
- foreground: string;
7273
- primary: string;
7274
- primaryForeground: string;
7275
- secondary: string;
7276
- secondaryForeground: string;
7277
- muted: string;
7278
- mutedForeground: string;
7279
- accent: string;
7280
- accentForeground: string;
7281
- border: string;
7282
- radius: string;
7283
- } | undefined;
7284
- } | undefined;
7285
- maxMode?: boolean | undefined;
7286
- template?: {
7287
- id: string;
7288
- name: string;
7289
- branch: string;
7290
- } | null | undefined;
7291
- activeDeployment?: {
7292
- id: string;
7293
- url: string;
7294
- createdAt: string;
7295
- } | null | undefined;
7296
- autoPublish?: boolean | undefined;
7297
- ynsApiKeyId?: string | undefined;
7298
- ynsApiKeyEncrypted?: string | undefined;
7104
+ omnibus: boolean | null | undefined;
7105
+ enabledTools: {
7106
+ blog: boolean;
7107
+ newsletter: boolean;
7108
+ loyalty: boolean;
7109
+ reviews: boolean;
7110
+ productSubscriptions: boolean;
7111
+ contactForm: boolean;
7112
+ wishlist: boolean;
7113
+ cookieConsent: boolean;
7114
+ auctions: boolean;
7115
+ surveys: boolean;
7116
+ bookings: boolean;
7117
+ productSets: boolean;
7118
+ restockNotifications: boolean;
7119
+ abandonedCarts: boolean;
7120
+ newsletterPopup: boolean;
7121
+ stripeTaxes: boolean;
7122
+ translations: boolean;
7123
+ cartRecommendations: boolean;
7124
+ withdrawalButton: boolean;
7125
+ events: boolean;
7299
7126
  } | null;
7300
- brandKit: {
7301
- kit?: {
7302
- name?: string | undefined;
7303
- tagline?: string | undefined;
7304
- mission?: string | undefined;
7305
- audience?: string | undefined;
7306
- colors?: {
7307
- name: string;
7308
- hex: string;
7309
- role?: "primary" | "secondary" | "accent" | "background" | "foreground" | "muted" | "border" | "other" | undefined;
7310
- notes?: string | undefined;
7311
- }[] | undefined;
7312
- typography?: {
7313
- headingFont?: string | undefined;
7314
- bodyFont?: string | undefined;
7315
- monoFont?: string | undefined;
7316
- fontUrls?: string[] | undefined;
7317
- scale?: "compact" | "normal" | "spacious" | undefined;
7318
- notes?: string | undefined;
7319
- } | undefined;
7320
- logos?: {
7321
- variant: "primary" | "wordmark" | "mark" | "light" | "dark" | "monochrome";
7322
- url: string;
7323
- background?: "any" | "light" | "dark" | undefined;
7324
- }[] | undefined;
7325
- voice?: {
7326
- tone?: string[] | undefined;
7327
- personality?: string | undefined;
7328
- dos?: string[] | undefined;
7329
- donts?: string[] | undefined;
7330
- vocabulary?: {
7331
- preferred?: string[] | undefined;
7332
- avoid?: string[] | undefined;
7333
- } | undefined;
7334
- } | undefined;
7335
- imagery?: {
7336
- style?: string | undefined;
7337
- subjects?: string[] | undefined;
7338
- avoid?: string[] | undefined;
7339
- referenceUrls?: string[] | undefined;
7340
- } | undefined;
7341
- borderRadius?: "none" | "sm" | "md" | "lg" | "full" | undefined;
7342
- links?: {
7343
- website?: string | undefined;
7344
- instagram?: string | undefined;
7345
- twitter?: string | undefined;
7346
- linkedin?: string | undefined;
7347
- } | undefined;
7348
- } | undefined;
7349
- guidelines?: string | undefined;
7350
- pdfUrl?: string | undefined;
7351
- updatedAt?: string | undefined;
7127
+ defaultLanguage: "en-US" | "pl-PL" | "es-ES" | "de-DE" | null | undefined;
7128
+ enabledLanguages: {
7129
+ "en-US": boolean;
7130
+ "pl-PL": boolean;
7131
+ "es-ES": boolean;
7132
+ "de-DE": boolean;
7352
7133
  } | null;
7353
- appSumoLicenseKey: string | null;
7354
- appSumoLicense: {
7355
- createdAt: string;
7356
- updatedAt: string;
7357
- userId: string | null;
7358
- licenseKey: string;
7359
- licenseStatus: "active" | "inactive";
7360
- tier: number | null;
7361
- extra: unknown;
7362
- } | null;
7363
- address: {
7364
- id: string;
7365
- name: string | null;
7366
- createdAt: string;
7367
- updatedAt: string;
7368
- type: "shipping" | "billing" | "merchant";
7369
- company: string | null;
7370
- city: string | null;
7371
- country: string | null;
7372
- line1: string | null;
7373
- line2: string | null;
7374
- postalCode: string | null;
7375
- state: string | null;
7376
- phone: string | null;
7377
- taxId: string | null;
7378
- } | null;
7379
- }>;
7134
+ enabledCurrencies: string[] | null | undefined;
7135
+ newsletterPopup: {
7136
+ delaySeconds: number;
7137
+ heading?: string | undefined;
7138
+ subheading?: string | undefined;
7139
+ ctaText?: string | undefined;
7140
+ teaserText?: string | undefined;
7141
+ imageUrl?: string | undefined;
7142
+ discountCode?: string | undefined;
7143
+ } | null | undefined;
7144
+ welcomeOffer: {
7145
+ enabled: boolean;
7146
+ mode: "shared" | "unique";
7147
+ discountType: "fixed" | "percentage";
7148
+ expiryDays: number;
7149
+ sharedCouponId?: string | null | undefined;
7150
+ sharedCouponCode?: string | null | undefined;
7151
+ uniquePrefix?: string | null | undefined;
7152
+ discountValue?: number | null | undefined;
7153
+ } | null | undefined;
7154
+ cartRecommendations: {
7155
+ layout: "inline" | "sidebar";
7156
+ } | null | undefined;
7157
+ } | null;
7158
+ };
7159
+ type APIMeGetResult = {
7160
+ store: APIMeStore;
7380
7161
  storeBaseUrl: string;
7381
7162
  publicUrl: string;
7382
7163
  };
@@ -7844,7 +7625,11 @@ type APISubscriberCreateResult = {
7844
7625
  unsubscribed: boolean;
7845
7626
  unsubscribedAt: string | null;
7846
7627
  unsubscribeToken: string | null;
7847
- } | undefined;
7628
+ } & {
7629
+ welcomeOffer: {
7630
+ status: "queued" | "off";
7631
+ };
7632
+ };
7848
7633
  type APISubscriberDeleteResult = {
7849
7634
  status: "unsubscribed";
7850
7635
  };
@@ -8834,4 +8619,4 @@ type APICartDeleteResult = {
8834
8619
  success: boolean;
8835
8620
  };
8836
8621
 
8837
- export type { APIBlogCategoriesBrowseQueryParams, APIBlogCategoriesBrowseResult, APIBlogCategoryCreateBody, APIBlogCategoryCreateResult, APIBlogCategoryDeleteResult, APIBlogCategoryGetByIdParams, APIBlogCategoryGetByIdResult, APIBlogCategoryUpdateBody, APIBlogCategoryUpdateResult, APIBrandAssignProductsBody, APIBrandAssignProductsResult, APIBrandCreateBody, APIBrandCreateResult, APIBrandDeleteResult, APIBrandGetByIdParams, APIBrandGetByIdResult, APIBrandUpdateBody, APIBrandUpdateResult, APIBrandsBrowseQueryParams, APIBrandsBrowseResult, APICartAddBody, APICartAddResult, APICartCreateBody, APICartCreateResult, APICartDeleteResult, APICartGetResult, APICartRemoveItemQueryParams, APICartRemoveItemResult, APICategoriesBrowseQueryParams, APICategoriesBrowseResult, APICategoryCreateBody, APICategoryCreateResult, APICategoryDeleteResult, APICategoryGetByIdParams, APICategoryGetByIdQueryParams, APICategoryGetByIdResult, APICategoryUpdateBody, APICategoryUpdateQueryParams, APICategoryUpdateResult, APICollectionCreateBody, APICollectionCreateResult, APICollectionDeleteResult, APICollectionGetByIdParams, APICollectionGetByIdQueryParams, APICollectionGetByIdResult, APICollectionUpdateBody, APICollectionUpdateResult, APICollectionsBrowseQueryParams, APICollectionsBrowseResult, APIContactMessageCreateBody, APIContactMessageCreateResult, APICouponCreateBody, APICouponCreateResult, APICouponDeleteResult, APICouponGetByIdParams, APICouponGetByIdResult, APICouponUpdateBody, APICouponUpdateResult, APICouponsBrowseQueryParams, APICouponsBrowseResult, APICustomerAddressCreateBody, APICustomerAddressCreateResult, APICustomerGetByIdParams, APICustomerGetByIdResult, APICustomerOrdersBrowseQueryParams, APICustomerOrdersBrowseResult, APICustomerUpdateBody, APICustomerUpdateResult, APICustomersBrowseQueryParams, APICustomersBrowseResult, APIEventAttendeesBrowseResult, APIEventCreateBody, APIEventCreateResult, APIEventGetByIdParams, APIEventGetByIdResult, APIEventUpdateBody, APIEventUpdateResult, APIEventsBrowseQueryParams, APIEventsBrowseResult, APIInstaviewImagesBrowseParams, APIInstaviewImagesBrowseQueryParams, APIInstaviewImagesBrowseResult, APIInventoryAdjustBody, APIInventoryAdjustResult, APIInventoryBrowseQueryParams, APIInventoryBrowseResult, APILegalPageCreateBody, APILegalPageCreateQueryParams, APILegalPageCreateResult, APILegalPageGetByPathParams, APILegalPageGetByPathQueryParams, APILegalPageGetByPathResult, APILegalPageUpdateBody, APILegalPageUpdateQueryParams, APILegalPageUpdateResult, APILegalPagesBrowseQueryParams, APILegalPagesBrowseResult, APIMeGetResult, APIOrderGetByIdParams, APIOrderGetByIdResult, APIOrderRefundGetParams, APIOrderRefundGetResult, APIOrderRefundsBrowseQueryParams, APIOrderRefundsBrowseResult, APIOrderRefundsParams, APIOrderUpdateBody, APIOrderUpdateResult, APIOrdersBrowseQueryParams, APIOrdersBrowseResult, APIPostCommentCreateBody, APIPostCommentCreateResult, APIPostCommentsBrowseQueryParams, APIPostCommentsBrowseResult, APIPostCreateBody, APIPostCreateResult, APIPostDeleteResult, APIPostGetByIdParams, APIPostGetByIdResult, APIPostUpdateBody, APIPostUpdateResult, APIPostsBrowseQueryParams, APIPostsBrowseResult, APIProductBatchBody, APIProductBatchResult, APIProductCreateBody, APIProductCreateResult, APIProductDeleteQueryParams, APIProductDeleteResult, APIProductFiltersResult, APIProductGetByIdParams, APIProductGetByIdQueryParams, APIProductGetByIdResult, APIProductReviewCreateBody, APIProductReviewCreateResult, APIProductReviewsBrowseQueryParams, APIProductReviewsBrowseResult, APIProductUpdateBody, APIProductUpdateQueryParams, APIProductUpdateResult, APIProductsBrowseQueryParams, APIProductsBrowseResult, APISearchQueryParams, APISearchResult, APISocialsGetResult, APISubscriberCreateBody, APISubscriberCreateResult, APISubscriberDeleteResult, APISupportCase, APISupportCaseCreateBody, APISupportCaseCreateResult, APISupportCaseGetParams, APISupportCaseGetResult, APISupportCaseMessage, APISupportCaseMessageCreateBody, APISupportCaseMessageCreateResult, APISupportCaseUpdateBody, APISupportCaseUpdateResult, APISupportCasesBrowseQueryParams, APISupportCasesBrowseResult, APITicketAttendeeGetParams, APITicketAttendeeGetResult, APITicketsGetParams, APITicketsGetQueryParams, APITicketsGetResult, APITicketsUpdateBody, APITicketsUpdateResult, APIVariantCreateBody, APIVariantCreateResult, APIVariantGetByIdParams, APIVariantGetByIdQueryParams, APIVariantGetByIdResult, APIVariantUpdateBody, APIVariantUpdateResult, JSONContent };
8622
+ export type { APIBlogCategoriesBrowseQueryParams, APIBlogCategoriesBrowseResult, APIBlogCategoryCreateBody, APIBlogCategoryCreateResult, APIBlogCategoryDeleteResult, APIBlogCategoryGetByIdParams, APIBlogCategoryGetByIdResult, APIBlogCategoryUpdateBody, APIBlogCategoryUpdateResult, APIBrandAssignProductsBody, APIBrandAssignProductsResult, APIBrandCreateBody, APIBrandCreateResult, APIBrandDeleteResult, APIBrandGetByIdParams, APIBrandGetByIdResult, APIBrandUpdateBody, APIBrandUpdateResult, APIBrandsBrowseQueryParams, APIBrandsBrowseResult, APICartAddBody, APICartAddResult, APICartCreateBody, APICartCreateResult, APICartDeleteResult, APICartGetResult, APICartRemoveItemQueryParams, APICartRemoveItemResult, APICategoriesBrowseQueryParams, APICategoriesBrowseResult, APICategoryCreateBody, APICategoryCreateResult, APICategoryDeleteResult, APICategoryGetByIdParams, APICategoryGetByIdQueryParams, APICategoryGetByIdResult, APICategoryUpdateBody, APICategoryUpdateQueryParams, APICategoryUpdateResult, APICollectionCreateBody, APICollectionCreateResult, APICollectionDeleteResult, APICollectionGetByIdParams, APICollectionGetByIdQueryParams, APICollectionGetByIdResult, APICollectionUpdateBody, APICollectionUpdateResult, APICollectionsBrowseQueryParams, APICollectionsBrowseResult, APIContactMessageCreateBody, APIContactMessageCreateResult, APICouponCreateBody, APICouponCreateResult, APICouponDeleteResult, APICouponGetByIdParams, APICouponGetByIdResult, APICouponUpdateBody, APICouponUpdateResult, APICouponsBrowseQueryParams, APICouponsBrowseResult, APICustomerAddressCreateBody, APICustomerAddressCreateResult, APICustomerGetByIdParams, APICustomerGetByIdResult, APICustomerOrdersBrowseQueryParams, APICustomerOrdersBrowseResult, APICustomerUpdateBody, APICustomerUpdateResult, APICustomersBrowseQueryParams, APICustomersBrowseResult, APIEventAttendeesBrowseResult, APIEventCreateBody, APIEventCreateResult, APIEventGetByIdParams, APIEventGetByIdResult, APIEventUpdateBody, APIEventUpdateResult, APIEventsBrowseQueryParams, APIEventsBrowseResult, APIInstaviewImagesBrowseParams, APIInstaviewImagesBrowseQueryParams, APIInstaviewImagesBrowseResult, APIInventoryAdjustBody, APIInventoryAdjustResult, APIInventoryBrowseQueryParams, APIInventoryBrowseResult, APILegalPageCreateBody, APILegalPageCreateQueryParams, APILegalPageCreateResult, APILegalPageGetByPathParams, APILegalPageGetByPathQueryParams, APILegalPageGetByPathResult, APILegalPageUpdateBody, APILegalPageUpdateQueryParams, APILegalPageUpdateResult, APILegalPagesBrowseQueryParams, APILegalPagesBrowseResult, APIMeGetResult, APIMeStore, APIOrderGetByIdParams, APIOrderGetByIdResult, APIOrderRefundGetParams, APIOrderRefundGetResult, APIOrderRefundsBrowseQueryParams, APIOrderRefundsBrowseResult, APIOrderRefundsParams, APIOrderUpdateBody, APIOrderUpdateResult, APIOrdersBrowseQueryParams, APIOrdersBrowseResult, APIPostCommentCreateBody, APIPostCommentCreateResult, APIPostCommentsBrowseQueryParams, APIPostCommentsBrowseResult, APIPostCreateBody, APIPostCreateResult, APIPostDeleteResult, APIPostGetByIdParams, APIPostGetByIdResult, APIPostUpdateBody, APIPostUpdateResult, APIPostsBrowseQueryParams, APIPostsBrowseResult, APIProductBatchBody, APIProductBatchResult, APIProductCreateBody, APIProductCreateResult, APIProductDeleteQueryParams, APIProductDeleteResult, APIProductFiltersResult, APIProductGetByIdParams, APIProductGetByIdQueryParams, APIProductGetByIdResult, APIProductReviewCreateBody, APIProductReviewCreateResult, APIProductReviewsBrowseQueryParams, APIProductReviewsBrowseResult, APIProductUpdateBody, APIProductUpdateQueryParams, APIProductUpdateResult, APIProductsBrowseQueryParams, APIProductsBrowseResult, APISearchQueryParams, APISearchResult, APISocialsGetResult, APISubscriberCreateBody, APISubscriberCreateResult, APISubscriberDeleteResult, APISupportCase, APISupportCaseCreateBody, APISupportCaseCreateResult, APISupportCaseGetParams, APISupportCaseGetResult, APISupportCaseMessage, APISupportCaseMessageCreateBody, APISupportCaseMessageCreateResult, APISupportCaseUpdateBody, APISupportCaseUpdateResult, APISupportCasesBrowseQueryParams, APISupportCasesBrowseResult, APITicketAttendeeGetParams, APITicketAttendeeGetResult, APITicketsGetParams, APITicketsGetQueryParams, APITicketsGetResult, APITicketsUpdateBody, APITicketsUpdateResult, APIVariantCreateBody, APIVariantCreateResult, APIVariantGetByIdParams, APIVariantGetByIdQueryParams, APIVariantGetByIdResult, APIVariantUpdateBody, APIVariantUpdateResult, JSONContent };
package/dist/index.d.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  import { APIMeGetResult, APISocialsGetResult, APIBrandsBrowseQueryParams, APIBrandsBrowseResult, APIBrandGetByIdParams, APIBrandGetByIdResult, APIBrandCreateBody, APIBrandCreateResult, APIBrandUpdateBody, APIBrandUpdateResult, APIBrandDeleteResult, APIBrandAssignProductsBody, APIBrandAssignProductsResult, APIOrderRefundsParams, APIOrderRefundsBrowseQueryParams, APIOrderRefundsBrowseResult, APIOrderRefundGetParams, APIOrderRefundGetResult, APIProductBatchBody, APIProductBatchResult, APICartDeleteResult, APIProductsBrowseQueryParams, APIProductsBrowseResult, APIProductFiltersResult, APIProductGetByIdParams, APIProductGetByIdResult, APIOrdersBrowseQueryParams, APIOrdersBrowseResult, APIOrderGetByIdParams, APIOrderGetByIdResult, APICartCreateBody, APICartCreateResult, APICartGetResult, APICouponsBrowseQueryParams, APICouponsBrowseResult, APICouponGetByIdParams, APICouponGetByIdResult, APICouponCreateBody, APICouponCreateResult, APICouponUpdateBody, APICouponUpdateResult, APICouponDeleteResult, APISupportCasesBrowseQueryParams, APISupportCasesBrowseResult, APISupportCaseGetParams, APISupportCaseGetResult, APISupportCaseCreateBody, APISupportCaseCreateResult, APISupportCaseUpdateBody, APISupportCaseUpdateResult, APISupportCaseMessageCreateBody, APISupportCaseMessageCreateResult, APICollectionGetByIdParams, APICollectionGetByIdResult, APICollectionsBrowseQueryParams, APICollectionsBrowseResult, APICollectionCreateBody, APICollectionCreateResult, APICollectionUpdateBody, APICollectionUpdateResult, APICollectionDeleteResult, APICategoryGetByIdParams, APICategoryGetByIdResult, APICategoriesBrowseQueryParams, APICategoriesBrowseResult, APIPostsBrowseQueryParams, APIPostsBrowseResult, APIPostGetByIdParams, APIPostGetByIdResult, APIPostCreateBody, APIPostCreateResult, APIPostUpdateBody, APIPostUpdateResult, APIPostDeleteResult, APIPostCommentsBrowseQueryParams, APIPostCommentsBrowseResult, APIPostCommentCreateBody, APIPostCommentCreateResult, APIBlogCategoriesBrowseQueryParams, APIBlogCategoriesBrowseResult, APIBlogCategoryGetByIdParams, APIBlogCategoryGetByIdResult, APIBlogCategoryCreateBody, APIBlogCategoryCreateResult, APIBlogCategoryUpdateBody, APIBlogCategoryUpdateResult, APIBlogCategoryDeleteResult, APICustomersBrowseQueryParams, APICustomersBrowseResult, APICustomerGetByIdParams, APICustomerGetByIdResult, APICustomerUpdateBody, APICustomerUpdateResult, APICustomerAddressCreateBody, APICustomerAddressCreateResult, APICustomerOrdersBrowseQueryParams, APICustomerOrdersBrowseResult, APIInventoryBrowseQueryParams, APIInventoryBrowseResult, APIInventoryAdjustBody, APIInventoryAdjustResult, APIVariantGetByIdParams, APIVariantGetByIdResult, APIVariantUpdateBody, APIVariantUpdateResult, APIVariantCreateBody, APIVariantCreateResult, APISubscriberCreateBody, APISubscriberCreateResult, APISubscriberDeleteResult, APIContactMessageCreateBody, APIContactMessageCreateResult, APIProductCreateBody, APIProductCreateResult, APIProductUpdateBody, APIProductUpdateResult, APIProductDeleteResult, APIProductReviewsBrowseQueryParams, APIProductReviewsBrowseResult, APIProductReviewCreateBody, APIProductReviewCreateResult, APIEventsBrowseQueryParams, APIEventsBrowseResult, APIEventGetByIdParams, APIEventGetByIdResult, APIEventCreateBody, APIEventCreateResult, APIEventUpdateBody, APIEventUpdateResult, APIEventAttendeesBrowseResult, APITicketsGetResult, APITicketsUpdateBody, APITicketsUpdateResult, APITicketAttendeeGetResult, APICategoryCreateBody, APICategoryCreateResult, APICategoryUpdateBody, APICategoryUpdateResult, APICategoryDeleteResult, APIOrderUpdateBody, APIOrderUpdateResult, APILegalPagesBrowseQueryParams, APILegalPagesBrowseResult, APILegalPageGetByPathQueryParams, APILegalPageGetByPathResult, APILegalPageCreateBody, APILegalPageCreateQueryParams, APILegalPageCreateResult, APILegalPageUpdateBody, APILegalPageUpdateQueryParams, APILegalPageUpdateResult, APISearchQueryParams, APISearchResult, APIInstaviewImagesBrowseParams, APIInstaviewImagesBrowseQueryParams, APIInstaviewImagesBrowseResult } from './api-types.js';
2
- export { APICartAddBody, APICartAddResult, APICartRemoveItemQueryParams, APICartRemoveItemResult, APICategoryGetByIdQueryParams, APICategoryUpdateQueryParams, APICollectionGetByIdQueryParams, APILegalPageGetByPathParams, APIProductDeleteQueryParams, APIProductGetByIdQueryParams, APIProductUpdateQueryParams, APISupportCase, APISupportCaseMessage, APITicketAttendeeGetParams, APITicketsGetParams, APITicketsGetQueryParams, APIVariantGetByIdQueryParams, JSONContent } from './api-types.js';
2
+ export { APICartAddBody, APICartAddResult, APICartRemoveItemQueryParams, APICartRemoveItemResult, APICategoryGetByIdQueryParams, APICategoryUpdateQueryParams, APICollectionGetByIdQueryParams, APILegalPageGetByPathParams, APIMeStore, APIProductDeleteQueryParams, APIProductGetByIdQueryParams, APIProductUpdateQueryParams, APISupportCase, APISupportCaseMessage, APITicketAttendeeGetParams, APITicketsGetParams, APITicketsGetQueryParams, APIVariantGetByIdQueryParams, JSONContent } from './api-types.js';
3
3
 
4
4
  interface CommerceConfig {
5
5
  /** API key. Defaults to process.env.YNS_API_KEY */
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "$schema": "https://json.schemastore.org/package",
3
3
  "name": "commerce-kit",
4
- "version": "0.54.0",
4
+ "version": "0.55.0",
5
5
  "type": "module",
6
6
  "license": "AGPL-3.0-only",
7
7
  "keywords": [