@congminh1254/shopee-sdk 0.9.0 → 1.0.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 (137) hide show
  1. package/README.md +178 -36
  2. package/lib/fetch.js +13 -0
  3. package/lib/fetch.js.map +1 -1
  4. package/lib/managers/add-on-deal.manager.d.ts +140 -0
  5. package/lib/managers/add-on-deal.manager.js +240 -0
  6. package/lib/managers/add-on-deal.manager.js.map +1 -0
  7. package/lib/managers/ads.manager.d.ts +217 -1
  8. package/lib/managers/ads.manager.js +312 -0
  9. package/lib/managers/ads.manager.js.map +1 -1
  10. package/lib/managers/bundle-deal.manager.d.ts +106 -0
  11. package/lib/managers/bundle-deal.manager.js +178 -0
  12. package/lib/managers/bundle-deal.manager.js.map +1 -0
  13. package/lib/managers/discount.manager.d.ts +102 -0
  14. package/lib/managers/discount.manager.js +167 -0
  15. package/lib/managers/discount.manager.js.map +1 -0
  16. package/lib/managers/fbs.manager.d.ts +115 -0
  17. package/lib/managers/fbs.manager.js +145 -0
  18. package/lib/managers/fbs.manager.js.map +1 -0
  19. package/lib/managers/first-mile.manager.d.ts +150 -0
  20. package/lib/managers/first-mile.manager.js +264 -0
  21. package/lib/managers/first-mile.manager.js.map +1 -0
  22. package/lib/managers/follow-prize.manager.d.ts +108 -0
  23. package/lib/managers/follow-prize.manager.js +152 -0
  24. package/lib/managers/follow-prize.manager.js.map +1 -0
  25. package/lib/managers/global-product.manager.d.ts +664 -0
  26. package/lib/managers/global-product.manager.js +904 -0
  27. package/lib/managers/global-product.manager.js.map +1 -0
  28. package/lib/managers/index.d.ts +17 -1
  29. package/lib/managers/index.js +17 -1
  30. package/lib/managers/index.js.map +1 -1
  31. package/lib/managers/livestream.manager.d.ts +377 -0
  32. package/lib/managers/livestream.manager.js +529 -0
  33. package/lib/managers/livestream.manager.js.map +1 -0
  34. package/lib/managers/logistics.manager.d.ts +267 -1
  35. package/lib/managers/logistics.manager.js +544 -0
  36. package/lib/managers/logistics.manager.js.map +1 -1
  37. package/lib/managers/media-space.manager.d.ts +179 -0
  38. package/lib/managers/media-space.manager.js +220 -0
  39. package/lib/managers/media-space.manager.js.map +1 -0
  40. package/lib/managers/media.manager.d.ts +226 -0
  41. package/lib/managers/media.manager.js +274 -0
  42. package/lib/managers/media.manager.js.map +1 -0
  43. package/lib/managers/merchant.manager.d.ts +100 -0
  44. package/lib/managers/merchant.manager.js +144 -0
  45. package/lib/managers/merchant.manager.js.map +1 -0
  46. package/lib/managers/order.manager.d.ts +213 -1
  47. package/lib/managers/order.manager.js +305 -0
  48. package/lib/managers/order.manager.js.map +1 -1
  49. package/lib/managers/payment.manager.d.ts +186 -1
  50. package/lib/managers/payment.manager.js +288 -0
  51. package/lib/managers/payment.manager.js.map +1 -1
  52. package/lib/managers/product.manager.d.ts +346 -1
  53. package/lib/managers/product.manager.js +718 -0
  54. package/lib/managers/product.manager.js.map +1 -1
  55. package/lib/managers/returns.manager.d.ts +200 -0
  56. package/lib/managers/returns.manager.js +300 -0
  57. package/lib/managers/returns.manager.js.map +1 -0
  58. package/lib/managers/sbs.manager.d.ts +112 -0
  59. package/lib/managers/sbs.manager.js +149 -0
  60. package/lib/managers/sbs.manager.js.map +1 -0
  61. package/lib/managers/shop-category.manager.d.ts +207 -0
  62. package/lib/managers/shop-category.manager.js +258 -0
  63. package/lib/managers/shop-category.manager.js.map +1 -0
  64. package/lib/managers/shop-flash-sale.manager.d.ts +242 -0
  65. package/lib/managers/shop-flash-sale.manager.js +321 -0
  66. package/lib/managers/shop-flash-sale.manager.js.map +1 -0
  67. package/lib/managers/shop.manager.d.ts +173 -0
  68. package/lib/managers/shop.manager.js +217 -0
  69. package/lib/managers/shop.manager.js.map +1 -0
  70. package/lib/managers/top-picks.manager.d.ts +62 -0
  71. package/lib/managers/top-picks.manager.js +91 -0
  72. package/lib/managers/top-picks.manager.js.map +1 -0
  73. package/lib/schemas/add-on-deal.d.ts +390 -0
  74. package/lib/schemas/add-on-deal.js +45 -0
  75. package/lib/schemas/add-on-deal.js.map +1 -0
  76. package/lib/schemas/ads.d.ts +437 -0
  77. package/lib/schemas/bundle-deal.d.ts +300 -0
  78. package/lib/schemas/bundle-deal.js +27 -0
  79. package/lib/schemas/bundle-deal.js.map +1 -0
  80. package/lib/schemas/discount.d.ts +334 -0
  81. package/lib/schemas/discount.js +15 -0
  82. package/lib/schemas/discount.js.map +1 -0
  83. package/lib/schemas/fbs.d.ts +117 -0
  84. package/lib/schemas/fbs.js +2 -0
  85. package/lib/schemas/fbs.js.map +1 -0
  86. package/lib/schemas/first-mile.d.ts +551 -0
  87. package/lib/schemas/first-mile.js +2 -0
  88. package/lib/schemas/first-mile.js.map +1 -0
  89. package/lib/schemas/follow-prize.d.ts +198 -0
  90. package/lib/schemas/follow-prize.js +27 -0
  91. package/lib/schemas/follow-prize.js.map +1 -0
  92. package/lib/schemas/global-product.d.ts +1127 -0
  93. package/lib/schemas/global-product.js +2 -0
  94. package/lib/schemas/global-product.js.map +1 -0
  95. package/lib/schemas/index.d.ts +13 -0
  96. package/lib/schemas/index.js +17 -0
  97. package/lib/schemas/index.js.map +1 -1
  98. package/lib/schemas/livestream.d.ts +649 -0
  99. package/lib/schemas/livestream.js +2 -0
  100. package/lib/schemas/livestream.js.map +1 -0
  101. package/lib/schemas/logistics.d.ts +979 -0
  102. package/lib/schemas/logistics.js +13 -0
  103. package/lib/schemas/logistics.js.map +1 -1
  104. package/lib/schemas/media-space.d.ts +189 -0
  105. package/lib/schemas/media-space.js +2 -0
  106. package/lib/schemas/media-space.js.map +1 -0
  107. package/lib/schemas/media.d.ts +230 -0
  108. package/lib/schemas/media.js +2 -0
  109. package/lib/schemas/media.js.map +1 -0
  110. package/lib/schemas/merchant.d.ts +236 -0
  111. package/lib/schemas/merchant.js +2 -0
  112. package/lib/schemas/merchant.js.map +1 -0
  113. package/lib/schemas/order.d.ts +431 -0
  114. package/lib/schemas/payment.d.ts +397 -0
  115. package/lib/schemas/product.d.ts +1157 -0
  116. package/lib/schemas/returns.d.ts +632 -0
  117. package/lib/schemas/returns.js +63 -0
  118. package/lib/schemas/returns.js.map +1 -0
  119. package/lib/schemas/sbs.d.ts +484 -0
  120. package/lib/schemas/sbs.js +2 -0
  121. package/lib/schemas/sbs.js.map +1 -0
  122. package/lib/schemas/shop-category.d.ts +176 -0
  123. package/lib/schemas/shop-category.js +2 -0
  124. package/lib/schemas/shop-category.js.map +1 -0
  125. package/lib/schemas/shop-flash-sale.d.ts +473 -0
  126. package/lib/schemas/shop-flash-sale.js +43 -0
  127. package/lib/schemas/shop-flash-sale.js.map +1 -0
  128. package/lib/schemas/shop.d.ts +250 -0
  129. package/lib/schemas/shop.js +2 -0
  130. package/lib/schemas/shop.js.map +1 -0
  131. package/lib/schemas/top-picks.d.ts +99 -0
  132. package/lib/schemas/top-picks.js +2 -0
  133. package/lib/schemas/top-picks.js.map +1 -0
  134. package/lib/sdk.d.ts +34 -0
  135. package/lib/sdk.js +34 -0
  136. package/lib/sdk.js.map +1 -1
  137. package/package.json +7 -4
