@paynow-gg/typescript-sdk 1.0.44 → 1.0.46

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.
@@ -1678,6 +1678,30 @@ export interface paths {
1678
1678
  patch?: never;
1679
1679
  trace?: never;
1680
1680
  };
1681
+ "/v1/stores/{storeId}/upsell-settings": {
1682
+ parameters: {
1683
+ query?: never;
1684
+ header?: never;
1685
+ path?: never;
1686
+ cookie?: never;
1687
+ };
1688
+ /**
1689
+ * Get store upselling settings
1690
+ * @description Retrieves upselling settings for the store.
1691
+ */
1692
+ get: operations["UpsellSettings_GetStoreUpsellSettings"];
1693
+ put?: never;
1694
+ post?: never;
1695
+ delete?: never;
1696
+ options?: never;
1697
+ head?: never;
1698
+ /**
1699
+ * Updates store upselling settings
1700
+ * @description Updates upselling settings for a store.
1701
+ */
1702
+ patch: operations["UpsellSettings_UpdateStoreUpsellSettings"];
1703
+ trace?: never;
1704
+ };
1681
1705
  "/v1/stores/{storeId}/webhooks": {
1682
1706
  parameters: {
1683
1707
  query?: never;
@@ -2360,6 +2384,13 @@ export interface components {
2360
2384
  adaptive_currency_enabled: boolean;
2361
2385
  show_adaptive_currency_on_storefront: boolean;
2362
2386
  };
2387
+ CreateStoreUpsellSettingsDto: {
2388
+ enabled: boolean;
2389
+ automatic_recommendations_enabled: boolean;
2390
+ recommendation_overrides_enabled: boolean;
2391
+ recommendation_overrides: components["schemas"]["StoreUpsellRecommendationDto"][];
2392
+ checkout_style: components["schemas"]["StoreUpsellCheckoutStyleDto"];
2393
+ };
2363
2394
  CreateTrialEligibilityOverrideDto: {
2364
2395
  product_id: components["schemas"]["FlakeId"];
2365
2396
  /** Format: date-time */
@@ -2980,6 +3011,7 @@ export interface components {
2980
3011
  subscription_interval_value?: null | number;
2981
3012
  subscription_interval_scale?: components["schemas"]["ProductSubscriptionIntervalScale"];
2982
3013
  trial?: components["schemas"]["UpsertProductTrialConfigurationDto"];
3014
+ upselling?: components["schemas"]["UpsertProductUpsellConfigurationDto"];
2983
3015
  /** @description Indicates whether automatic removal is enabled. */
2984
3016
  remove_after_enabled?: null | boolean;
2985
3017
  /**
@@ -4082,6 +4114,7 @@ export interface components {
4082
4114
  subscription_interval_value: number;
4083
4115
  subscription_interval_scale: components["schemas"]["ProductSubscriptionIntervalScale"];
4084
4116
  trial: components["schemas"]["ProductTrialConfigurationDto"];
4117
+ upselling: components["schemas"]["ProductUpsellConfigurationDto"];
4085
4118
  /** @description Indicates whether automatic removal is enabled. */
4086
4119
  remove_after_enabled: boolean;
4087
4120
  /**
@@ -4292,6 +4325,27 @@ export interface components {
4292
4325
  repeat_trial_cooldown_value: number;
4293
4326
  repeat_trial_cooldown_scale: components["schemas"]["ProductSubscriptionIntervalScale"];
4294
4327
  };
4328
+ ProductUpsellConfigurationDto: {
4329
+ /** @description Indicates if upselling should be enabled for the product.
4330
+ * If disabled, the product will never be recommended regardless of the global config. */
4331
+ enabled: boolean;
4332
+ /** @description Upselling recommendation for the product. */
4333
+ recommendations: components["schemas"]["ProductUpsellRecommendationDto"][];
4334
+ };
4335
+ ProductUpsellRecommendationDto: {
4336
+ recommended_product_id: components["schemas"]["FlakeId"];
4337
+ type: components["schemas"]["UpsellTypeDto"];
4338
+ discount_type: components["schemas"]["UpsellDiscountTypeDto"];
4339
+ /** Format: int64 */
4340
+ discount_amount: number;
4341
+ /** Format: int32 */
4342
+ minimum_base_product_quantity?: null | number;
4343
+ /** Format: int32 */
4344
+ minimum_recommended_product_quantity?: null | number;
4345
+ /** Format: int32 */
4346
+ quantity_to_add?: null | number;
4347
+ prefer_as_subscription: boolean;
4348
+ };
4295
4349
  /** @description Represents a command associated with the store-level purchase follow uo configuration. */
4296
4350
  PurchaseFollowUpStoreConfigurationCommandDto: {
4297
4351
  id: components["schemas"]["FlakeId"];
@@ -4962,6 +5016,30 @@ export interface components {
4962
5016
  /** @description Reason provided for cancellation. */
4963
5017
  cancel_reason?: null | string;
4964
5018
  };
5019
+ /** @enum {string} */
5020
+ StoreUpsellCheckoutStyleDto: "unknown" | "inline" | "inline_and_prepayment_dialog" | "dedicated_step";
5021
+ StoreUpsellRecommendationDto: {
5022
+ recommended_product_id: components["schemas"]["FlakeId"];
5023
+ type: components["schemas"]["UpsellTypeDto"];
5024
+ discount_type: components["schemas"]["UpsellDiscountTypeDto"];
5025
+ /** Format: int64 */
5026
+ discount_amount: number;
5027
+ /** Format: int32 */
5028
+ minimum_base_product_quantity?: null | number;
5029
+ /** Format: int32 */
5030
+ quantity_to_add?: null | number;
5031
+ prefer_as_subscription: boolean;
5032
+ };
5033
+ StoreUpsellSettingsDto: {
5034
+ enabled: boolean;
5035
+ automatic_recommendations_enabled: boolean;
5036
+ recommendation_overrides_enabled: boolean;
5037
+ recommendation_overrides: components["schemas"]["StoreUpsellRecommendationDto"][];
5038
+ checkout_style: components["schemas"]["StoreUpsellCheckoutStyleDto"];
5039
+ /** Format: date-time */
5040
+ updated_at: string;
5041
+ updated_by: components["schemas"]["ActorDto"];
5042
+ };
4965
5043
  /**
4966
5044
  * @description Represents the current state of a subscription.
4967
5045
  * @enum {string}
@@ -5290,6 +5368,13 @@ export interface components {
5290
5368
  adaptive_currency_enabled?: boolean;
5291
5369
  show_adaptive_currency_on_storefront?: boolean;
5292
5370
  };
5371
+ UpdateStoreUpsellSettingsDto: {
5372
+ enabled?: boolean;
5373
+ automatic_recommendations_enabled?: boolean;
5374
+ recommendation_overrides_enabled?: boolean;
5375
+ recommendation_overrides?: components["schemas"]["StoreUpsellRecommendationDto"][];
5376
+ checkout_style?: components["schemas"]["StoreUpsellCheckoutStyleDto"];
5377
+ };
5293
5378
  UpdateTrialEligibilityOverrideDto: {
5294
5379
  product_id?: components["schemas"]["FlakeId"];
5295
5380
  /** Format: date-time */
@@ -5304,6 +5389,10 @@ export interface components {
5304
5389
  discord_title?: null | string;
5305
5390
  discord_color?: null | string;
5306
5391
  };
5392
+ /** @enum {string} */
5393
+ UpsellDiscountTypeDto: "unknown" | "none" | "fixed" | "percentage";
5394
+ /** @enum {string} */
5395
+ UpsellTypeDto: "unknown" | "additional" | "alternative" | "increase_quantity";
5307
5396
  UpsertBanRequestDto: {
5308
5397
  reason?: null | string;
5309
5398
  identities?: null | components["schemas"]["BanIdentityDto"][];
@@ -5382,6 +5471,7 @@ export interface components {
5382
5471
  subscription_interval_value?: null | number;
5383
5472
  subscription_interval_scale?: components["schemas"]["ProductSubscriptionIntervalScale"];
5384
5473
  trial?: components["schemas"]["UpsertProductTrialConfigurationDto"];
5474
+ upselling?: components["schemas"]["UpsertProductUpsellConfigurationDto"];
5385
5475
  /** @description Indicates whether automatic removal is enabled. */
5386
5476
  remove_after_enabled?: null | boolean;
5387
5477
  /**
@@ -5473,6 +5563,24 @@ export interface components {
5473
5563
  repeat_trial_cooldown_value?: null | number;
5474
5564
  repeat_trial_cooldown_scale?: components["schemas"]["ProductSubscriptionIntervalScale"];
5475
5565
  };
5566
+ UpsertProductUpsellConfigurationDto: {
5567
+ enabled?: null | boolean;
5568
+ recommendations?: null | components["schemas"]["UpsertProductUpsellRecommendationDto"][];
5569
+ };
5570
+ UpsertProductUpsellRecommendationDto: {
5571
+ recommended_product_id: components["schemas"]["FlakeId"];
5572
+ type: components["schemas"]["UpsellTypeDto"];
5573
+ discount_type: components["schemas"]["UpsellDiscountTypeDto"];
5574
+ /** Format: int64 */
5575
+ discount_amount: number;
5576
+ /** Format: int32 */
5577
+ minimum_base_product_quantity?: null | number;
5578
+ /** Format: int32 */
5579
+ minimum_recommended_product_quantity?: null | number;
5580
+ /** Format: int32 */
5581
+ quantity_to_add?: null | number;
5582
+ prefer_as_subscription: boolean;
5583
+ };
5476
5584
  UpsertTagRequestDto: {
5477
5585
  name?: null | string;
5478
5586
  slug?: null | string;
@@ -10059,6 +10167,68 @@ export interface operations {
10059
10167
  };
10060
10168
  };
10061
10169
  };
10170
+ UpsellSettings_GetStoreUpsellSettings: {
10171
+ parameters: {
10172
+ query?: never;
10173
+ header?: never;
10174
+ path?: never;
10175
+ cookie?: never;
10176
+ };
10177
+ requestBody?: never;
10178
+ responses: {
10179
+ /** @description OK */
10180
+ 200: {
10181
+ headers: {
10182
+ [name: string]: unknown;
10183
+ };
10184
+ content: {
10185
+ "application/json": components["schemas"]["StoreUpsellSettingsDto"];
10186
+ };
10187
+ };
10188
+ /** @description Error response */
10189
+ default: {
10190
+ headers: {
10191
+ [name: string]: unknown;
10192
+ };
10193
+ content: {
10194
+ "application/json": components["schemas"]["PayNowError"];
10195
+ };
10196
+ };
10197
+ };
10198
+ };
10199
+ UpsellSettings_UpdateStoreUpsellSettings: {
10200
+ parameters: {
10201
+ query?: never;
10202
+ header?: never;
10203
+ path?: never;
10204
+ cookie?: never;
10205
+ };
10206
+ requestBody?: {
10207
+ content: {
10208
+ "application/json": components["schemas"]["UpdateStoreUpsellSettingsDto"];
10209
+ "text/json": components["schemas"]["UpdateStoreUpsellSettingsDto"];
10210
+ "application/*+json": components["schemas"]["UpdateStoreUpsellSettingsDto"];
10211
+ };
10212
+ };
10213
+ responses: {
10214
+ /** @description No Content */
10215
+ 204: {
10216
+ headers: {
10217
+ [name: string]: unknown;
10218
+ };
10219
+ content?: never;
10220
+ };
10221
+ /** @description Error response */
10222
+ default: {
10223
+ headers: {
10224
+ [name: string]: unknown;
10225
+ };
10226
+ content: {
10227
+ "application/json": components["schemas"]["PayNowError"];
10228
+ };
10229
+ };
10230
+ };
10231
+ };
10062
10232
  Webhooks_GetSubscriptions: {
10063
10233
  parameters: {
10064
10234
  query?: never;
@@ -10803,6 +10973,14 @@ export declare const operationMappings: {
10803
10973
  readonly method: "DELETE";
10804
10974
  readonly path: "/v1/stores/{storeId}/customers/{customerId}/trials/eligibility/overrides/{trialEligibilityOverrideId}";
10805
10975
  };
10976
+ readonly UpsellSettings_GetStoreUpsellSettings: {
10977
+ readonly method: "GET";
10978
+ readonly path: "/v1/stores/{storeId}/upsell-settings";
10979
+ };
10980
+ readonly UpsellSettings_UpdateStoreUpsellSettings: {
10981
+ readonly method: "PATCH";
10982
+ readonly path: "/v1/stores/{storeId}/upsell-settings";
10983
+ };
10806
10984
  readonly Webhooks_GetSubscriptions: {
10807
10985
  readonly method: "GET";
10808
10986
  readonly path: "/v1/stores/{storeId}/webhooks";