@wix/stores 1.0.134 → 1.0.136

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 (235) hide show
  1. package/build/cjs/context.d.ts +5 -5
  2. package/build/cjs/context.js +5 -5
  3. package/build/cjs/context.js.map +1 -1
  4. package/build/cjs/index.d.ts +5 -6
  5. package/build/cjs/index.js +6 -7
  6. package/build/cjs/index.js.map +1 -1
  7. package/build/cjs/meta.d.ts +5 -6
  8. package/build/cjs/meta.js +6 -7
  9. package/build/cjs/meta.js.map +1 -1
  10. package/build/es/context.d.ts +5 -5
  11. package/build/es/context.js +5 -5
  12. package/build/es/context.js.map +1 -1
  13. package/build/es/index.d.ts +5 -6
  14. package/build/es/index.js +5 -6
  15. package/build/es/index.js.map +1 -1
  16. package/build/es/meta.d.ts +5 -6
  17. package/build/es/meta.js +5 -6
  18. package/build/es/meta.js.map +1 -1
  19. package/package.json +15 -9
  20. package/build/cjs/index.typings.d.ts +0 -6
  21. package/build/cjs/index.typings.js +0 -33
  22. package/build/cjs/index.typings.js.map +0 -1
  23. package/build/cjs/src/platform-v1-wishlist.context.d.ts +0 -3
  24. package/build/cjs/src/platform-v1-wishlist.context.js +0 -22
  25. package/build/cjs/src/platform-v1-wishlist.context.js.map +0 -1
  26. package/build/cjs/src/platform-v1-wishlist.http.d.ts +0 -3
  27. package/build/cjs/src/platform-v1-wishlist.http.js +0 -91
  28. package/build/cjs/src/platform-v1-wishlist.http.js.map +0 -1
  29. package/build/cjs/src/platform-v1-wishlist.meta.d.ts +0 -13
  30. package/build/cjs/src/platform-v1-wishlist.meta.js +0 -47
  31. package/build/cjs/src/platform-v1-wishlist.meta.js.map +0 -1
  32. package/build/cjs/src/platform-v1-wishlist.public.d.ts +0 -15
  33. package/build/cjs/src/platform-v1-wishlist.public.js +0 -12
  34. package/build/cjs/src/platform-v1-wishlist.public.js.map +0 -1
  35. package/build/cjs/src/platform-v1-wishlist.types.d.ts +0 -104
  36. package/build/cjs/src/platform-v1-wishlist.types.js +0 -3
  37. package/build/cjs/src/platform-v1-wishlist.types.js.map +0 -1
  38. package/build/cjs/src/platform-v1-wishlist.universal.d.ts +0 -121
  39. package/build/cjs/src/platform-v1-wishlist.universal.js +0 -106
  40. package/build/cjs/src/platform-v1-wishlist.universal.js.map +0 -1
  41. package/build/cjs/src/stores-catalog-v1-collection.context.d.ts +0 -5
  42. package/build/cjs/src/stores-catalog-v1-collection.context.js +0 -56
  43. package/build/cjs/src/stores-catalog-v1-collection.context.js.map +0 -1
  44. package/build/cjs/src/stores-catalog-v1-collection.http.d.ts +0 -10
  45. package/build/cjs/src/stores-catalog-v1-collection.http.js +0 -110
  46. package/build/cjs/src/stores-catalog-v1-collection.http.js.map +0 -1
  47. package/build/cjs/src/stores-catalog-v1-collection.meta.d.ts +0 -19
  48. package/build/cjs/src/stores-catalog-v1-collection.meta.js +0 -85
  49. package/build/cjs/src/stores-catalog-v1-collection.meta.js.map +0 -1
  50. package/build/cjs/src/stores-catalog-v1-collection.public.d.ts +0 -59
  51. package/build/cjs/src/stores-catalog-v1-collection.public.js +0 -27
  52. package/build/cjs/src/stores-catalog-v1-collection.public.js.map +0 -1
  53. package/build/cjs/src/stores-catalog-v1-collection.types.d.ts +0 -414
  54. package/build/cjs/src/stores-catalog-v1-collection.types.js +0 -18
  55. package/build/cjs/src/stores-catalog-v1-collection.types.js.map +0 -1
  56. package/build/cjs/src/stores-catalog-v1-collection.universal.d.ts +0 -452
  57. package/build/cjs/src/stores-catalog-v1-collection.universal.js +0 -225
  58. package/build/cjs/src/stores-catalog-v1-collection.universal.js.map +0 -1
  59. package/build/cjs/src/stores-catalog-v1-product.context.d.ts +0 -35
  60. package/build/cjs/src/stores-catalog-v1-product.context.js +0 -566
  61. package/build/cjs/src/stores-catalog-v1-product.context.js.map +0 -1
  62. package/build/cjs/src/stores-catalog-v1-product.http.d.ts +0 -89
  63. package/build/cjs/src/stores-catalog-v1-product.http.js +0 -1716
  64. package/build/cjs/src/stores-catalog-v1-product.http.js.map +0 -1
  65. package/build/cjs/src/stores-catalog-v1-product.meta.d.ts +0 -95
  66. package/build/cjs/src/stores-catalog-v1-product.meta.js +0 -655
  67. package/build/cjs/src/stores-catalog-v1-product.meta.js.map +0 -1
  68. package/build/cjs/src/stores-catalog-v1-product.public.d.ts +0 -1216
  69. package/build/cjs/src/stores-catalog-v1-product.public.js +0 -221
  70. package/build/cjs/src/stores-catalog-v1-product.public.js.map +0 -1
  71. package/build/cjs/src/stores-catalog-v1-product.types.d.ts +0 -4235
  72. package/build/cjs/src/stores-catalog-v1-product.types.js +0 -78
  73. package/build/cjs/src/stores-catalog-v1-product.types.js.map +0 -1
  74. package/build/cjs/src/stores-catalog-v1-product.universal.d.ts +0 -5074
  75. package/build/cjs/src/stores-catalog-v1-product.universal.js +0 -2220
  76. package/build/cjs/src/stores-catalog-v1-product.universal.js.map +0 -1
  77. package/build/cjs/src/stores-v1-abandoned-cart.http.d.ts +0 -6
  78. package/build/cjs/src/stores-v1-abandoned-cart.http.js +0 -103
  79. package/build/cjs/src/stores-v1-abandoned-cart.http.js.map +0 -1
  80. package/build/cjs/src/stores-v1-abandoned-cart.meta.d.ts +0 -16
  81. package/build/cjs/src/stores-v1-abandoned-cart.meta.js +0 -66
  82. package/build/cjs/src/stores-v1-abandoned-cart.meta.js.map +0 -1
  83. package/build/cjs/src/stores-v1-abandoned-cart.public.d.ts +0 -19
  84. package/build/cjs/src/stores-v1-abandoned-cart.public.js +0 -22
  85. package/build/cjs/src/stores-v1-abandoned-cart.public.js.map +0 -1
  86. package/build/cjs/src/stores-v1-abandoned-cart.types.d.ts +0 -216
  87. package/build/cjs/src/stores-v1-abandoned-cart.types.js +0 -30
  88. package/build/cjs/src/stores-v1-abandoned-cart.types.js.map +0 -1
  89. package/build/cjs/src/stores-v1-abandoned-cart.universal.d.ts +0 -246
  90. package/build/cjs/src/stores-v1-abandoned-cart.universal.js +0 -189
  91. package/build/cjs/src/stores-v1-abandoned-cart.universal.js.map +0 -1
  92. package/build/cjs/src/stores-v1-subscription-option.context.d.ts +0 -14
  93. package/build/cjs/src/stores-v1-subscription-option.context.js +0 -209
  94. package/build/cjs/src/stores-v1-subscription-option.context.js.map +0 -1
  95. package/build/cjs/src/stores-v1-subscription-option.http.d.ts +0 -128
  96. package/build/cjs/src/stores-v1-subscription-option.http.js +0 -466
  97. package/build/cjs/src/stores-v1-subscription-option.http.js.map +0 -1
  98. package/build/cjs/src/stores-v1-subscription-option.meta.d.ts +0 -40
  99. package/build/cjs/src/stores-v1-subscription-option.meta.js +0 -258
  100. package/build/cjs/src/stores-v1-subscription-option.meta.js.map +0 -1
  101. package/build/cjs/src/stores-v1-subscription-option.public.d.ts +0 -46
  102. package/build/cjs/src/stores-v1-subscription-option.public.js +0 -81
  103. package/build/cjs/src/stores-v1-subscription-option.public.js.map +0 -1
  104. package/build/cjs/src/stores-v1-subscription-option.types.d.ts +0 -351
  105. package/build/cjs/src/stores-v1-subscription-option.types.js +0 -20
  106. package/build/cjs/src/stores-v1-subscription-option.types.js.map +0 -1
  107. package/build/cjs/src/stores-v1-subscription-option.universal.d.ts +0 -646
  108. package/build/cjs/src/stores-v1-subscription-option.universal.js +0 -893
  109. package/build/cjs/src/stores-v1-subscription-option.universal.js.map +0 -1
  110. package/build/cjs/src/stores-v2-inventory.context.d.ts +0 -7
  111. package/build/cjs/src/stores-v2-inventory.context.js +0 -90
  112. package/build/cjs/src/stores-v2-inventory.context.js.map +0 -1
  113. package/build/cjs/src/stores-v2-inventory.http.d.ts +0 -31
  114. package/build/cjs/src/stores-v2-inventory.http.js +0 -289
  115. package/build/cjs/src/stores-v2-inventory.http.js.map +0 -1
  116. package/build/cjs/src/stores-v2-inventory.meta.d.ts +0 -21
  117. package/build/cjs/src/stores-v2-inventory.meta.js +0 -125
  118. package/build/cjs/src/stores-v2-inventory.meta.js.map +0 -1
  119. package/build/cjs/src/stores-v2-inventory.public.d.ts +0 -13
  120. package/build/cjs/src/stores-v2-inventory.public.js +0 -41
  121. package/build/cjs/src/stores-v2-inventory.public.js.map +0 -1
  122. package/build/cjs/src/stores-v2-inventory.types.d.ts +0 -283
  123. package/build/cjs/src/stores-v2-inventory.types.js +0 -11
  124. package/build/cjs/src/stores-v2-inventory.types.js.map +0 -1
  125. package/build/cjs/src/stores-v2-inventory.universal.d.ts +0 -425
  126. package/build/cjs/src/stores-v2-inventory.universal.js +0 -382
  127. package/build/cjs/src/stores-v2-inventory.universal.js.map +0 -1
  128. package/build/es/index.typings.d.ts +0 -6
  129. package/build/es/index.typings.js +0 -7
  130. package/build/es/index.typings.js.map +0 -1
  131. package/build/es/src/platform-v1-wishlist.context.d.ts +0 -3
  132. package/build/es/src/platform-v1-wishlist.context.js +0 -18
  133. package/build/es/src/platform-v1-wishlist.context.js.map +0 -1
  134. package/build/es/src/platform-v1-wishlist.http.d.ts +0 -3
  135. package/build/es/src/platform-v1-wishlist.http.js +0 -87
  136. package/build/es/src/platform-v1-wishlist.http.js.map +0 -1
  137. package/build/es/src/platform-v1-wishlist.meta.d.ts +0 -13
  138. package/build/es/src/platform-v1-wishlist.meta.js +0 -20
  139. package/build/es/src/platform-v1-wishlist.meta.js.map +0 -1
  140. package/build/es/src/platform-v1-wishlist.public.d.ts +0 -15
  141. package/build/es/src/platform-v1-wishlist.public.js +0 -8
  142. package/build/es/src/platform-v1-wishlist.public.js.map +0 -1
  143. package/build/es/src/platform-v1-wishlist.types.d.ts +0 -104
  144. package/build/es/src/platform-v1-wishlist.types.js +0 -2
  145. package/build/es/src/platform-v1-wishlist.types.js.map +0 -1
  146. package/build/es/src/platform-v1-wishlist.universal.d.ts +0 -121
  147. package/build/es/src/platform-v1-wishlist.universal.js +0 -79
  148. package/build/es/src/platform-v1-wishlist.universal.js.map +0 -1
  149. package/build/es/src/stores-catalog-v1-collection.context.d.ts +0 -5
  150. package/build/es/src/stores-catalog-v1-collection.context.js +0 -50
  151. package/build/es/src/stores-catalog-v1-collection.context.js.map +0 -1
  152. package/build/es/src/stores-catalog-v1-collection.http.d.ts +0 -10
  153. package/build/es/src/stores-catalog-v1-collection.http.js +0 -104
  154. package/build/es/src/stores-catalog-v1-collection.http.js.map +0 -1
  155. package/build/es/src/stores-catalog-v1-collection.meta.d.ts +0 -19
  156. package/build/es/src/stores-catalog-v1-collection.meta.js +0 -56
  157. package/build/es/src/stores-catalog-v1-collection.meta.js.map +0 -1
  158. package/build/es/src/stores-catalog-v1-collection.public.d.ts +0 -59
  159. package/build/es/src/stores-catalog-v1-collection.public.js +0 -19
  160. package/build/es/src/stores-catalog-v1-collection.public.js.map +0 -1
  161. package/build/es/src/stores-catalog-v1-collection.types.d.ts +0 -414
  162. package/build/es/src/stores-catalog-v1-collection.types.js +0 -15
  163. package/build/es/src/stores-catalog-v1-collection.types.js.map +0 -1
  164. package/build/es/src/stores-catalog-v1-collection.universal.d.ts +0 -452
  165. package/build/es/src/stores-catalog-v1-collection.universal.js +0 -196
  166. package/build/es/src/stores-catalog-v1-collection.universal.js.map +0 -1
  167. package/build/es/src/stores-catalog-v1-product.context.d.ts +0 -35
  168. package/build/es/src/stores-catalog-v1-product.context.js +0 -530
  169. package/build/es/src/stores-catalog-v1-product.context.js.map +0 -1
  170. package/build/es/src/stores-catalog-v1-product.http.d.ts +0 -89
  171. package/build/es/src/stores-catalog-v1-product.http.js +0 -1680
  172. package/build/es/src/stores-catalog-v1-product.http.js.map +0 -1
  173. package/build/es/src/stores-catalog-v1-product.meta.d.ts +0 -95
  174. package/build/es/src/stores-catalog-v1-product.meta.js +0 -596
  175. package/build/es/src/stores-catalog-v1-product.meta.js.map +0 -1
  176. package/build/es/src/stores-catalog-v1-product.public.d.ts +0 -1216
  177. package/build/es/src/stores-catalog-v1-product.public.js +0 -170
  178. package/build/es/src/stores-catalog-v1-product.public.js.map +0 -1
  179. package/build/es/src/stores-catalog-v1-product.types.d.ts +0 -4235
  180. package/build/es/src/stores-catalog-v1-product.types.js +0 -75
  181. package/build/es/src/stores-catalog-v1-product.types.js.map +0 -1
  182. package/build/es/src/stores-catalog-v1-product.universal.d.ts +0 -5074
  183. package/build/es/src/stores-catalog-v1-product.universal.js +0 -2161
  184. package/build/es/src/stores-catalog-v1-product.universal.js.map +0 -1
  185. package/build/es/src/stores-v1-abandoned-cart.http.d.ts +0 -6
  186. package/build/es/src/stores-v1-abandoned-cart.http.js +0 -98
  187. package/build/es/src/stores-v1-abandoned-cart.http.js.map +0 -1
  188. package/build/es/src/stores-v1-abandoned-cart.meta.d.ts +0 -16
  189. package/build/es/src/stores-v1-abandoned-cart.meta.js +0 -38
  190. package/build/es/src/stores-v1-abandoned-cart.meta.js.map +0 -1
  191. package/build/es/src/stores-v1-abandoned-cart.public.d.ts +0 -19
  192. package/build/es/src/stores-v1-abandoned-cart.public.js +0 -14
  193. package/build/es/src/stores-v1-abandoned-cart.public.js.map +0 -1
  194. package/build/es/src/stores-v1-abandoned-cart.types.d.ts +0 -216
  195. package/build/es/src/stores-v1-abandoned-cart.types.js +0 -27
  196. package/build/es/src/stores-v1-abandoned-cart.types.js.map +0 -1
  197. package/build/es/src/stores-v1-abandoned-cart.universal.d.ts +0 -246
  198. package/build/es/src/stores-v1-abandoned-cart.universal.js +0 -161
  199. package/build/es/src/stores-v1-abandoned-cart.universal.js.map +0 -1
  200. package/build/es/src/stores-v1-subscription-option.context.d.ts +0 -14
  201. package/build/es/src/stores-v1-subscription-option.context.js +0 -194
  202. package/build/es/src/stores-v1-subscription-option.context.js.map +0 -1
  203. package/build/es/src/stores-v1-subscription-option.http.d.ts +0 -128
  204. package/build/es/src/stores-v1-subscription-option.http.js +0 -451
  205. package/build/es/src/stores-v1-subscription-option.http.js.map +0 -1
  206. package/build/es/src/stores-v1-subscription-option.meta.d.ts +0 -40
  207. package/build/es/src/stores-v1-subscription-option.meta.js +0 -220
  208. package/build/es/src/stores-v1-subscription-option.meta.js.map +0 -1
  209. package/build/es/src/stores-v1-subscription-option.public.d.ts +0 -46
  210. package/build/es/src/stores-v1-subscription-option.public.js +0 -64
  211. package/build/es/src/stores-v1-subscription-option.public.js.map +0 -1
  212. package/build/es/src/stores-v1-subscription-option.types.d.ts +0 -351
  213. package/build/es/src/stores-v1-subscription-option.types.js +0 -17
  214. package/build/es/src/stores-v1-subscription-option.types.js.map +0 -1
  215. package/build/es/src/stores-v1-subscription-option.universal.d.ts +0 -646
  216. package/build/es/src/stores-v1-subscription-option.universal.js +0 -855
  217. package/build/es/src/stores-v1-subscription-option.universal.js.map +0 -1
  218. package/build/es/src/stores-v2-inventory.context.d.ts +0 -7
  219. package/build/es/src/stores-v2-inventory.context.js +0 -82
  220. package/build/es/src/stores-v2-inventory.context.js.map +0 -1
  221. package/build/es/src/stores-v2-inventory.http.d.ts +0 -31
  222. package/build/es/src/stores-v2-inventory.http.js +0 -281
  223. package/build/es/src/stores-v2-inventory.http.js.map +0 -1
  224. package/build/es/src/stores-v2-inventory.meta.d.ts +0 -21
  225. package/build/es/src/stores-v2-inventory.meta.js +0 -94
  226. package/build/es/src/stores-v2-inventory.meta.js.map +0 -1
  227. package/build/es/src/stores-v2-inventory.public.d.ts +0 -13
  228. package/build/es/src/stores-v2-inventory.public.js +0 -30
  229. package/build/es/src/stores-v2-inventory.public.js.map +0 -1
  230. package/build/es/src/stores-v2-inventory.types.d.ts +0 -283
  231. package/build/es/src/stores-v2-inventory.types.js +0 -8
  232. package/build/es/src/stores-v2-inventory.types.js.map +0 -1
  233. package/build/es/src/stores-v2-inventory.universal.d.ts +0 -425
  234. package/build/es/src/stores-v2-inventory.universal.js +0 -351
  235. package/build/es/src/stores-v2-inventory.universal.js.map +0 -1