@@ -0,0 +1,240 @@
1
+ import { BaseManager } from "./base.manager.js";
2
+ import { ShopeeFetch } from "../fetch.js";
3
+ export class AddOnDealManager extends BaseManager {
4
+ constructor(config) {
5
+ super(config);
6
+ }
7
+ /**
8
+ * Create a new add-on deal activity
9
+ * @param {AddAddOnDealParams} params - Parameters for creating a new add-on deal
10
+ * @returns {Promise<AddAddOnDealResponse>} The response containing the created add-on deal ID
11
+ *
12
+ * Note: A maximum of 1000 add-on deals can be created.
13
+ * The start time must be 1 hour later than current time.
14
+ * The end time must be 1 hour later than start time.
15
+ */
16
+ async addAddOnDeal(params) {
17
+ const response = await ShopeeFetch.fetch(this.config, "/add_on_deal/add_add_on_deal", {
18
+ method: "POST",
19
+ auth: true,
20
+ body: params,
21
+ });
22
+ return response;
23
+ }
24
+ /**
25
+ * Add main items to an existing add-on deal activity
26
+ * @param {AddAddOnDealMainItemParams} params - Parameters for adding main items to an add-on deal
27
+ * @returns {Promise<AddAddOnDealMainItemResponse>} The response containing the list of added main items
28
+ *
29
+ * Main items are the products that customers must purchase to be eligible for the add-on deal.
30
+ */
31
+ async addAddOnDealMainItem(params) {
32
+ const response = await ShopeeFetch.fetch(this.config, "/add_on_deal/add_add_on_deal_main_item", {
33
+ method: "POST",
34
+ auth: true,
35
+ body: params,
36
+ });
37
+ return response;
38
+ }
39
+ /**
40
+ * Add sub items (discounted or gift items) to an existing add-on deal activity
41
+ * @param {AddAddOnDealSubItemParams} params - Parameters for adding sub items to an add-on deal
42
+ * @returns {Promise<AddAddOnDealSubItemResponse>} The response containing any failed sub items
43
+ *
44
+ * Sub items are the products offered at a discount or as gifts when customers purchase main items.
45
+ * The response includes a list of items that failed to be added with error details.
46
+ */
47
+ async addAddOnDealSubItem(params) {
48
+ const response = await ShopeeFetch.fetch(this.config, "/add_on_deal/add_add_on_deal_sub_item", {
49
+ method: "POST",
50
+ auth: true,
51
+ body: params,
52
+ });
53
+ return response;
54
+ }
55
+ /**
56
+ * Delete an existing add-on deal activity
57
+ * @param {DeleteAddOnDealParams} params - Parameters for deleting an add-on deal
58
+ * @returns {Promise<DeleteAddOnDealResponse>} The response containing the deleted add-on deal ID
59
+ *
60
+ * Note: Can only delete upcoming add-on deals that haven't started yet.
61
+ * Will return an error if attempting to delete an add-on deal that has already started.
62
+ */
63
+ async deleteAddOnDeal(params) {
64
+ const response = await ShopeeFetch.fetch(this.config, "/add_on_deal/delete_add_on_deal", {
65
+ method: "POST",
66
+ auth: true,
67
+ body: params,
68
+ });
69
+ return response;
70
+ }
71
+ /**
72
+ * Delete main items from an existing add-on deal activity
73
+ * @param {DeleteAddOnDealMainItemParams} params - Parameters for deleting main items from an add-on deal
74
+ * @returns {Promise<DeleteAddOnDealMainItemResponse>} The response containing any failed item deletions
75
+ *
76
+ * The response includes:
77
+ * - add_on_deal_id: The ID of the add-on deal
78
+ * - failed_item_id_list: List of item IDs that failed to be deleted
79
+ */
80
+ async deleteAddOnDealMainItem(params) {
81
+ const response = await ShopeeFetch.fetch(this.config, "/add_on_deal/delete_add_on_deal_main_item", {
82
+ method: "POST",
83
+ auth: true,
84
+ body: params,
85
+ });
86
+ return response;
87
+ }
88
+ /**
89
+ * Delete sub items from an existing add-on deal activity
90
+ * @param {DeleteAddOnDealSubItemParams} params - Parameters for deleting sub items from an add-on deal
91
+ * @returns {Promise<DeleteAddOnDealSubItemResponse>} The response containing any failed sub item deletions
92
+ *
93
+ * The response includes a list of sub items that failed to be deleted with error details.
94
+ * Note: At least one sub item should remain in the add-on deal.
95
+ */
96
+ async deleteAddOnDealSubItem(params) {
97
+ const response = await ShopeeFetch.fetch(this.config, "/add_on_deal/delete_add_on_deal_sub_item", {
98
+ method: "POST",
99
+ auth: true,
100
+ body: params,
101
+ });
102
+ return response;
103
+ }
104
+ /**
105
+ * End an ongoing add-on deal activity immediately
106
+ * @param {EndAddOnDealParams} params - Parameters for ending an add-on deal
107
+ * @returns {Promise<EndAddOnDealResponse>} The response containing the ended add-on deal ID
108
+ *
109
+ * Note: Can only end add-on deals that are currently ongoing/active.
110
+ * Will return an error if attempting to end an upcoming or expired add-on deal.
111
+ */
112
+ async endAddOnDeal(params) {
113
+ const response = await ShopeeFetch.fetch(this.config, "/add_on_deal/end_add_on_deal", {
114
+ method: "POST",
115
+ auth: true,
116
+ body: params,
117
+ });
118
+ return response;
119
+ }
120
+ /**
121
+ * Get detailed information about an add-on deal activity
122
+ * @param {GetAddOnDealParams} params - Parameters for getting add-on deal details
123
+ * @returns {Promise<GetAddOnDealResponse>} The response containing comprehensive add-on deal information
124
+ *
125
+ * The response includes:
126
+ * - Basic add-on deal details (ID, name, start/end time, etc.)
127
+ * - Promotion type and configuration
128
+ * - Purchase limits and requirements
129
+ * - Sub item display priority
130
+ * - Source information
131
+ */
132
+ async getAddOnDeal(params) {
133
+ const response = await ShopeeFetch.fetch(this.config, "/add_on_deal/get_add_on_deal", {
134
+ method: "GET",
135
+ auth: true,
136
+ params,
137
+ });
138
+ return response;
139
+ }
140
+ /**
141
+ * Get a list of add-on deal activities with pagination
142
+ * @param {GetAddOnDealListParams} params - Parameters for retrieving add-on deal list
143
+ * @param {AddOnDealPromotionStatus} params.promotion_status - Filter by promotion status (all, ongoing, upcoming, expired)
144
+ * @param {number} [params.page_no] - Page number to retrieve (default: 1, max: 1000)
145
+ * @param {number} [params.page_size] - Number of items per page (default: 100, max: 100)
146
+ * @returns {Promise<GetAddOnDealListResponse>} The response containing a paginated list of add-on deals
147
+ *
148
+ * The response includes:
149
+ * - add_on_deal_list: List of add-on deals with full details
150
+ * - more: Boolean indicating if there are more pages
151
+ */
152
+ async getAddOnDealList(params) {
153
+ const response = await ShopeeFetch.fetch(this.config, "/add_on_deal/get_add_on_deal_list", {
154
+ method: "GET",
155
+ auth: true,
156
+ params,
157
+ });
158
+ return response;
159
+ }
160
+ /**
161
+ * Get main items in an add-on deal activity
162
+ * @param {GetAddOnDealMainItemParams} params - Parameters for getting main items
163
+ * @returns {Promise<GetAddOnDealMainItemResponse>} The response containing the list of main items
164
+ *
165
+ * Main items are the products that customers must purchase to be eligible for the add-on deal.
166
+ */
167
+ async getAddOnDealMainItem(params) {
168
+ const response = await ShopeeFetch.fetch(this.config, "/add_on_deal/get_add_on_deal_main_item", {
169
+ method: "GET",
170
+ auth: true,
171
+ params,
172
+ });
173
+ return response;
174
+ }
175
+ /**
176
+ * Get sub items (discounted or gift items) in an add-on deal activity
177
+ * @param {GetAddOnDealSubItemParams} params - Parameters for getting sub items
178
+ * @returns {Promise<GetAddOnDealSubItemResponse>} The response containing the list of sub items
179
+ *
180
+ * Sub items are the products offered at a discount or as gifts when customers purchase main items.
181
+ */
182
+ async getAddOnDealSubItem(params) {
183
+ const response = await ShopeeFetch.fetch(this.config, "/add_on_deal/get_add_on_deal_sub_item", {
184
+ method: "GET",
185
+ auth: true,
186
+ params,
187
+ });
188
+ return response;
189
+ }
190
+ /**
191
+ * Update an existing add-on deal activity
192
+ * @param {UpdateAddOnDealParams} params - Parameters for updating an add-on deal
193
+ * @returns {Promise<UpdateAddOnDealResponse>} The response containing the updated add-on deal information
194
+ *
195
+ * Note: For ongoing add-on deals, update capabilities may be limited.
196
+ * Only certain fields can be modified depending on the add-on deal status.
197
+ * The start time of upcoming add-on deals cannot be shortened.
198
+ * Promotion end time can only be changed to an earlier timing.
199
+ */
200
+ async updateAddOnDeal(params) {
201
+ const response = await ShopeeFetch.fetch(this.config, "/add_on_deal/update_add_on_deal", {
202
+ method: "POST",
203
+ auth: true,
204
+ body: params,
205
+ });
206
+ return response;
207
+ }
208
+ /**
209
+ * Update main items in an existing add-on deal activity
210
+ * @param {UpdateAddOnDealMainItemParams} params - Parameters for updating main items
211
+ * @returns {Promise<UpdateAddOnDealMainItemResponse>} The response containing the updated main items
212
+ *
213
+ * Main items are the products that customers must purchase to be eligible for the add-on deal.
214
+ */
215
+ async updateAddOnDealMainItem(params) {
216
+ const response = await ShopeeFetch.fetch(this.config, "/add_on_deal/update_add_on_deal_main_item", {
217
+ method: "POST",
218
+ auth: true,
219
+ body: params,
220
+ });
221
+ return response;
222
+ }
223
+ /**
224
+ * Update sub items in an existing add-on deal activity
225
+ * @param {UpdateAddOnDealSubItemParams} params - Parameters for updating sub items
226
+ * @returns {Promise<UpdateAddOnDealSubItemResponse>} The response containing any failed sub item updates
227
+ *
228
+ * Sub items are the products offered at a discount or as gifts when customers purchase main items.
229
+ * The response includes a list of sub items that failed to be updated with error details.
230
+ */
231
+ async updateAddOnDealSubItem(params) {
232
+ const response = await ShopeeFetch.fetch(this.config, "/add_on_deal/update_add_on_deal_sub_item", {
233
+ method: "POST",
234
+ auth: true,
235
+ body: params,
236
+ });
237
+ return response;
238
+ }
239
+ }
240
+ //# sourceMappingURL=add-on-deal.manager.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"add-on-deal.manager.js","sourceRoot":"","sources":["../../src/managers/add-on-deal.manager.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AA+BhD,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE1C,MAAM,OAAO,gBAAiB,SAAQ,WAAW;IAC/C,YAAY,MAAoB;QAC9B,KAAK,CAAC,MAAM,CAAC,CAAC;IAChB,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,YAAY,CAAC,MAA0B;QAC3C,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,8BAA8B,EAC9B;YACE,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,IAAI;YACV,IAAI,EAAE,MAAM;SACb,CACF,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,oBAAoB,CACxB,MAAkC;QAElC,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,wCAAwC,EACxC;YACE,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,IAAI;YACV,IAAI,EAAE,MAAM;SACb,CACF,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,mBAAmB,CACvB,MAAiC;QAEjC,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,uCAAuC,EACvC;YACE,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,IAAI;YACV,IAAI,EAAE,MAAM;SACb,CACF,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,eAAe,CAAC,MAA6B;QACjD,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,iCAAiC,EACjC;YACE,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,IAAI;YACV,IAAI,EAAE,MAAM;SACb,CACF,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,uBAAuB,CAC3B,MAAqC;QAErC,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,2CAA2C,EAC3C;YACE,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,IAAI;YACV,IAAI,EAAE,MAAM;SACb,CACF,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,sBAAsB,CAC1B,MAAoC;QAEpC,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,0CAA0C,EAC1C;YACE,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,IAAI;YACV,IAAI,EAAE,MAAM;SACb,CACF,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,YAAY,CAAC,MAA0B;QAC3C,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,8BAA8B,EAC9B;YACE,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,IAAI;YACV,IAAI,EAAE,MAAM;SACb,CACF,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,YAAY,CAAC,MAA0B;QAC3C,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,8BAA8B,EAC9B;YACE,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,IAAI;YACV,MAAM;SACP,CACF,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,gBAAgB,CAAC,MAA8B;QACnD,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,mCAAmC,EACnC;YACE,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,IAAI;YACV,MAAM;SACP,CACF,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,oBAAoB,CACxB,MAAkC;QAElC,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,wCAAwC,EACxC;YACE,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,IAAI;YACV,MAAM;SACP,CACF,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,mBAAmB,CACvB,MAAiC;QAEjC,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,uCAAuC,EACvC;YACE,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,IAAI;YACV,MAAM;SACP,CACF,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,eAAe,CAAC,MAA6B;QACjD,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,iCAAiC,EACjC;YACE,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,IAAI;YACV,IAAI,EAAE,MAAM;SACb,CACF,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,uBAAuB,CAC3B,MAAqC;QAErC,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,2CAA2C,EAC3C;YACE,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,IAAI;YACV,IAAI,EAAE,MAAM;SACb,CACF,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,sBAAsB,CAC1B,MAAoC;QAEpC,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,0CAA0C,EAC1C;YACE,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,IAAI;YACV,IAAI,EAAE,MAAM;SACb,CACF,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;CACF"}
@@ -1,6 +1,6 @@
1
1
  import { ShopeeConfig } from "../sdk.js";