@@ -1,646 +0,0 @@
1
- export interface SubscriptionOption {
2
- /** Subscription option ID (auto-generated upon subscription option creation). */
3
- _id?: string | null;
4
- /** Subscription option title. */
5
- title?: string | null;
6
- /** Subscription option description (optional). */
7
- description?: string | null;
8
- /** Subscription charge times. For example, if `frequency: MONTH` and `billingCycles: 6`; payment will be made monthly for 6 months. */
9
- subscriptionSettings?: SubscriptionSettings;
10
- /**
11
- * Discount info (optional).
12
- * For example, a $20 discount would be `value: 20`, `type: AMOUNT`.
13
- */
14
- discount?: Discount;
15
- }
16
- export interface SubscriptionSettings {
17
- /** Frequency of recurring payment. */
18
- frequency?: SubscriptionFrequency;
19
- /** Whether subscription is renewed automatically at the end of each period. */
20
- autoRenewal?: boolean;
21
- /** Number of billing cycles before subscription ends. Ignored if `autoRenewal: true`. */
22
- billingCycles?: number | null;
23
- }
24
- /** Frequency unit of recurring payment */
25
- export declare enum SubscriptionFrequency {
26
- UNDEFINED = "UNDEFINED",
27
- DAY = "DAY",
28
- WEEK = "WEEK",
29
- MONTH = "MONTH",
30
- YEAR = "YEAR"
31
- }
32
- export interface Discount {
33
- /** Discount type. */
34
- type?: DiscountType;
35
- /** Discount value. */
36
- value?: number;
37
- }
38
- export declare enum DiscountType {
39
- UNDEFINED = "UNDEFINED",
40
- /** No discount */
41
- AMOUNT = "AMOUNT",
42
- PERCENT = "PERCENT"
43
- }
44
- export interface CreateSubscriptionOptionRequest {
45
- /** Subscription option info. */
46
- subscriptionOption: SubscriptionOption;
47
- }
48
- export interface CreateSubscriptionOptionResponse {
49
- /** Newly created subscription option. */
50
- subscriptionOption?: SubscriptionOption;
51
- }
52
- export interface UpdateSubscriptionOptionRequest {
53
- /** Subscription option info. Only the passed parameters will be updated. */
54
- subscriptionOption: SubscriptionOption;
55
- }
56
- export interface UpdateSubscriptionOptionResponse {
57
- /** Updated subscription option. */
58
- subscriptionOption?: SubscriptionOption;
59
- }
60
- export interface DeleteSubscriptionOptionRequest {
61
- /** ID of the subscription option to delete. */
62
- _id: string;
63
- }
64
- export interface DeleteSubscriptionOptionResponse {
65
- }
66
- export interface BulkCreateSubscriptionOptionsRequest {
67
- /** Subscription options info. */
68
- subscriptionOptions: SubscriptionOption[];
69
- }
70
- export interface BulkCreateSubscriptionOptionsResponse {
71
- /** Newly created subscription options. */
72
- subscriptionOptions?: SubscriptionOption[];
73
- }
74
- export interface BulkUpdateSubscriptionOptionsRequest {
75
- /** Subscription options info. Only the passed parameters in each subscription option will be updated. */
76
- subscriptionOptions: SubscriptionOption[];
77
- }
78
- export interface BulkUpdateSubscriptionOptionsResponse {
79
- /** Updated subscription options. */
80
- subscriptionOptions?: SubscriptionOption[];
81
- }
82
- export interface BulkDeleteSubscriptionOptionsRequest {
83
- /** IDs of the subscription options to delete. */
84
- ids: string[];
85
- }
86
- export interface BulkDeleteSubscriptionOptionsResponse {
87
- }
88
- export interface AssignSubscriptionOptionsToProductRequest {
89
- /** Product ID. */
90
- productId: string;
91
- /** Ordered array of subscription options that will be assigned to the product. Pass an empty array to remove all subscription options from the product. */
92
- assignedSubscriptionOptions?: SubscriptionOptionInProduct[];
93
- }
94
- export interface SubscriptionOptionInProduct {
95
- /** Subscription option ID. */
96
- _id?: string;
97
- /** Whether the subscription option is hidden for the product (the default is false). */
98
- hidden?: boolean;
99
- /**
100
- * Subscription option title.
101
- * @readonly
102
- */
103
- title?: string | null;
104
- /**
105
- * Subscription option description (optional).
106
- * @readonly
107
- */
108
- description?: string | null;
109
- /**
110
- * Subscription payment settings. For example, if `frequency: MONTH` and `billingCycles: 6`; payment will be made monthly for 6 months.
111
- * @readonly
112
- */
113
- subscriptionSettings?: SubscriptionSettings;
114
- /**
115
- * Discount info (optional).
116
- * @readonly
117
- */
118
- discount?: Discount;
119
- }
120
- export interface AssignSubscriptionOptionsToProductResponse {
121
- }
122
- export interface AllowOneTimePurchasesRequest {
123
- /** Product ID. */
124
- productId: string;
125
- /** Pass `true` to offer product by subscription and as one-time purchase. Pass `false` to offer product as subscription only. */
126
- allowed: boolean | null;
127
- }
128
- export interface AllowOneTimePurchasesResponse {
129
- }
130
- export interface GetSubscriptionOptionRequest {
131
- /** Subscription option ID. */
132
- _id: string;
133
- }
134
- export interface GetSubscriptionOptionResponse {
135
- /** Subscription option. */
136
- subscriptionOption?: SubscriptionOption;
137
- }
138
- export interface GetSubscriptionOptionsForProductRequest {
139
- /** Product ID. */
140
- productId: string;
141
- /** Whether to include hidden subscription options in the results. */
142
- includeHiddenSubscriptionOptions?: boolean;
143
- }
144
- export interface GetSubscriptionOptionsForProductResponse {
145
- /** Subscription options. */
146
- subscriptionOptions?: SubscriptionOptionInProduct[];
147
- }
148
- export interface ListSubscriptionOptionsRequest {
149
- /** Subscription option IDs. */
150
- ids?: string[];
151
- }
152
- export interface ListSubscriptionOptionsResponse {
153
- /** Subscription options. */
154
- subscriptionOptions?: SubscriptionOption[];
155
- }
156
- export interface CalculatePricesRequest {
157
- /** original price to which subscription options discount will be applied */
158
- price?: number;
159
- /** ids of subscription options which will be applied to original price */
160
- ids?: string[];
161
- }
162
- export interface CalculatePricesResponse {
163
- /** array of calculated prices */
164
- prices?: SubscriptionOptionPrices[];
165
- /** price to which subscription options discount applied */
166
- originalPrice?: number;
167
- }
168
- export interface SubscriptionOptionPrices {
169
- /** Subscription option id */
170
- _id?: string;
171
- /** Price data calculated for subscription option */
172
- priceData?: SubscriptionOptionPriceData;
173
- /** Price data calculated for subscription option, converted to the currency requested in request header */
174
- convertedPriceData?: SubscriptionOptionPriceData;
175
- }
176
- export interface SubscriptionOptionPriceData {
177
- /** Subscription option price currency */
178
- currency?: string;
179
- /** Price calculated after subscription option discount applied */
180
- discountedPrice?: number;
181
- /** Price calculated after subscription option discount applied, formatted with the currency */
182
- formattedDiscountedPrice?: string;
183
- }
184
- export interface BulkCalculatePricesRequest {
185
- /**
186
- * Original prices to which subscription options discount will be applied.
187
- * Key is identifier unique per price that can be used to match calculated prices with original price
188
- */
189
- prices?: Record<string, number>;
190
- /** ids of subscription options which will be applied to original price */
191
- ids?: string[];
192
- }
193
- export interface BulkCalculatePricesResponse {
194
- /**
195
- * Key is identifier unique per price that can be used to match calculated prices with original price
196
- * Value is response with calculated prices for each subscription option
197
- */
198
- calculatedPrices?: Record<string, CalculatePricesResponse>;
199
- }
200
- export interface BulkCalculatePricesRequestV2 {
201
- /** Original prices to be calculated for each corresponding product id with related subscription plan ids */
202
- items?: BulkCalculatePricesRequestItem[];
203
- }
204
- export interface BulkCalculatePricesRequestItem {
205
- /** Calculation id (product id) */
206
- _id?: string;
207
- /**
208
- * Original prices to which subscription options discount will be applied.
209
- * Key is identifier unique per price that can be used to match calculated prices with original price
210
- */
211
- prices?: Record<string, number>;
212
- /** ids of subscription options which will be applied to original price. */
213
- subscriptionOptionIds?: string[];
214
- }
215
- export interface BulkCalculatePricesResponseV2 {
216
- /**
217
- * Key is identifier unique per price that can be used to match calculated prices with original price
218
- * Value is response with calculated prices for each subscription option for each product
219
- */
220
- calculatedPricesPerProduct?: BulkCalculatePricesResponseItem[];
221
- }
222
- export interface BulkCalculatePricesResponseItem {
223
- /** Calculation id (product id) */
224
- _id?: string;
225
- /**
226
- * Key is identifier unique per price that can be used to match calculated prices with original price
227
- * Value is response with calculated prices for each subscription option
228
- */
229
- calculatedPrices?: Record<string, CalculatePricesResponse>;
230
- }
231
- export interface GetProductIdsForSubscriptionOptionRequest {
232
- /** Subscription option ID. */
233
- _id: string;
234
- /** Whether to include hidden products in the returned results. */
235
- includeHiddenProducts?: boolean;
236
- /** Optional pagination parameters */
237
- paging?: Paging;
238
- }
239
- export interface Paging {
240
- /** Amount of items to load per page. */
241
- limit?: number | null;
242
- /** Number of items to skip in the display (relevant for all pages after the first). */
243
- offset?: number | null;
244
- }
245
- export interface GetProductIdsForSubscriptionOptionResponse {
246
- /** IDs of products associated with the specified subscription option. */
247
- productIds?: string[];
248
- /** Paging metadata. */
249
- metadata?: PagingMetadata;
250
- /** Number of total results. */
251
- totalResults?: number;
252
- }
253
- export interface PagingMetadata {
254
- /** Amount of items to load per page. */
255
- items?: number;
256
- /** Number of items to skip in the display (relevant for all pages after the first). */
257
- offset?: number;
258
- }
259
- export interface GetOneTimePurchasesStatusRequest {
260
- /** Product ID. */
261
- productId: string;
262
- }
263
- export interface GetOneTimePurchasesStatusResponse {
264
- /** Whether the specified product is available for one-time purchase */
265
- allowed?: boolean;
266
- }
267
- export interface CreateSubscriptionOptionResponseNonNullableFields {
268
- subscriptionOption?: {
269
- subscriptionSettings?: {
270
- frequency: SubscriptionFrequency;
271
- autoRenewal: boolean;
272
- };
273
- discount?: {
274
- type: DiscountType;
275
- value: number;
276
- };
277
- };
278
- }
279
- export interface UpdateSubscriptionOptionResponseNonNullableFields {
280
- subscriptionOption?: {
281
- subscriptionSettings?: {
282
- frequency: SubscriptionFrequency;
283
- autoRenewal: boolean;
284
- };
285
- discount?: {
286
- type: DiscountType;
287
- value: number;
288
- };
289
- };
290
- }
291
- export interface BulkCreateSubscriptionOptionsResponseNonNullableFields {
292
- subscriptionOptions: {
293
- subscriptionSettings?: {
294
- frequency: SubscriptionFrequency;
295
- autoRenewal: boolean;
296
- };
297
- discount?: {
298
- type: DiscountType;
299
- value: number;
300
- };
301
- }[];
302
- }
303
- export interface BulkUpdateSubscriptionOptionsResponseNonNullableFields {
304
- subscriptionOptions: {
305
- subscriptionSettings?: {
306
- frequency: SubscriptionFrequency;
307
- autoRenewal: boolean;
308
- };
309
- discount?: {
310
- type: DiscountType;
311
- value: number;
312
- };
313
- }[];
314
- }
315
- export interface GetSubscriptionOptionResponseNonNullableFields {
316
- subscriptionOption?: {
317
- subscriptionSettings?: {
318
- frequency: SubscriptionFrequency;
319
- autoRenewal: boolean;
320
- };
321
- discount?: {
322
- type: DiscountType;
323
- value: number;
324
- };
325
- };
326
- }
327
- export interface GetSubscriptionOptionsForProductResponseNonNullableFields {
328
- subscriptionOptions: {
329
- _id: string;
330
- hidden: boolean;
331
- subscriptionSettings?: {
332
- frequency: SubscriptionFrequency;
333
- autoRenewal: boolean;
334
- };
335
- discount?: {
336
- type: DiscountType;
337
- value: number;
338
- };
339
- }[];
340
- }
341
- export interface GetProductIdsForSubscriptionOptionResponseNonNullableFields {
342
- productIds: string[];
343
- metadata?: {
344
- items: number;
345
- offset: number;
346
- };
347
- totalResults: number;
348
- }
349
- export interface GetOneTimePurchasesStatusResponseNonNullableFields {
350
- allowed: boolean;
351
- }
352
- /**
353
- * Creates a subscription option.
354
- * To assign to a product, call [`assignSubscriptionOptionsToProduct()`](https://www.wix.com/velo/reference/wix-stores-v2/subscriptionoptions/assign-subscription-options-to-product).
355
- * Subscription options that are not assigned to a product will not be visible in the Wix business manager.
356
- * @param subscriptionOption - Subscription option info.
357
- * @public
358
- * @documentationMaturity preview
359
- * @requiredField subscriptionOption
360
- * @requiredField subscriptionOption.subscriptionSettings
361
- * @requiredField subscriptionOption.title
362
- * @permissionScope Manage Stores - all permissions
363
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
364
- * @permissionScope Manage Products
365
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
366
- * @applicableIdentity APP
367
- * @returns Newly created subscription option.
368
- */
369
- export declare function createSubscriptionOption(subscriptionOption: SubscriptionOption): Promise<SubscriptionOption & NonNullable<CreateSubscriptionOptionResponseNonNullableFields>['subscriptionOption']>;
370
- /**
371
- * Updates a subscription option.
372
- * Only parameters passed will be updated.
373
- * <blockquote class='warning'>
374
- *
375
- * __Deprecation Notice:__
376
- *
377
- * This endpoint has been deprecated and will be removed on January 29, 2024.
378
- *
379
- * </blockquote>
380
- * @param _id - Subscription option ID (auto-generated upon subscription option creation).
381
- * @public
382
- * @documentationMaturity preview
383
- * @requiredField _id
384
- * @requiredField subscriptionOption
385
- * @param subscriptionOption - Subscription option update options.
386
- * @permissionScope Manage Stores - all permissions
387
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
388
- * @permissionScope Manage Products
389
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
390
- * @applicableIdentity APP
391
- * @returns Updated subscription option.
392
- */
393
- export declare function updateSubscriptionOption(_id: string | null, subscriptionOption: UpdateSubscriptionOption): Promise<SubscriptionOption & NonNullable<UpdateSubscriptionOptionResponseNonNullableFields>['subscriptionOption']>;
394
- export interface UpdateSubscriptionOption {
395
- /** Subscription option ID (auto-generated upon subscription option creation). */
396
- _id?: string | null;
397
- /** Subscription option title. */
398
- title?: string | null;
399
- /** Subscription option description (optional). */
400
- description?: string | null;
401
- /** Subscription charge times. For example, if `frequency: MONTH` and `billingCycles: 6`; payment will be made monthly for 6 months. */
402
- subscriptionSettings?: SubscriptionSettings;
403
- /**
404
- * Discount info (optional).
405
- * For example, a $20 discount would be `value: 20`, `type: AMOUNT`.
406
- */
407
- discount?: Discount;
408
- }
409
- /**
410
- * Deletes a subscription option.
411
- * <blockquote class='warning'>
412
- *
413
- * __Deprecation Notice:__
414
- *
415
- * This endpoint has been deprecated and will be removed on January 29, 2024.
416
- *
417
- * </blockquote>
418
- * @param _id - ID of the subscription option to delete.
419
- * @public
420
- * @documentationMaturity preview
421
- * @requiredField _id
422
- * @permissionScope Manage Stores - all permissions
423
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
424
- * @permissionScope Manage Products
425
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
426
- * @applicableIdentity APP
427
- */
428
- export declare function deleteSubscriptionOption(_id: string): Promise<void>;
429
- /**
430
- * Creates multiple subscription options (up to 100).
431
- * To assign to a product, call [`assignSubscriptionOptionsToProduct()`](https://www.wix.com/velo/reference/wix-stores-v2/subscriptionoptions/assign-subscription-options-to-product).
432
- * Subscription options that are not assigned to a product will not be visible in the Wix business manager.
433
- * @param subscriptionOptions - Subscription options info.
434
- * @public
435
- * @documentationMaturity preview
436
- * @requiredField subscriptionOptions
437
- * @requiredField subscriptionOptions.subscriptionSettings
438
- * @requiredField subscriptionOptions.title
439
- * @permissionScope Manage Stores - all permissions
440
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
441
- * @permissionScope Manage Products
442
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
443
- * @applicableIdentity APP
444
- */
445
- export declare function bulkCreateSubscriptionOptions(subscriptionOptions: SubscriptionOption[]): Promise<BulkCreateSubscriptionOptionsResponse & BulkCreateSubscriptionOptionsResponseNonNullableFields>;
446
- /**
447
- * Updates multiple subscription options.
448
- * Only parameters passed will be updated.
449
- * <blockquote class='warning'>
450
- *
451
- * __Deprecation Notice:__
452
- *
453
- * This endpoint has been deprecated and will be removed on January 29, 2024.
454
- *
455
- * </blockquote>
456
- * @param subscriptionOptions - Subscription options info. Only the passed parameters in each subscription option will be updated.
457
- * @public
458
- * @documentationMaturity preview
459
- * @requiredField subscriptionOptions
460
- * @requiredField subscriptionOptions._id
461
- * @permissionScope Manage Stores - all permissions
462
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
463
- * @permissionScope Manage Products
464
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
465
- * @applicableIdentity APP
466
- */
467
- export declare function bulkUpdateSubscriptionOptions(subscriptionOptions: SubscriptionOption[]): Promise<BulkUpdateSubscriptionOptionsResponse & BulkUpdateSubscriptionOptionsResponseNonNullableFields>;
468
- /**
469
- * Deletes multiple subscription options.
470
- * <blockquote class='warning'>
471
- *
472
- * __Deprecation Notice:__
473
- *
474
- * This endpoint has been deprecated and will be removed on January 29, 2024.
475
- *
476
- * </blockquote>
477
- * @param ids - IDs of the subscription options to delete.
478
- * @public
479
- * @documentationMaturity preview
480
- * @requiredField ids
481
- * @permissionScope Manage Stores - all permissions
482
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
483
- * @permissionScope Manage Products
484
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
485
- * @applicableIdentity APP
486
- */
487
- export declare function bulkDeleteSubscriptionOptions(ids: string[]): Promise<void>;
488
- /**
489
- * Assign up to 6 subscription options to a specified product.
490
- * Pass an empty array to remove all subscription options assigned to a product.
491
- * <blockquote class='warning'>
492
- *
493
- * __Deprecation Notice:__
494
- *
495
- * This endpoint has been deprecated and will be removed on January 29, 2024.
496
- *
497
- * </blockquote>
498
- * @param productId - Product ID.
499
- * @public
500
- * @documentationMaturity preview
501
- * @requiredField productId
502
- * @param options - Subscription option assignment options.
503
- * @permissionScope Manage Stores - all permissions
504
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
505
- * @permissionScope Manage Products
506
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
507
- * @applicableIdentity APP
508
- */
509
- export declare function assignSubscriptionOptionsToProduct(productId: string, options?: AssignSubscriptionOptionsToProductOptions): Promise<void>;
510
- export interface AssignSubscriptionOptionsToProductOptions {
511
- /** Ordered array of subscription options that will be assigned to the product. Pass an empty array to remove all subscription options from the product. */
512
- assignedSubscriptionOptions?: SubscriptionOptionInProduct[];
513
- }
514
- /**
515
- * Allow for one-time purchase of a product.
516
- * By default, product can be sold only as part of a subscription, not as a one-time purchase.
517
- * <blockquote class='warning'>
518
- *
519
- * __Deprecation Notice:__
520
- *
521
- * This endpoint has been deprecated and will be removed on January 29, 2024.
522
- *
523
- * </blockquote>
524
- * @param productId - Product ID.
525
- * @param allowed - Pass `true` to offer product by subscription and as one-time purchase. Pass `false` to offer product as subscription only.
526
- * @public
527
- * @documentationMaturity preview
528
- * @requiredField allowed
529
- * @requiredField productId
530
- * @permissionScope Manage Stores - all permissions
531
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
532
- * @permissionScope Manage Products
533
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
534
- * @applicableIdentity APP
535
- */
536
- export declare function allowOneTimePurchases(productId: string, allowed: boolean | null): Promise<void>;
537
- /**
538
- * Retrieves a subscription option by ID.
539
- * <blockquote class='warning'>
540
- *
541
- * __Deprecation Notice:__
542
- *
543
- * This endpoint has been deprecated and will be removed on January 29, 2024.
544
- *
545
- * </blockquote>
546
- * @param _id - Subscription option ID.
547
- * @public
548
- * @documentationMaturity preview
549
- * @requiredField _id
550
- * @permissionScope Manage Stores - all permissions
551
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
552
- * @permissionScope Manage Products
553
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
554
- * @permissionScope Read Stores - all read permissions
555
- * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
556
- * @permissionScope Read Products
557
- * @permissionScopeId SCOPE.DC-STORES.READ-PRODUCTS
558
- * @applicableIdentity APP
559
- * @returns Subscription option.
560
- */
561
- export declare function getSubscriptionOption(_id: string): Promise<SubscriptionOption & NonNullable<GetSubscriptionOptionResponseNonNullableFields>['subscriptionOption']>;
562
- /**
563
- * Retrieves all subscription options assigned to a specified product.
564
- * By default, hidden subscription options are not returned. To retrieve all subscription options you must pass `includeHiddenSubscriptionOptions = true`.
565
- * <blockquote class='warning'>
566
- *
567
- * __Deprecation Notice:__
568
- *
569
- * This endpoint has been deprecated and will be removed on January 29, 2024.
570
- *
571
- * </blockquote>
572
- * @param productId - Product ID.
573
- * @public
574
- * @documentationMaturity preview
575
- * @requiredField productId
576
- * @param options - Options.
577
- * @permissionScope Manage Stores - all permissions
578
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
579
- * @permissionScope Manage Products
580
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
581
- * @permissionScope Read Stores - all read permissions
582
- * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
583
- * @permissionScope Read Products
584
- * @permissionScopeId SCOPE.DC-STORES.READ-PRODUCTS
585
- * @applicableIdentity APP
586
- */
587
- export declare function getSubscriptionOptionsForProduct(productId: string, options?: GetSubscriptionOptionsForProductOptions): Promise<GetSubscriptionOptionsForProductResponse & GetSubscriptionOptionsForProductResponseNonNullableFields>;
588
- export interface GetSubscriptionOptionsForProductOptions {
589
- /** Whether to include hidden subscription options in the results. */
590
- includeHiddenSubscriptionOptions?: boolean;
591
- }
592
- /**
593
- * Retrieves the IDs of products associated with a specified subscription option.
594
- * <blockquote class='warning'>
595
- *
596
- * __Deprecation Notice:__
597
- *
598
- * This endpoint has been deprecated and will be removed on January 29, 2024.
599
- *
600
- * </blockquote>
601
- * @param _id - Subscription option ID.
602
- * @public
603
- * @documentationMaturity preview
604
- * @requiredField _id
605
- * @param options - Paging and other options.
606
- * @permissionScope Manage Stores - all permissions
607
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
608
- * @permissionScope Manage Products
609
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
610
- * @permissionScope Read Stores - all read permissions
611
- * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
612
- * @permissionScope Read Products
613
- * @permissionScopeId SCOPE.DC-STORES.READ-PRODUCTS
614
- * @applicableIdentity APP
615
- */
616
- export declare function getProductIdsForSubscriptionOption(_id: string, options?: GetProductIdsForSubscriptionOptionOptions): Promise<GetProductIdsForSubscriptionOptionResponse & GetProductIdsForSubscriptionOptionResponseNonNullableFields>;
617
- export interface GetProductIdsForSubscriptionOptionOptions {
618
- /** Whether to include hidden products in the returned results. */
619
- includeHiddenProducts?: boolean;
620
- /** Optional pagination parameters */
621
- paging?: Paging;
622
- }
623
- /**
624
- * Checks whether a specified product (associated with subscription options) is available for one-time purchase.
625
- * <blockquote class='warning'>
626
- *
627
- * __Deprecation Notice:__
628
- *
629
- * This endpoint has been deprecated and will be removed on January 29, 2024.
630
- *
631
- * </blockquote>
632
- * @param productId - Product ID.
633
- * @public
634
- * @documentationMaturity preview
635
- * @requiredField productId
636
- * @permissionScope Manage Stores - all permissions
637
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
638
- * @permissionScope Manage Products
639
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
640
- * @permissionScope Read Stores - all read permissions
641
- * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
642
- * @permissionScope Read Products
643
- * @permissionScopeId SCOPE.DC-STORES.READ-PRODUCTS
644
- * @applicableIdentity APP
645
- */
646
- export declare function getOneTimePurchasesStatus(productId: string): Promise<GetOneTimePurchasesStatusResponse & GetOneTimePurchasesStatusResponseNonNullableFields>;