2
2
  import { BaseManager } from "./base.manager.js";
3
- import { GetTotalBalanceResponse, GetShopToggleInfoResponse, GetRecommendedKeywordListParams, GetRecommendedKeywordListResponse, GetRecommendedItemListResponse, GetAllCpcAdsHourlyPerformanceParams, GetAllCpcAdsHourlyPerformanceResponse, GetAllCpcAdsDailyPerformanceParams, GetAllCpcAdsDailyPerformanceResponse, GetProductCampaignDailyPerformanceParams, GetProductCampaignDailyPerformanceResponse, GetProductCampaignHourlyPerformanceParams, GetProductCampaignHourlyPerformanceResponse, GetProductLevelCampaignIdListParams, GetProductLevelCampaignIdListResponse, GetProductLevelCampaignSettingInfoParams, GetProductLevelCampaignSettingInfoResponse, GetProductRecommendedRoiTargetParams, GetProductRecommendedRoiTargetResponse } from "../schemas/ads.js";
3
+ import { GetTotalBalanceResponse, GetShopToggleInfoResponse, GetRecommendedKeywordListParams, GetRecommendedKeywordListResponse, GetRecommendedItemListResponse, GetAllCpcAdsHourlyPerformanceParams, GetAllCpcAdsHourlyPerformanceResponse, GetAllCpcAdsDailyPerformanceParams, GetAllCpcAdsDailyPerformanceResponse, GetProductCampaignDailyPerformanceParams, GetProductCampaignDailyPerformanceResponse, GetProductCampaignHourlyPerformanceParams, GetProductCampaignHourlyPerformanceResponse, GetProductLevelCampaignIdListParams, GetProductLevelCampaignIdListResponse, GetProductLevelCampaignSettingInfoParams, GetProductLevelCampaignSettingInfoResponse, GetProductRecommendedRoiTargetParams, GetProductRecommendedRoiTargetResponse, CheckCreateGmsProductCampaignEligibilityResponse, CreateAutoProductAdsParams, CreateAutoProductAdsResponse, CreateGmsProductCampaignParams, CreateGmsProductCampaignResponse, CreateManualProductAdsParams, CreateManualProductAdsResponse, EditAutoProductAdsParams, EditAutoProductAdsResponse, EditGmsItemProductCampaignParams, EditGmsItemProductCampaignResponse, EditGmsProductCampaignParams, EditGmsProductCampaignResponse, EditManualProductAdKeywordsParams, EditManualProductAdKeywordsResponse, EditManualProductAdsParams, EditManualProductAdsResponse, GetAdsFacilShopRateResponse, GetCreateProductAdBudgetSuggestionParams, GetCreateProductAdBudgetSuggestionResponse, GetGmsCampaignPerformanceParams, GetGmsCampaignPerformanceResponse, GetGmsItemPerformanceParams, GetGmsItemPerformanceResponse, ListGmsUserDeletedItemParams, ListGmsUserDeletedItemResponse } from "../schemas/ads.js";
4
4
  export declare class AdsManager extends BaseManager {
5
5
  constructor(config: ShopeeConfig);
6
6
  /**
@@ -270,4 +270,220 @@ export declare class AdsManager extends BaseManager {
270
270
  * based on competitive marketplace data.
271
271
  */
272
272
  getProductRecommendedRoiTarget(params: GetProductRecommendedRoiTargetParams): Promise<GetProductRecommendedRoiTargetResponse>;
273
+ /**
274
+ * Check the seller's eligibility in creating a GMS campaign
275
+ * @returns {Promise<CheckCreateGmsProductCampaignEligibilityResponse>} Response containing eligibility status
276
+ *
277
+ * This API is used to check if the seller is eligible to create a GMS (Gross Merchandise Sales) Campaign.
278
+ * The response indicates eligibility and provides a reason if the seller is not eligible.
279
+ *
280
+ * Possible reasons for ineligibility:
281
+ * - active_campaign: There is already an existing GMS Campaign that is active
282
+ * - not_whitelisted: The seller is not whitelisted to sz_shop_gmv_max_feature
283
+ * - not_have_enough_sku: The seller does not have enough valid items in the shop
284
+ * - exclusive_with_other_campaign: Seller is whitelisted to sz_ads_auto_boost
285
+ */
286
+ checkCreateGmsProductCampaignEligibility(): Promise<CheckCreateGmsProductCampaignEligibilityResponse>;
287
+ /**
288
+ * Create Auto Product Ads
289
+ * @param {CreateAutoProductAdsParams} params Request parameters
290
+ * @param {string} params.reference_id A random string used to prevent duplicate ads
291
+ * @param {number} params.budget The budget set for the Auto Product Ads
292
+ * @param {string} params.start_date Start date of the campaign (DD-MM-YYYY format)
293
+ * @param {string} [params.end_date] End date of the campaign (DD-MM-YYYY format). Leave empty for unlimited duration
294
+ * @returns {Promise<CreateAutoProductAdsResponse>} Response containing the created campaign ID
295
+ *
296
+ * This API is used to create Auto Product Ads. Auto Product Ads automatically promote
297
+ * products based on their performance and potential.
298
+ *
299
+ * Important notes:
300
+ * - reference_id prevents duplicate ad creation. If an ad is created successfully,
301
+ * subsequent requests using the same reference_id will fail
302
+ * - For unlimited campaign duration, pass today's date as start_date and leave end_date empty
303
+ */
304
+ createAutoProductAds(params: CreateAutoProductAdsParams): Promise<CreateAutoProductAdsResponse>;
305
+ /**
306
+ * Create a GMS product campaign
307
+ * @param {CreateGmsProductCampaignParams} params Request parameters
308
+ * @param {string} params.start_date Start date of Campaign (DD-MM-YYYY format). Cannot be earlier than today.
309
+ * @param {string} [params.end_date] End date of Campaign (DD-MM-YYYY format). Do not fill if no end date.
310
+ * @param {number} params.daily_budget Daily budget for Campaign
311
+ * @param {string} [params.reference_id] A random string used to prevent duplicate ads
312
+ * @param {number} [params.roas_target] ROAS target (0 or undefined for GMV Max Auto Bidding, >0 for Custom ROAS)
313
+ * @returns {Promise<CreateGmsProductCampaignResponse>} Response containing the created campaign ID
314
+ *
315
+ * This API is used to create a GMS (Gross Merchandise Sales) Campaign.
316
+ *
317
+ * ROAS Target behavior:
318
+ * - No input or 0: GMV Max Auto Bidding (Shop)
319
+ * - Greater than 0: GMV Max Custom ROAS (Shop)
320
+ * - Value is rounded to 1 decimal place (e.g., 10.123456 becomes 10.1)
321
+ */
322
+ createGmsProductCampaign(params: CreateGmsProductCampaignParams): Promise<CreateGmsProductCampaignResponse>;
323
+ /**
324
+ * Create Manual Selection Product Ads
325
+ * @param {CreateManualProductAdsParams} params Request parameters
326
+ * @param {string} params.reference_id A random string used to prevent duplicate ads
327
+ * @param {number} params.budget The budget set for the Manual Product Ads
328
+ * @param {string} params.start_date Start date of the campaign (DD-MM-YYYY format)
329
+ * @param {string} [params.end_date] End date of the campaign (DD-MM-YYYY format). Leave empty for unlimited duration
330
+ * @param {string} params.bidding_method Bidding method: "auto" or "manual"
331
+ * @param {number} params.item_id Product ID
332
+ * @param {number} [params.roas_target] ROAS target for campaigns with auto bidding. If 0, GMV Max / ROI feature is not enabled
333
+ * @param {Array} [params.selected_keywords] Selected keywords, required for manual bidding mode
334
+ * @param {Array} [params.discovery_ads_locations] Location settings for manual bidding method
335
+ * @param {boolean} [params.enhanced_cpc] Enhanced CPC functionality toggle
336
+ * @param {string} [params.smart_creative_setting] Smart Creative setting: "", "default", "on", or "off"
337
+ * @returns {Promise<CreateManualProductAdsResponse>} Response containing the created campaign ID
338
+ *
339
+ * This API is used to create Manual Selection Product Ads, which allow you to manually
340
+ * select products, keywords, and bidding strategies for your advertising campaigns.
341
+ *
342
+ * For manual bidding mode, you must specify selected_keywords and/or discovery_ads_locations.
343
+ * For auto bidding mode, you can set the roas_target parameter.
344
+ */
345
+ createManualProductAds(params: CreateManualProductAdsParams): Promise<CreateManualProductAdsResponse>;
346
+ /**
347
+ * Edit Auto Product Ads
348
+ * @param {EditAutoProductAdsParams} params Request parameters
349
+ * @param {string} params.reference_id A random string used to prevent duplicate ads
350
+ * @param {number} params.campaign_id The unique identifier for the campaign
351
+ * @param {string} params.edit_action The update action: "status", "budget", or "duration"
352
+ * @param {number} [params.budget] The budget set for the Auto Product Ads
353
+ * @param {string} [params.start_date] Start date of the campaign (DD-MM-YYYY format)
354
+ * @param {string} [params.end_date] End date of the campaign (DD-MM-YYYY format)
355
+ * @returns {Promise<EditAutoProductAdsResponse>} Response containing the campaign ID
356
+ *
357
+ * This API is used to edit existing Auto Product Ads.
358
+ * You can update the campaign status, budget, or duration based on the edit_action parameter.
359
+ */
360
+ editAutoProductAds(params: EditAutoProductAdsParams): Promise<EditAutoProductAdsResponse>;
361
+ /**
362
+ * Add/remove items to/from the GMS Campaign
363
+ * @param {EditGmsItemProductCampaignParams} params Request parameters
364
+ * @param {number} [params.campaign_id] The GMS Campaign ID
365
+ * @param {string} params.edit_action The action to perform: "add" or "remove"
366
+ * @param {number[]} params.item_id_list Item IDs to add/remove (minimum 1, maximum 30)
367
+ * @returns {Promise<EditGmsItemProductCampaignResponse>} Response containing the campaign ID
368
+ *
369
+ * This API is used to add or remove items from a GMS Campaign.
370
+ * You can add or remove between 1 and 30 items per request.
371
+ */
372
+ editGmsItemProductCampaign(params: EditGmsItemProductCampaignParams): Promise<EditGmsItemProductCampaignResponse>;
373
+ /**
374
+ * Edit a GMS product campaign
375
+ * @param {EditGmsProductCampaignParams} params Request parameters
376
+ * @param {number} params.campaign_id The GMS Campaign ID
377
+ * @param {string} params.edit_action The action to perform
378
+ * @param {number} [params.daily_budget] Daily budget for Campaign
379
+ * @param {string} [params.start_date] Start date of Campaign (DD-MM-YYYY format)
380
+ * @param {string} [params.end_date] End date of Campaign (DD-MM-YYYY format)
381
+ * @param {number} [params.roas_target] ROAS target for the campaign
382
+ * @returns {Promise<EditGmsProductCampaignResponse>} Response containing the campaign ID
383
+ *
384
+ * This API is used to edit existing GMS Campaign settings such as budget,
385
+ * campaign duration, and ROAS target.
386
+ */
387
+ editGmsProductCampaign(params: EditGmsProductCampaignParams): Promise<EditGmsProductCampaignResponse>;
388
+ /**
389
+ * Edit Manual Selection Product Ad Keywords
390
+ * @param {EditManualProductAdKeywordsParams} params Request parameters
391
+ * @param {string} params.reference_id A random string used to prevent duplicate ads
392
+ * @param {number} params.campaign_id The unique identifier for the campaign
393
+ * @param {string} params.edit_action The action to perform: "add", "edit", or "delete"
394
+ * @param {Array} [params.selected_keywords] Selected keywords to add, edit, or delete
395
+ * @returns {Promise<EditManualProductAdKeywordsResponse>} Response containing the campaign ID
396
+ *
397
+ * This API is used to edit keywords for Manual Selection Product Ads.
398
+ * You can add new keywords, edit existing keywords, or delete keywords.
399
+ */
400
+ editManualProductAdKeywords(params: EditManualProductAdKeywordsParams): Promise<EditManualProductAdKeywordsResponse>;
401
+ /**
402
+ * Edit Manual Selection Product Ads
403
+ * @param {EditManualProductAdsParams} params Request parameters
404
+ * @param {string} params.reference_id A random string used to prevent duplicate ads
405
+ * @param {number} params.campaign_id The unique identifier for the campaign
406
+ * @param {string} params.edit_action The update action
407
+ * @param {number} [params.budget] The budget set for the Manual Product Ads
408
+ * @param {string} [params.start_date] Start date of the campaign (DD-MM-YYYY format)
409
+ * @param {string} [params.end_date] End date of the campaign (DD-MM-YYYY format)
410
+ * @param {number} [params.roas_target] ROAS target for campaigns with auto bidding
411
+ * @param {Array} [params.discovery_ads_locations] Location settings for manual bidding method
412
+ * @param {boolean} [params.enhanced_cpc] Enhanced CPC functionality toggle
413
+ * @param {string} [params.smart_creative_setting] Smart Creative setting
414
+ * @returns {Promise<EditManualProductAdsResponse>} Response containing the campaign ID
415
+ *
416
+ * This API is used to edit existing Manual Selection Product Ads.
417
+ * You can update various campaign settings including budget, duration, bidding settings,
418
+ * and ad placement locations.
419
+ */
420
+ editManualProductAds(params: EditManualProductAdsParams): Promise<EditManualProductAdsResponse>;
421
+ /**
422
+ * Get shop rate for Ads Facil Program
423
+ * @returns {Promise<GetAdsFacilShopRateResponse>} Response containing the shop rate
424
+ *
425
+ * This API is used to get the shop rate for the Ads Facil Program,
426
+ * which is a special advertising program available in certain regions.
427
+ */
428
+ getAdsFacilShopRate(): Promise<GetAdsFacilShopRateResponse>;
429
+ /**
430
+ * Get budget suggestion for product ads creation
431
+ * @param {GetCreateProductAdBudgetSuggestionParams} params Request parameters
432
+ * @param {string} params.reference_id A random string used to prevent duplicate ads
433
+ * @param {string} params.product_selection Product selection: "auto" or "manual"
434
+ * @param {string} params.campaign_placement Campaign placement: "search", "discovery", or "all"
435
+ * @param {string} params.bidding_method Bidding method: "auto" or "manual"
436
+ * @param {string} [params.enhanced_cpc] Enhanced CPC toggle: "true" or "false"
437
+ * @param {string} [params.discovery_ads_location_names] Comma-separated location values
438
+ * @param {number} [params.roas_target] ROAS target for campaigns with auto bidding
439
+ * @param {number} [params.item_id] Product ID (mandatory for manual product selection)
440
+ * @returns {Promise<GetCreateProductAdBudgetSuggestionResponse>} Response containing budget suggestions
441
+ *
442
+ * This API is used to get budget suggestions before creating product ads.
443
+ * The suggestions include minimum, maximum, and recommended budget values
444
+ * based on the campaign parameters.
445
+ */
446
+ getCreateProductAdBudgetSuggestion(params: GetCreateProductAdBudgetSuggestionParams): Promise<GetCreateProductAdBudgetSuggestionResponse>;
447
+ /**
448
+ * Get GMS Campaign performance
449
+ * @param {GetGmsCampaignPerformanceParams} params Request parameters
450
+ * @param {number} [params.campaign_id] The GMS Campaign ID
451
+ * @param {string} params.start_date Start date (DD-MM-YYYY format). Maximum 3 months duration, earliest 6 months ago
452
+ * @param {string} params.end_date End date (DD-MM-YYYY format). Maximum 3 months duration
453
+ * @returns {Promise<GetGmsCampaignPerformanceResponse>} Response containing campaign performance data
454
+ *
455
+ * This API is used to get performance data for a GMS Campaign.
456
+ * The date range can span up to 3 months and go back up to 6 months from today.
457
+ *
458
+ * Performance metrics include impressions, clicks, CTR, expense, GMV, ROAS, and orders.
459
+ */
460
+ getGmsCampaignPerformance(params: GetGmsCampaignPerformanceParams): Promise<GetGmsCampaignPerformanceResponse>;
461
+ /**
462
+ * Get GMS Item performance
463
+ * @param {GetGmsItemPerformanceParams} params Request parameters
464
+ * @param {number} [params.campaign_id] The GMS Campaign ID
465
+ * @param {string} params.start_date Start date (DD-MM-YYYY format). Maximum 3 months duration, earliest 6 months ago
466
+ * @param {string} params.end_date End date (DD-MM-YYYY format). Maximum 3 months duration
467
+ * @param {number} [params.offset] Pagination offset (default: 0)
468
+ * @param {number} [params.limit] Maximum number of records to show (default: 50, max: 100)
469
+ * @returns {Promise<GetGmsItemPerformanceResponse>} Response containing item performance data
470
+ *
471
+ * This API is used to get performance data for items in a GMS Campaign.
472
+ * The response is sorted by item_id and only items with performance data are returned.
473
+ *
474
+ * The date range can span up to 3 months and go back up to 6 months from today.
475
+ * Results are paginated with offset and limit parameters.
476
+ */
477
+ getGmsItemPerformance(params: GetGmsItemPerformanceParams): Promise<GetGmsItemPerformanceResponse>;
478
+ /**
479
+ * List GMS items that have been removed from the Campaign by seller
480
+ * @param {ListGmsUserDeletedItemParams} [params] Request parameters
481
+ * @param {number} [params.offset] Pagination offset (default: 0)
482
+ * @param {number} [params.limit] Maximum number of records to show (default: 50, max: 100)
483
+ * @returns {Promise<ListGmsUserDeletedItemResponse>} Response containing deleted item IDs
484
+ *
485
+ * This API is used to list items that have been removed from a GMS Campaign by the seller.
486
+ * Results are paginated with offset and limit parameters.
487
+ */
488
+ listGmsUserDeletedItem(params?: ListGmsUserDeletedItemParams): Promise<ListGmsUserDeletedItemResponse>;
273
489
  }