ebay-api 8.4.1 → 8.5.1

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 (394) hide show
  1. package/README.md +3 -3
  2. package/dist/api/apiFactory.d.ts +27 -27
  3. package/dist/api/apiFactory.js +94 -94
  4. package/dist/api/base.d.ts +10 -10
  5. package/dist/api/base.js +10 -10
  6. package/dist/api/digitalSignature.d.ts +43 -43
  7. package/dist/api/digitalSignature.js +105 -105
  8. package/dist/api/index.d.ts +13 -13
  9. package/dist/api/index.js +29 -29
  10. package/dist/api/restful/buy/browse/index.d.ts +84 -84
  11. package/dist/api/restful/buy/browse/index.js +132 -135
  12. package/dist/api/restful/buy/deal/index.d.ts +56 -55
  13. package/dist/api/restful/buy/deal/index.js +74 -73
  14. package/dist/api/restful/buy/feed/index.d.ts +44 -43
  15. package/dist/api/restful/buy/feed/index.js +79 -78
  16. package/dist/api/restful/buy/index.d.ts +17 -17
  17. package/dist/api/restful/buy/index.js +8 -8
  18. package/dist/api/restful/buy/marketing/index.d.ts +28 -27
  19. package/dist/api/restful/buy/marketing/index.js +45 -44
  20. package/dist/api/restful/buy/marketplaceInsights/index.d.ts +29 -28
  21. package/dist/api/restful/buy/marketplaceInsights/index.js +45 -44
  22. package/dist/api/restful/buy/offer/index.d.ts +24 -23
  23. package/dist/api/restful/buy/offer/index.js +31 -30
  24. package/dist/api/restful/buy/order/index.d.ts +265 -264
  25. package/dist/api/restful/buy/order/index.js +363 -362
  26. package/dist/api/restful/commerce/catalog/index.d.ts +74 -73
  27. package/dist/api/restful/commerce/catalog/index.js +100 -101
  28. package/dist/api/restful/commerce/charity/index.d.ts +35 -34
  29. package/dist/api/restful/commerce/charity/index.js +50 -49
  30. package/dist/api/restful/commerce/identity/index.d.ts +15 -14
  31. package/dist/api/restful/commerce/identity/index.js +21 -20
  32. package/dist/api/restful/commerce/index.d.ts +15 -15
  33. package/dist/api/restful/commerce/index.js +7 -7
  34. package/dist/api/restful/commerce/notification/index.d.ts +118 -117
  35. package/dist/api/restful/commerce/notification/index.js +181 -180
  36. package/dist/api/restful/commerce/taxonomy/index.d.ts +79 -78
  37. package/dist/api/restful/commerce/taxonomy/index.js +129 -128
  38. package/dist/api/restful/commerce/translation/index.d.ts +16 -15
  39. package/dist/api/restful/commerce/translation/index.js +19 -18
  40. package/dist/api/restful/developer/analytics/index.d.ts +23 -22
  41. package/dist/api/restful/developer/analytics/index.js +39 -38
  42. package/dist/api/restful/developer/index.d.ts +7 -7
  43. package/dist/api/restful/developer/index.js +3 -3
  44. package/dist/api/restful/developer/keyManagement/index.d.ts +25 -24
  45. package/dist/api/restful/developer/keyManagement/index.js +37 -36
  46. package/dist/api/restful/index.d.ts +70 -67
  47. package/dist/api/restful/index.js +180 -180
  48. package/dist/api/restful/postOrder/cancellation/index.d.ts +57 -57
  49. package/dist/api/restful/postOrder/cancellation/index.js +89 -88
  50. package/dist/api/restful/postOrder/case/index.d.ts +63 -63
  51. package/dist/api/restful/postOrder/case/index.js +89 -88
  52. package/dist/api/restful/postOrder/index.d.ts +11 -11
  53. package/dist/api/restful/postOrder/index.js +5 -5
  54. package/dist/api/restful/postOrder/inquiry/index.d.ts +82 -82
  55. package/dist/api/restful/postOrder/inquiry/index.js +125 -124
  56. package/dist/api/restful/postOrder/return/index.d.ts +231 -231
  57. package/dist/api/restful/postOrder/return/index.js +355 -354
  58. package/dist/api/restful/sell/account/index.d.ts +299 -298
  59. package/dist/api/restful/sell/account/index.js +461 -460
  60. package/dist/api/restful/sell/analytics/index.d.ts +42 -41
  61. package/dist/api/restful/sell/analytics/index.js +55 -54
  62. package/dist/api/restful/sell/compliance/index.d.ts +38 -37
  63. package/dist/api/restful/sell/compliance/index.js +51 -50
  64. package/dist/api/restful/sell/feed/index.d.ts +172 -171
  65. package/dist/api/restful/sell/feed/index.js +278 -277
  66. package/dist/api/restful/sell/finances/index.d.ts +79 -78
  67. package/dist/api/restful/sell/finances/index.js +103 -102
  68. package/dist/api/restful/sell/fulfillment/index.d.ts +138 -137
  69. package/dist/api/restful/sell/fulfillment/index.js +193 -192
  70. package/dist/api/restful/sell/index.d.ts +29 -29
  71. package/dist/api/restful/sell/index.js +14 -14
  72. package/dist/api/restful/sell/inventory/index.d.ts +249 -248
  73. package/dist/api/restful/sell/inventory/index.js +340 -339
  74. package/dist/api/restful/sell/listing/index.d.ts +15 -14
  75. package/dist/api/restful/sell/listing/index.js +19 -18
  76. package/dist/api/restful/sell/logistics/index.d.ts +45 -44
  77. package/dist/api/restful/sell/logistics/index.js +60 -59
  78. package/dist/api/restful/sell/marketing/index.d.ts +627 -626
  79. package/dist/api/restful/sell/marketing/index.js +863 -862
  80. package/dist/api/restful/sell/metadata/index.d.ts +78 -77
  81. package/dist/api/restful/sell/metadata/index.js +125 -124
  82. package/dist/api/restful/sell/negotiation/index.d.ts +25 -24
  83. package/dist/api/restful/sell/negotiation/index.js +33 -32
  84. package/dist/api/restful/sell/recommendation/index.d.ts +27 -26
  85. package/dist/api/restful/sell/recommendation/index.js +33 -32
  86. package/dist/api/traditional/XMLRequest.d.ts +109 -109
  87. package/dist/api/traditional/XMLRequest.js +176 -175
  88. package/dist/api/traditional/clientAlerts/index.d.ts +9 -9
  89. package/dist/api/traditional/clientAlerts/index.js +11 -11
  90. package/dist/api/traditional/clientAlerts/types.d.ts +31 -31
  91. package/dist/api/traditional/clientAlerts/types.js +32 -32
  92. package/dist/api/traditional/fields.d.ts +1948 -1948
  93. package/dist/api/traditional/fields.js +1946 -1946
  94. package/dist/api/traditional/finding/index.d.ts +12 -12
  95. package/dist/api/traditional/finding/index.js +13 -13
  96. package/dist/api/traditional/index.d.ts +17 -17
  97. package/dist/api/traditional/index.js +191 -191
  98. package/dist/api/traditional/merchandising/index.d.ts +7 -7
  99. package/dist/api/traditional/merchandising/index.js +8 -8
  100. package/dist/api/traditional/shopping/index.d.ts +11 -11
  101. package/dist/api/traditional/shopping/index.js +13 -13
  102. package/dist/api/traditional/trading/index.d.ts +142 -142
  103. package/dist/api/traditional/trading/index.js +143 -143
  104. package/dist/auth/authNAuth.d.ts +49 -49
  105. package/dist/auth/authNAuth.js +117 -116
  106. package/dist/auth/index.d.ts +17 -17
  107. package/dist/auth/index.js +25 -25
  108. package/dist/auth/oAuth2.d.ts +95 -95
  109. package/dist/auth/oAuth2.js +260 -259
  110. package/dist/eBayApi.d.ts +59 -59
  111. package/dist/eBayApi.js +105 -104
  112. package/dist/ebay-api.min.mjs +1 -1
  113. package/dist/enums/apiEnums.d.ts +49 -49
  114. package/dist/enums/apiEnums.js +51 -51
  115. package/dist/enums/index.d.ts +2 -2
  116. package/dist/enums/index.js +2 -2
  117. package/dist/enums/restfulEnums.d.ts +976 -970
  118. package/dist/enums/restfulEnums.js +1019 -1013
  119. package/dist/errors/index.d.ts +66 -66
  120. package/dist/errors/index.js +190 -189
  121. package/dist/nanoevents.d.ts +6 -6
  122. package/dist/nanoevents.js +20 -20
  123. package/dist/request.d.ts +26 -26
  124. package/dist/request.js +43 -43
  125. package/dist/types/apiTypes.d.ts +40 -40
  126. package/dist/types/apiTypes.js +1 -1
  127. package/dist/types/index.d.ts +3 -3
  128. package/dist/types/index.js +3 -3
  129. package/dist/types/restful/specs/buy_browse_v1_oas3.d.ts +1531 -0
  130. package/dist/types/restful/specs/buy_browse_v1_oas3.js +5 -0
  131. package/dist/types/restful/specs/buy_deal_v1_oas3.d.ts +434 -0
  132. package/dist/types/restful/specs/buy_deal_v1_oas3.js +5 -0
  133. package/dist/types/restful/specs/buy_feed_v1_beta_oas3.d.ts +561 -0
  134. package/dist/types/restful/specs/buy_feed_v1_beta_oas3.js +5 -0
  135. package/dist/types/restful/specs/buy_marketing_v1_beta_oas3.d.ts +288 -0
  136. package/dist/types/restful/specs/buy_marketing_v1_beta_oas3.js +5 -0
  137. package/dist/types/restful/specs/buy_marketplace_insights_v1_beta_oas3.d.ts +304 -0
  138. package/dist/types/restful/specs/buy_marketplace_insights_v1_beta_oas3.js +5 -0
  139. package/dist/types/restful/specs/buy_offer_v1_beta_oas3.d.ts +173 -0
  140. package/dist/types/restful/specs/buy_offer_v1_beta_oas3.js +5 -0
  141. package/dist/types/restful/specs/buy_order_v1_beta_oas3.d.ts +1701 -0
  142. package/dist/types/restful/specs/buy_order_v1_beta_oas3.js +5 -0
  143. package/dist/types/restful/specs/cancellation_oas3.d.ts +112 -0
  144. package/dist/types/restful/specs/cancellation_oas3.js +5 -0
  145. package/dist/types/restful/specs/case_oas3.d.ts +124 -0
  146. package/dist/types/restful/specs/case_oas3.js +5 -0
  147. package/dist/types/restful/specs/commerce_catalog_v1_beta_oas3.d.ts +758 -0
  148. package/dist/types/restful/specs/commerce_catalog_v1_beta_oas3.js +5 -0
  149. package/dist/types/restful/specs/commerce_charity_v1_oas3.d.ts +224 -0
  150. package/dist/types/restful/specs/commerce_charity_v1_oas3.js +5 -0
  151. package/dist/types/restful/specs/commerce_identity_v1_oas3.d.ts +152 -0
  152. package/dist/types/restful/specs/commerce_identity_v1_oas3.js +5 -0
  153. package/dist/types/restful/specs/commerce_notification_v1_oas3.d.ts +677 -0
  154. package/dist/types/restful/specs/commerce_notification_v1_oas3.js +5 -0
  155. package/dist/types/restful/specs/commerce_taxonomy_v1_oas3.d.ts +530 -0
  156. package/dist/types/restful/specs/commerce_taxonomy_v1_oas3.js +5 -0
  157. package/dist/types/restful/specs/commerce_translation_v1_beta_oas3.d.ts +100 -0
  158. package/dist/types/restful/specs/commerce_translation_v1_beta_oas3.js +5 -0
  159. package/dist/types/restful/specs/developer_analytics_v1_beta_oas3.d.ts +158 -0
  160. package/dist/types/restful/specs/developer_analytics_v1_beta_oas3.js +5 -0
  161. package/dist/types/restful/specs/developer_key_management_v1_oas3.d.ts +162 -0
  162. package/dist/types/restful/specs/developer_key_management_v1_oas3.js +5 -0
  163. package/dist/types/restful/specs/inquiry_oas3.d.ts +180 -0
  164. package/dist/types/restful/specs/inquiry_oas3.js +5 -0
  165. package/dist/types/restful/specs/return_oas3.d.ts +528 -0
  166. package/dist/types/restful/specs/return_oas3.js +5 -0
  167. package/dist/types/restful/specs/sell_account_v1_oas3.d.ts +2061 -0
  168. package/dist/types/restful/specs/sell_account_v1_oas3.js +5 -0
  169. package/dist/types/restful/specs/sell_analytics_v1_oas3.d.ts +340 -0
  170. package/dist/types/restful/specs/sell_analytics_v1_oas3.js +5 -0
  171. package/dist/types/restful/specs/sell_compliance_v1_oas3.d.ts +253 -0
  172. package/dist/types/restful/specs/sell_compliance_v1_oas3.js +5 -0
  173. package/dist/types/restful/specs/sell_feed_v1_oas3.d.ts +1191 -0
  174. package/dist/types/restful/specs/sell_feed_v1_oas3.js +5 -0
  175. package/dist/types/restful/specs/sell_finances_v1_oas3.d.ts +572 -0
  176. package/dist/types/restful/specs/sell_finances_v1_oas3.js +5 -0
  177. package/dist/types/restful/specs/sell_fulfillment_v1_oas3.d.ts +1386 -0
  178. package/dist/types/restful/specs/sell_fulfillment_v1_oas3.js +5 -0
  179. package/dist/types/restful/specs/sell_inventory_v1_oas3.d.ts +2175 -0
  180. package/dist/types/restful/specs/sell_inventory_v1_oas3.js +5 -0
  181. package/dist/types/restful/specs/sell_listing_v1_beta_oas3.d.ts +150 -0
  182. package/dist/types/restful/specs/sell_listing_v1_beta_oas3.js +5 -0
  183. package/dist/types/restful/specs/sell_logistics_v1_oas3.d.ts +451 -0
  184. package/dist/types/restful/specs/sell_logistics_v1_oas3.js +5 -0
  185. package/dist/types/restful/specs/sell_marketing_v1_oas3.d.ts +3728 -0
  186. package/dist/types/restful/specs/sell_marketing_v1_oas3.js +5 -0
  187. package/dist/types/restful/specs/sell_metadata_v1_oas3.d.ts +429 -0
  188. package/dist/types/restful/specs/sell_metadata_v1_oas3.js +5 -0
  189. package/dist/types/restful/specs/sell_negotiation_v1_oas3.d.ts +225 -0
  190. package/dist/types/restful/specs/sell_negotiation_v1_oas3.js +5 -0
  191. package/dist/types/restful/specs/sell_recommendation_v1_oas3.d.ts +148 -0
  192. package/dist/types/restful/specs/sell_recommendation_v1_oas3.js +5 -0
  193. package/dist/types/restfulTypes.d.ts +439 -1179
  194. package/dist/types/restfulTypes.js +1 -1
  195. package/dist/types/traditonalTypes.d.ts +35 -35
  196. package/dist/types/traditonalTypes.js +1 -1
  197. package/lib/api/apiFactory.d.ts +27 -27
  198. package/lib/api/apiFactory.js +100 -100
  199. package/lib/api/base.d.ts +10 -10
  200. package/lib/api/base.js +13 -13
  201. package/lib/api/digitalSignature.d.ts +43 -43
  202. package/lib/api/digitalSignature.js +112 -112
  203. package/lib/api/index.d.ts +13 -13
  204. package/lib/api/index.js +35 -35
  205. package/lib/api/restful/buy/browse/index.d.ts +84 -84
  206. package/lib/api/restful/buy/browse/index.js +137 -141
  207. package/lib/api/restful/buy/deal/index.d.ts +56 -55
  208. package/lib/api/restful/buy/deal/index.js +79 -79
  209. package/lib/api/restful/buy/feed/index.d.ts +44 -43
  210. package/lib/api/restful/buy/feed/index.js +84 -84
  211. package/lib/api/restful/buy/index.d.ts +17 -17
  212. package/lib/api/restful/buy/index.js +20 -20
  213. package/lib/api/restful/buy/marketing/index.d.ts +28 -27
  214. package/lib/api/restful/buy/marketing/index.js +50 -50
  215. package/lib/api/restful/buy/marketplaceInsights/index.d.ts +29 -28
  216. package/lib/api/restful/buy/marketplaceInsights/index.js +50 -50
  217. package/lib/api/restful/buy/offer/index.d.ts +24 -23
  218. package/lib/api/restful/buy/offer/index.js +36 -36
  219. package/lib/api/restful/buy/order/index.d.ts +265 -264
  220. package/lib/api/restful/buy/order/index.js +368 -368
  221. package/lib/api/restful/commerce/catalog/index.d.ts +74 -73
  222. package/lib/api/restful/commerce/catalog/index.js +105 -107
  223. package/lib/api/restful/commerce/charity/index.d.ts +35 -34
  224. package/lib/api/restful/commerce/charity/index.js +55 -55
  225. package/lib/api/restful/commerce/identity/index.d.ts +15 -14
  226. package/lib/api/restful/commerce/identity/index.js +26 -26
  227. package/lib/api/restful/commerce/index.d.ts +15 -15
  228. package/lib/api/restful/commerce/index.js +18 -18
  229. package/lib/api/restful/commerce/notification/index.d.ts +118 -117
  230. package/lib/api/restful/commerce/notification/index.js +186 -186
  231. package/lib/api/restful/commerce/taxonomy/index.d.ts +79 -78
  232. package/lib/api/restful/commerce/taxonomy/index.js +134 -134
  233. package/lib/api/restful/commerce/translation/index.d.ts +16 -15
  234. package/lib/api/restful/commerce/translation/index.js +24 -24
  235. package/lib/api/restful/developer/analytics/index.d.ts +23 -22
  236. package/lib/api/restful/developer/analytics/index.js +44 -44
  237. package/lib/api/restful/developer/index.d.ts +7 -7
  238. package/lib/api/restful/developer/index.js +10 -10
  239. package/lib/api/restful/developer/keyManagement/index.d.ts +25 -24
  240. package/lib/api/restful/developer/keyManagement/index.js +42 -42
  241. package/lib/api/restful/index.d.ts +70 -67
  242. package/lib/api/restful/index.js +187 -187
  243. package/lib/api/restful/postOrder/cancellation/index.d.ts +57 -57
  244. package/lib/api/restful/postOrder/cancellation/index.js +94 -94
  245. package/lib/api/restful/postOrder/case/index.d.ts +63 -63
  246. package/lib/api/restful/postOrder/case/index.js +94 -94
  247. package/lib/api/restful/postOrder/index.d.ts +11 -11
  248. package/lib/api/restful/postOrder/index.js +14 -14
  249. package/lib/api/restful/postOrder/inquiry/index.d.ts +82 -82
  250. package/lib/api/restful/postOrder/inquiry/index.js +130 -130
  251. package/lib/api/restful/postOrder/return/index.d.ts +231 -231
  252. package/lib/api/restful/postOrder/return/index.js +360 -360
  253. package/lib/api/restful/sell/account/index.d.ts +299 -298
  254. package/lib/api/restful/sell/account/index.js +466 -466
  255. package/lib/api/restful/sell/analytics/index.d.ts +42 -41
  256. package/lib/api/restful/sell/analytics/index.js +60 -60
  257. package/lib/api/restful/sell/compliance/index.d.ts +38 -37
  258. package/lib/api/restful/sell/compliance/index.js +56 -56
  259. package/lib/api/restful/sell/feed/index.d.ts +172 -171
  260. package/lib/api/restful/sell/feed/index.js +283 -283
  261. package/lib/api/restful/sell/finances/index.d.ts +79 -78
  262. package/lib/api/restful/sell/finances/index.js +108 -108
  263. package/lib/api/restful/sell/fulfillment/index.d.ts +138 -137
  264. package/lib/api/restful/sell/fulfillment/index.js +198 -198
  265. package/lib/api/restful/sell/index.d.ts +29 -29
  266. package/lib/api/restful/sell/index.js +32 -32
  267. package/lib/api/restful/sell/inventory/index.d.ts +249 -248
  268. package/lib/api/restful/sell/inventory/index.js +345 -345
  269. package/lib/api/restful/sell/listing/index.d.ts +15 -14
  270. package/lib/api/restful/sell/listing/index.js +24 -24
  271. package/lib/api/restful/sell/logistics/index.d.ts +45 -44
  272. package/lib/api/restful/sell/logistics/index.js +65 -65
  273. package/lib/api/restful/sell/marketing/index.d.ts +627 -626
  274. package/lib/api/restful/sell/marketing/index.js +868 -868
  275. package/lib/api/restful/sell/metadata/index.d.ts +78 -77
  276. package/lib/api/restful/sell/metadata/index.js +130 -130
  277. package/lib/api/restful/sell/negotiation/index.d.ts +25 -24
  278. package/lib/api/restful/sell/negotiation/index.js +38 -38
  279. package/lib/api/restful/sell/recommendation/index.d.ts +27 -26
  280. package/lib/api/restful/sell/recommendation/index.js +38 -38
  281. package/lib/api/traditional/XMLRequest.d.ts +109 -109
  282. package/lib/api/traditional/XMLRequest.js +182 -182
  283. package/lib/api/traditional/clientAlerts/index.d.ts +9 -9
  284. package/lib/api/traditional/clientAlerts/index.js +14 -14
  285. package/lib/api/traditional/clientAlerts/types.d.ts +31 -31
  286. package/lib/api/traditional/clientAlerts/types.js +34 -35
  287. package/lib/api/traditional/fields.d.ts +1948 -1948
  288. package/lib/api/traditional/fields.js +1948 -1948
  289. package/lib/api/traditional/finding/index.d.ts +12 -12
  290. package/lib/api/traditional/finding/index.js +15 -15
  291. package/lib/api/traditional/index.d.ts +17 -17
  292. package/lib/api/traditional/index.js +220 -220
  293. package/lib/api/traditional/merchandising/index.d.ts +7 -7
  294. package/lib/api/traditional/merchandising/index.js +10 -10
  295. package/lib/api/traditional/shopping/index.d.ts +11 -11
  296. package/lib/api/traditional/shopping/index.js +15 -15
  297. package/lib/api/traditional/trading/index.d.ts +142 -142
  298. package/lib/api/traditional/trading/index.js +145 -145
  299. package/lib/auth/authNAuth.d.ts +49 -49
  300. package/lib/auth/authNAuth.js +122 -122
  301. package/lib/auth/index.d.ts +17 -17
  302. package/lib/auth/index.js +31 -31
  303. package/lib/auth/oAuth2.d.ts +95 -95
  304. package/lib/auth/oAuth2.js +265 -265
  305. package/lib/eBayApi.d.ts +59 -59
  306. package/lib/eBayApi.js +141 -141
  307. package/lib/ebay-api.min.js +1 -1
  308. package/lib/enums/apiEnums.d.ts +49 -49
  309. package/lib/enums/apiEnums.js +54 -54
  310. package/lib/enums/index.d.ts +2 -2
  311. package/lib/enums/index.js +18 -18
  312. package/lib/enums/restfulEnums.d.ts +976 -970
  313. package/lib/enums/restfulEnums.js +1021 -1016
  314. package/lib/errors/index.d.ts +66 -66
  315. package/lib/errors/index.js +213 -212
  316. package/lib/index.d.ts +2 -2
  317. package/lib/index.js +6 -6
  318. package/lib/nanoevents.d.ts +6 -6
  319. package/lib/nanoevents.js +24 -24
  320. package/lib/request.d.ts +26 -26
  321. package/lib/request.js +50 -50
  322. package/lib/types/apiTypes.d.ts +40 -40
  323. package/lib/types/apiTypes.js +2 -2
  324. package/lib/types/index.d.ts +3 -3
  325. package/lib/types/index.js +19 -19
  326. package/lib/types/restful/specs/buy_browse_v1_oas3.d.ts +1531 -0
  327. package/lib/types/restful/specs/buy_browse_v1_oas3.js +6 -0
  328. package/lib/types/restful/specs/buy_deal_v1_oas3.d.ts +434 -0
  329. package/lib/types/restful/specs/buy_deal_v1_oas3.js +6 -0
  330. package/lib/types/restful/specs/buy_feed_v1_beta_oas3.d.ts +561 -0
  331. package/lib/types/restful/specs/buy_feed_v1_beta_oas3.js +6 -0
  332. package/lib/types/restful/specs/buy_marketing_v1_beta_oas3.d.ts +288 -0
  333. package/lib/types/restful/specs/buy_marketing_v1_beta_oas3.js +6 -0
  334. package/lib/types/restful/specs/buy_marketplace_insights_v1_beta_oas3.d.ts +304 -0
  335. package/lib/types/restful/specs/buy_marketplace_insights_v1_beta_oas3.js +6 -0
  336. package/lib/types/restful/specs/buy_offer_v1_beta_oas3.d.ts +173 -0
  337. package/lib/types/restful/specs/buy_offer_v1_beta_oas3.js +6 -0
  338. package/lib/types/restful/specs/buy_order_v1_beta_oas3.d.ts +1701 -0
  339. package/lib/types/restful/specs/buy_order_v1_beta_oas3.js +6 -0
  340. package/lib/types/restful/specs/cancellation_oas3.d.ts +112 -0
  341. package/lib/types/restful/specs/cancellation_oas3.js +6 -0
  342. package/lib/types/restful/specs/case_oas3.d.ts +124 -0
  343. package/lib/types/restful/specs/case_oas3.js +6 -0
  344. package/lib/types/restful/specs/commerce_catalog_v1_beta_oas3.d.ts +758 -0
  345. package/lib/types/restful/specs/commerce_catalog_v1_beta_oas3.js +6 -0
  346. package/lib/types/restful/specs/commerce_charity_v1_oas3.d.ts +224 -0
  347. package/lib/types/restful/specs/commerce_charity_v1_oas3.js +6 -0
  348. package/lib/types/restful/specs/commerce_identity_v1_oas3.d.ts +152 -0
  349. package/lib/types/restful/specs/commerce_identity_v1_oas3.js +6 -0
  350. package/lib/types/restful/specs/commerce_notification_v1_oas3.d.ts +677 -0
  351. package/lib/types/restful/specs/commerce_notification_v1_oas3.js +6 -0
  352. package/lib/types/restful/specs/commerce_taxonomy_v1_oas3.d.ts +530 -0
  353. package/lib/types/restful/specs/commerce_taxonomy_v1_oas3.js +6 -0
  354. package/lib/types/restful/specs/commerce_translation_v1_beta_oas3.d.ts +100 -0
  355. package/lib/types/restful/specs/commerce_translation_v1_beta_oas3.js +6 -0
  356. package/lib/types/restful/specs/developer_analytics_v1_beta_oas3.d.ts +158 -0
  357. package/lib/types/restful/specs/developer_analytics_v1_beta_oas3.js +6 -0
  358. package/lib/types/restful/specs/developer_key_management_v1_oas3.d.ts +162 -0
  359. package/lib/types/restful/specs/developer_key_management_v1_oas3.js +6 -0
  360. package/lib/types/restful/specs/inquiry_oas3.d.ts +180 -0
  361. package/lib/types/restful/specs/inquiry_oas3.js +6 -0
  362. package/lib/types/restful/specs/return_oas3.d.ts +528 -0
  363. package/lib/types/restful/specs/return_oas3.js +6 -0
  364. package/lib/types/restful/specs/sell_account_v1_oas3.d.ts +2061 -0
  365. package/lib/types/restful/specs/sell_account_v1_oas3.js +6 -0
  366. package/lib/types/restful/specs/sell_analytics_v1_oas3.d.ts +340 -0
  367. package/lib/types/restful/specs/sell_analytics_v1_oas3.js +6 -0
  368. package/lib/types/restful/specs/sell_compliance_v1_oas3.d.ts +253 -0
  369. package/lib/types/restful/specs/sell_compliance_v1_oas3.js +6 -0
  370. package/lib/types/restful/specs/sell_feed_v1_oas3.d.ts +1191 -0
  371. package/lib/types/restful/specs/sell_feed_v1_oas3.js +6 -0
  372. package/lib/types/restful/specs/sell_finances_v1_oas3.d.ts +572 -0
  373. package/lib/types/restful/specs/sell_finances_v1_oas3.js +6 -0
  374. package/lib/types/restful/specs/sell_fulfillment_v1_oas3.d.ts +1386 -0
  375. package/lib/types/restful/specs/sell_fulfillment_v1_oas3.js +6 -0
  376. package/lib/types/restful/specs/sell_inventory_v1_oas3.d.ts +2175 -0
  377. package/lib/types/restful/specs/sell_inventory_v1_oas3.js +6 -0
  378. package/lib/types/restful/specs/sell_listing_v1_beta_oas3.d.ts +150 -0
  379. package/lib/types/restful/specs/sell_listing_v1_beta_oas3.js +6 -0
  380. package/lib/types/restful/specs/sell_logistics_v1_oas3.d.ts +451 -0
  381. package/lib/types/restful/specs/sell_logistics_v1_oas3.js +6 -0
  382. package/lib/types/restful/specs/sell_marketing_v1_oas3.d.ts +3728 -0
  383. package/lib/types/restful/specs/sell_marketing_v1_oas3.js +6 -0
  384. package/lib/types/restful/specs/sell_metadata_v1_oas3.d.ts +429 -0
  385. package/lib/types/restful/specs/sell_metadata_v1_oas3.js +6 -0
  386. package/lib/types/restful/specs/sell_negotiation_v1_oas3.d.ts +225 -0
  387. package/lib/types/restful/specs/sell_negotiation_v1_oas3.js +6 -0
  388. package/lib/types/restful/specs/sell_recommendation_v1_oas3.d.ts +148 -0
  389. package/lib/types/restful/specs/sell_recommendation_v1_oas3.js +6 -0
  390. package/lib/types/restfulTypes.d.ts +439 -1179
  391. package/lib/types/restfulTypes.js +2 -2
  392. package/lib/types/traditonalTypes.d.ts +35 -35
  393. package/lib/types/traditonalTypes.js +2 -2
  394. package/package.json +6 -4
@@ -1,862 +1,863 @@
1
- import Restful from '../../index.js';
2
- /**
3
- * <p>The <i>Marketing API </i> offers two platforms that sellers can use to promote and advertise their products:
4
- * </p> <ul><li><b>Promoted Listings</b> is an eBay ad service that lets sellers set up <i>ad campaigns </i>
5
- * for the products they want to promote. eBay displays the ads in search results and in other
6
- * marketing modules as <b>SPONSORED</b> listings.
7
- */
8
- export default class Marketing extends Restful {
9
- get basePath() {
10
- return '/sell/marketing/v1';
11
- }
12
- /**
13
- * This method creates an ad for each inventory reference ID specified in the request and associates the newly
14
- * created ads with the specified campaign.
15
- *
16
- * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created.
17
- * @param body This type defines the fields for the bulkCreateAdsByInventoryReference request.
18
- */
19
- bulkCreateAdsByInventoryReference(campaignId, body) {
20
- campaignId = encodeURIComponent(campaignId);
21
- return this.post(`/ad_campaign/${campaignId}/bulk_create_ads_by_inventory_reference`, body);
22
- }
23
- /**
24
- * This method creates an ad for each listing ID specified in the request and associates the newly created ads with
25
- * the specified campaign.
26
- *
27
- * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
28
- * a seller's campaign IDs by calling getCampaigns.
29
- * @param body The container for the bulk request to create ads for eBay listing IDs. eBay listing IDs are
30
- * generated when the listing is created on eBay.
31
- */
32
- bulkCreateAdsByListingId(campaignId, body) {
33
- campaignId = encodeURIComponent(campaignId);
34
- return this.post(`/ad_campaign/${campaignId}/bulk_create_ads_by_listing_id`, body);
35
- }
36
- /**
37
- * This method deletes a set of ads, as specified by a list of inventory reference IDs, from the specified
38
- * campaign.
39
- *
40
- * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
41
- * a seller's campaign IDs by calling getCampaigns.
42
- * @param body This type defines the fields for a bulkDeleteAdsByInventoryReference request.
43
- */
44
- bulkDeleteAdsByInventoryReference(campaignId, body) {
45
- campaignId = encodeURIComponent(campaignId);
46
- return this.post(`/ad_campaign/${campaignId}/bulk_delete_ads_by_inventory_reference`, body);
47
- }
48
- /**
49
- * This method deletes a set of ads, as specified by a list of listing IDs, from the specified campaign.
50
- *
51
- * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
52
- * a seller's campaign IDs by calling getCampaigns.
53
- * @param body This type defines the fields for the bulkDeleteAdsByListingId request.
54
- */
55
- bulkDeleteAdsByListingId(campaignId, body) {
56
- campaignId = encodeURIComponent(campaignId);
57
- return this.post(`/ad_campaign/${campaignId}/bulk_delete_ads_by_listing_id`, body);
58
- }
59
- /**
60
- * This method replaces an ad bid based on a list of inventory references IDs associated with the specified
61
- * campaign.
62
- *
63
- * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created.
64
- * @param body This type defines the fields for the BulkCreateAdsByInventoryReference request.
65
- */
66
- bulkUpdateAdsBidByInventoryReference(campaignId, body) {
67
- campaignId = encodeURIComponent(campaignId);
68
- return this.post(`/ad_campaign/${campaignId}/bulk_update_ads_bid_by_inventory_reference`, body);
69
- }
70
- /**
71
- * This method replaces an ad bid based on a supplied list of listing IDs that are associated with the specified
72
- * campaign.
73
- *
74
- * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
75
- * a seller's campaign IDs by calling getCampaigns.
76
- * @param body Container for the bulk request to update ads.
77
- */
78
- bulkUpdateAdsBidByListingId(campaignId, body) {
79
- campaignId = encodeURIComponent(campaignId);
80
- return this.post(`/ad_campaign/${campaignId}/bulk_update_ads_bid_by_listing_id`, body);
81
- }
82
- /**
83
- * This method is only available for select partners who have been approved for the eBay Promoted Listings Advanced (PLA) program.
84
- *
85
- * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
86
- * a seller's campaign IDs by calling getCampaigns.
87
- * @param body The bulk request to update the ads.
88
- */
89
- bulkUpdateAdsStatus(campaignId, body) {
90
- campaignId = encodeURIComponent(campaignId);
91
- return this.post(`/ad_campaign/${campaignId}/bulk_update_ads_status`, body);
92
- }
93
- /**
94
- * This method is only available for select partners who have been approved for the eBay Promoted Listings Advanced (PLA) program.
95
- *
96
- * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
97
- * a seller's campaign IDs by calling getCampaigns.
98
- * @param body The bulk request to update ads.
99
- */
100
- bulkUpdateAdsStatusByListingId(campaignId, body) {
101
- campaignId = encodeURIComponent(campaignId);
102
- return this.post(`/ad_campaign/${campaignId}/bulk_update_ads_status_by_listing_id`, body);
103
- }
104
- /**
105
- * This method retrieves all the ads for the specified campaign.
106
- *
107
- * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
108
- * a seller's campaign IDs by calling getCampaigns.
109
- * @param limit Specifies the maximum number of ads to return on a page in the paginated response. Default: 10
110
- * Maximum: 500
111
- * @param listingIds A comma separated list of eBay listing IDs. The response includes only active ads (ads
112
- * associated with a RUNNING campaign).
113
- * @param offset Specifies the number of ads to skip in the result set before returning the first ad in the
114
- * paginated response.
115
- */
116
- getAds(campaignId, { limit, listingIds, offset } = {}) {
117
- campaignId = encodeURIComponent(campaignId);
118
- return this.get(`/ad_campaign/${campaignId}/ad`, {
119
- params: {
120
- limit,
121
- listing_ids: listingIds,
122
- offset
123
- }
124
- });
125
- }
126
- /**
127
- * This method creates an ad for the specified listing ID, sets the bid percentage for that specific item, and
128
- * associates the ad with the specified campaign.
129
- *
130
- * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
131
- * a seller's campaign IDs by calling getCampaigns.
132
- * @param body This type defines the fields for the createAd request.
133
- */
134
- createAdByListingId(campaignId, body) {
135
- campaignId = encodeURIComponent(campaignId);
136
- return this.post(`/ad_campaign/${campaignId}/ad`, body);
137
- }
138
- /**
139
- * This method creates an ad for the specified inventory reference ID, sets the bid percentage for that specific
140
- * item, and associates the ad with the specified campaign.
141
- *
142
- * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
143
- * a seller's campaign IDs by calling getCampaigns.
144
- * @param body This type defines the fields for the createAdsByInventoryReference request.
145
- */
146
- createAdsByInventoryReference(campaignId, body) {
147
- campaignId = encodeURIComponent(campaignId);
148
- return this.post(`/ad_campaign/${campaignId}/create_ads_by_inventory_reference`, body);
149
- }
150
- /**
151
- * This method retrieves the specified ad from the specified campaign.
152
- *
153
- * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
154
- * a seller's campaign IDs by calling getCampaigns.
155
- * @param adId Identifier of an ad. This ID was generated when the ad was created.
156
- */
157
- getAd(campaignId, adId) {
158
- campaignId = encodeURIComponent(campaignId);
159
- adId = encodeURIComponent(adId);
160
- return this.get(`/ad_campaign/${campaignId}/ad/${adId}`);
161
- }
162
- /**
163
- * This method retrieves the specified ad from the specified campaign.
164
- *
165
- * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created.
166
- * @param adId Identifier of an ad. This ID was generated when the ad was created.
167
- */
168
- deleteAd(campaignId, adId) {
169
- campaignId = encodeURIComponent(campaignId);
170
- adId = encodeURIComponent(adId);
171
- return this.delete(`/ad_campaign/${campaignId}/ad/${adId}`);
172
- }
173
- /**
174
- * This method deletes ads using a list of seller inventory reference IDs that are associated with the specified
175
- * campaign ID.
176
- *
177
- * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
178
- * a seller's campaign IDs by calling getCampaigns.
179
- */
180
- deleteAdsByInventoryReference(campaignId) {
181
- campaignId = encodeURIComponent(campaignId);
182
- return this.post(`/ad_campaign/${campaignId}/delete_ads_by_inventory_reference`);
183
- }
184
- /**
185
- * This method retrieves ads from the specified campaign using the seller's inventory reference ID and inventory
186
- * reference type.
187
- *
188
- * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
189
- * a seller's campaign IDs by calling getCampaigns.
190
- * @param inventoryReferenceId The inventory reference ID associated with the ad you want returned.
191
- * @param inventoryReferenceType The type of the inventory reference ID. Set this value to either INVENTORY_ITEM (a
192
- * single listing) or INVENTORY_ITEM_GROUP (a multi-variation listing).
193
- */
194
- getAdsByInventoryReference(campaignId, inventoryReferenceId, inventoryReferenceType) {
195
- campaignId = encodeURIComponent(campaignId);
196
- return this.get(`/ad_campaign/${campaignId}/get_ads_by_inventory_reference`, {
197
- params: {
198
- inventory_reference_id: inventoryReferenceId,
199
- inventory_reference_type: inventoryReferenceType
200
- }
201
- });
202
- }
203
- /**
204
- * This method updates the bid for the specified ad in the specified campaign. In the request, supply the
205
- * campaign_id and ad_id as a URI parameters.
206
- *
207
- * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
208
- * a seller's campaign IDs by calling getCampaigns.
209
- * @param adId A unique eBay-assigned ID for an ad that's generated when an ad is created.
210
- * @param body This type defines the fields for the updateBid request.
211
- */
212
- updateBid(campaignId, adId, body) {
213
- campaignId = encodeURIComponent(campaignId);
214
- adId = encodeURIComponent(adId);
215
- return this.post(`/ad_campaign/${campaignId}/ad/${adId}/update_bid`, body);
216
- }
217
- /**
218
- *
219
- * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
220
- * a seller's campaign IDs by calling getCampaigns.
221
- * @param adGroupStatus A comma-separated list of ad group statuses.
222
- * @param limit The number of results, from the current result set, to be returned in a single page.
223
- * @param offset The number of results that will be skipped in the result set.
224
- */
225
- getAdGroups(campaignId, { adGroupStatus, limit, offset } = {}) {
226
- campaignId = encodeURIComponent(campaignId);
227
- return this.get(`/ad_campaign/${campaignId}/ad_group`, {
228
- params: {
229
- ad_group_status: adGroupStatus,
230
- limit,
231
- offset
232
- }
233
- });
234
- }
235
- /**
236
- *
237
- * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
238
- * a seller's campaign IDs by calling getCampaigns.
239
- * @param body This type defines the fields for the <b>createAdGroup</b> request.
240
- */
241
- createAdGroup(campaignId, body) {
242
- campaignId = encodeURIComponent(campaignId);
243
- return this.post(`/ad_campaign/${campaignId}/ad_group`, body);
244
- }
245
- /**
246
- *
247
- * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
248
- * a seller's campaign IDs by calling getCampaigns.
249
- * @param adGroupId The ID of the ad group that shall be retrieved.
250
- */
251
- getAdGroup(campaignId, adGroupId) {
252
- adGroupId = encodeURIComponent(adGroupId);
253
- campaignId = encodeURIComponent(campaignId);
254
- return this.get(`/ad_campaign/${campaignId}/ad_group/${adGroupId}`);
255
- }
256
- /**
257
- *
258
- * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
259
- * a seller's campaign IDs by calling getCampaigns.
260
- * @param adGroupId The ID of the ad group that shall be retrieved.
261
- * @param body This type defines the fields for the <b>UpdateAdGroup</b> request.
262
- */
263
- updateAdGroup(campaignId, adGroupId, body) {
264
- adGroupId = encodeURIComponent(adGroupId);
265
- campaignId = encodeURIComponent(campaignId);
266
- return this.put(`/ad_campaign/${campaignId}/ad_group/${adGroupId}`, body);
267
- }
268
- /**
269
- *
270
- * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
271
- * a seller's campaign IDs by calling getCampaigns.
272
- * @param adGroupId The ID of the ad group that shall be retrieved.
273
- * @param body The data requested to retrieve the suggested bids.
274
- */
275
- suggestBids(campaignId, adGroupId, body) {
276
- adGroupId = encodeURIComponent(adGroupId);
277
- campaignId = encodeURIComponent(campaignId);
278
- return this.post(`/ad_campaign/${campaignId}/ad_group/${adGroupId}/suggest_bids`, body);
279
- }
280
- /**
281
- *
282
- * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
283
- * a seller's campaign IDs by calling getCampaigns.
284
- * @param adGroupId The ID of the ad group that shall be retrieved.
285
- * @param body The required data to retrieve suggested keywords.
286
- */
287
- suggestKeywords(campaignId, adGroupId, body) {
288
- adGroupId = encodeURIComponent(adGroupId);
289
- campaignId = encodeURIComponent(campaignId);
290
- return this.post(`/ad_campaign/${campaignId}/ad_group/${adGroupId}/suggest_keywords`, body);
291
- }
292
- /**
293
- * This method clones (makes a copy of) the specified campaign.
294
- *
295
- * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
296
- * a seller's campaign IDs by calling getCampaigns.
297
- * @param body This type defines the fields for a clone campaign request.
298
- */
299
- cloneCampaign(campaignId, body) {
300
- campaignId = encodeURIComponent(campaignId);
301
- return this.post(`/ad_campaign/${campaignId}/clone`, body);
302
- }
303
- /**
304
- * This method retrieves the details for all the campaigns of a seller, including the campaign's the selection
305
- * rules.
306
- *
307
- * @param campaignName Specifies the campaign name. The results are filtered to include only the campaign by the
308
- * specified name.
309
- * @param campaignStatus Specifies the campaign status. The results are filtered to include only campaigns that are
310
- * in the specified states.
311
- * @param endDateRange Specifies the range of a campaign's end date. The results are filtered to include only
312
- * campaigns with an end date that is within specified range.
313
- * @param limit Specifies the maximum number of campaigns to return on a page in the paginated response. Default:
314
- * 10 Maximum: 500
315
- * @param offset Specifies the number of campaigns to skip in the result set before returning the first report in
316
- * the paginated response.
317
- * @param startDateRange Specifies the range of a campaign's start date in which to filter the results.
318
- */
319
- getCampaigns({ campaignName, campaignStatus, endDateRange, limit, offset, startDateRange } = {}) {
320
- return this.get(`/ad_campaign`, {
321
- params: {
322
- campaign_name: campaignName,
323
- campaign_status: campaignStatus,
324
- end_date_range: endDateRange,
325
- limit,
326
- offset,
327
- start_date_range: startDateRange
328
- }
329
- });
330
- }
331
- /**
332
- * This method retrieves the details of a single campaign, as specified with the campaign_id query parameter.
333
- *
334
- * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
335
- * a seller's campaign IDs by calling getCampaigns.
336
- */
337
- getCampaign(campaignId) {
338
- campaignId = encodeURIComponent(campaignId);
339
- return this.get(`/ad_campaign/${campaignId}`);
340
- }
341
- /**
342
- * This method creates a Promoted Listings ad campaign.
343
- *
344
- * @param body his type defines the fields for the create campaign request.
345
- */
346
- createCampaign(body) {
347
- return this.post(`/ad_campaign`, body);
348
- }
349
- /**
350
- * This method deletes the campaign specified by the campaign_id query parameter.
351
- *
352
- * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
353
- * a seller's campaign IDs by calling getCampaigns.
354
- */
355
- deleteCampaign(campaignId) {
356
- campaignId = encodeURIComponent(campaignId);
357
- return this.delete(`/ad_campaign/${campaignId}`);
358
- }
359
- /**
360
- * This method ends an active (RUNNINGM) or paused campaign. Specify the campaign you want to end by supplying its
361
- * campaign ID in a query parameter.
362
- *
363
- * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
364
- * a seller's campaign IDs by calling getCampaigns.
365
- */
366
- endCampaign(campaignId) {
367
- campaignId = encodeURIComponent(campaignId);
368
- return this.post(`/ad_campaign/${campaignId}/end`);
369
- }
370
- /**
371
- * This method retrieves the campaign containing the listing that is specified using either an eBay listing ID or
372
- * an inventory reference ID and inventory reference type.
373
- *
374
- * @param inventoryReferenceId The seller's inventory reference ID of the listing to be used to find the campaign
375
- * in which it is associated.
376
- * @param inventoryReferenceType The type of the seller's inventory reference ID, which is a listing or group of
377
- * items.
378
- * @param listingId Identifier of the eBay listing associated with the ad.
379
- */
380
- findCampaignByAdReference({ inventoryReferenceId, inventoryReferenceType, listingId } = {}) {
381
- return this.get(`/ad_campaign/find_campaign_by_ad_reference`, {
382
- params: {
383
- inventory_reference_id: inventoryReferenceId,
384
- inventory_reference_type: inventoryReferenceType,
385
- listing_id: listingId
386
- }
387
- });
388
- }
389
- /**
390
- * This method retrieves the details of a single campaign, as specified with the campaign_name query parameter.
391
- *
392
- * @param campaignName Name of the campaign.
393
- */
394
- getCampaignByName(campaignName) {
395
- return this.get(`/ad_campaign/get_campaign_by_name`, {
396
- params: {
397
- campaign_name: campaignName
398
- }
399
- });
400
- }
401
- /**
402
- * This method pauses an active (RUNNING) campaign. You can restarted by calling resumeCampaign, as long as the
403
- * campaign's end date is in the future..
404
- *
405
- * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
406
- * a seller's campaign IDs by calling getCampaigns.
407
- */
408
- pauseCampaign(campaignId) {
409
- campaignId = encodeURIComponent(campaignId);
410
- return this.post(`/ad_campaign/${campaignId}/pause`);
411
- }
412
- /**
413
- * This method resumes a paused campaign, as long as it's end date is in the future.
414
- *
415
- * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
416
- * a seller's campaign IDs by calling getCampaigns.
417
- */
418
- resumeCampaign(campaignId) {
419
- campaignId = encodeURIComponent(campaignId);
420
- return this.post(`/ad_campaign/${campaignId}/resume`);
421
- }
422
- /**
423
- *
424
- * @param campaignId A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created.
425
- * @param categoryIds Specifies the category ID that is used to limit the results.
426
- * @param limit Specifies the maximum number of campaigns to return on a page in the paginated response.
427
- * @param offset Specifies the number of campaigns to skip in the result set before returning the first report in the paginated response.
428
- */
429
- suggestItems(campaignId, { categoryIds, limit, offset } = {}) {
430
- campaignId = encodeURIComponent(campaignId);
431
- return this.get(`/ad_campaign/${campaignId}/suggest_items`, {
432
- params: {
433
- category_ids: categoryIds,
434
- limit,
435
- offset
436
- }
437
- });
438
- }
439
- /**
440
- *
441
- * @param campaignId A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created.
442
- * @param body This type defines the request fields for the ad rate strategy that shall be updated.
443
- */
444
- updateAdRateStrategy(campaignId, body) {
445
- campaignId = encodeURIComponent(campaignId);
446
- return this.post(`/ad_campaign/${campaignId}/update_ad_rate_strategy`, body);
447
- }
448
- /**
449
- *
450
- * @param campaignId A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created.
451
- * @param body This type defines the request fields for the budget details that shall be updated.
452
- */
453
- updateCampaignBudget(campaignId, body) {
454
- campaignId = encodeURIComponent(campaignId);
455
- return this.post(`/ad_campaign/${campaignId}/update_campaign_budget`, body);
456
- }
457
- /**
458
- * This method replaces the name and the start and end dates of a campaign.
459
- *
460
- * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
461
- * a seller's campaign IDs by calling getCampaigns.
462
- * @param body This type defines the fields to updated the campaign name and start and end dates.
463
- */
464
- updateCampaignIdentification(campaignId, body) {
465
- campaignId = encodeURIComponent(campaignId);
466
- return this.post(`/ad_campaign/${campaignId}/update_campaign_identification`, body);
467
- }
468
- /**
469
- *
470
- * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
471
- * a seller's campaign IDs by calling getCampaigns.
472
- * @param body A type that defines the fields for the bulk request to create keywords.
473
- */
474
- bulkCreateKeyword(campaignId, body) {
475
- campaignId = encodeURIComponent(campaignId);
476
- return this.post(`/ad_campaign/${campaignId}/bulk_create_keyword`, body);
477
- }
478
- /**
479
- *
480
- * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
481
- * a seller's campaign IDs by calling getCampaigns.
482
- * @param body A type that defines the fields for the bulk request to update keywords.
483
- */
484
- bulkUpdateKeyword(campaignId, body) {
485
- campaignId = encodeURIComponent(campaignId);
486
- return this.post(`/ad_campaign/${campaignId}/bulk_update_keyword`, body);
487
- }
488
- /**
489
- *
490
- * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
491
- * a seller's campaign IDs by calling getCampaigns.
492
- * @param adGroupIds A comma-separated list of ad group IDs.
493
- * @param keywordStatus A comma-separated list of keyword statuses.
494
- * @param limit Specifies the maximum number of results to return on a page in the paginated response.
495
- * @param offset Specifies the number of results to skip in the result set before returning the first report in the paginated response.
496
- */
497
- getKeywords(campaignId, { adGroupIds, keywordStatus, limit, offset } = {}) {
498
- campaignId = encodeURIComponent(campaignId);
499
- return this.get(`/ad_campaign/${campaignId}/keyword`, {
500
- params: {
501
- ad_group_ids: adGroupIds,
502
- keyword_status: keywordStatus,
503
- limit,
504
- offset
505
- }
506
- });
507
- }
508
- /**
509
- *
510
- * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
511
- * a seller's campaign IDs by calling getCampaigns.
512
- * @param body A type that defines the fields for the request to create a keyword.
513
- */
514
- createKeyword(campaignId, body) {
515
- campaignId = encodeURIComponent(campaignId);
516
- return this.post(`/ad_campaign/${campaignId}/keyword`, body);
517
- }
518
- /**
519
- *
520
- * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
521
- * a seller's campaign IDs by calling getCampaigns.
522
- * @param keywordId This path parameter is used to identify the keyword to retrieve.
523
- */
524
- getKeyword(campaignId, keywordId) {
525
- campaignId = encodeURIComponent(campaignId);
526
- keywordId = encodeURIComponent(keywordId);
527
- return this.get(`/ad_campaign/${campaignId}/keyword/${keywordId}`);
528
- }
529
- /**
530
- *
531
- * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
532
- * a seller's campaign IDs by calling getCampaigns.
533
- * @param keywordId This path parameter is used to identify the keyword to retrieve.
534
- * @param body A type that defines the fields for the request to update a keyword.
535
- */
536
- updateKeyword(campaignId, keywordId, body) {
537
- campaignId = encodeURIComponent(campaignId);
538
- keywordId = encodeURIComponent(keywordId);
539
- return this.put(`/ad_campaign/${campaignId}/keyword/${keywordId}`, body);
540
- }
541
- /**
542
- *
543
- * @param body A type that defines the fields for the bulk request to create negative keywords.
544
- */
545
- bulkCreateNegativeKeyword(body) {
546
- return this.post(`/bulk_create_negative_keyword`, body);
547
- }
548
- /**
549
- *
550
- * @param body A type that defines the fields for the bulk request to create negative keywords.
551
- */
552
- bulkUpdateNegativeKeyword(body) {
553
- return this.post(`/bulk_update_negative_keyword`, body);
554
- }
555
- /**
556
- *
557
- * @param adGroupIds A comma-separated list of ad group IDs.
558
- * @param campaignIds A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created.
559
- * @param limit The number of results, from the current result set, to be returned in a single page.
560
- * @param negativeKeywordStatus A comma-separated list of negative keyword statuses.
561
- * @param offset The number of results that will be skipped in the result set.
562
- */
563
- getNegativeKeywords({ adGroupIds, campaignIds, limit, negativeKeywordStatus, offset } = {}) {
564
- return this.get(`/negative_keyword`, {
565
- params: {
566
- ad_group_ids: adGroupIds,
567
- campaign_ids: campaignIds, limit,
568
- negative_keyword_status: negativeKeywordStatus, offset
569
- }
570
- });
571
- }
572
- /**
573
- *
574
- * @param body A type that defines the fields for the request to create a negative keyword.
575
- */
576
- createNegativeKeyword(body) {
577
- return this.post(`/negative_keyword`, body);
578
- }
579
- /**
580
- *
581
- * @param negativeKeywordId The unique identifier for the negative keyword.
582
- */
583
- getNegativeKeyword(negativeKeywordId) {
584
- negativeKeywordId = encodeURIComponent(negativeKeywordId);
585
- return this.get(`/negative_keyword/${negativeKeywordId}`);
586
- }
587
- /**
588
- *
589
- * @param negativeKeywordId The unique identifier for the negative keyword.
590
- * @param body A type that defines the fields for the request to update a negative keyword.
591
- */
592
- updateNegativeKeyword(negativeKeywordId, body) {
593
- negativeKeywordId = encodeURIComponent(negativeKeywordId);
594
- return this.put(`/negative_keyword/${negativeKeywordId}`, body);
595
- }
596
- /**
597
- * This call downloads the report as specified by the report_id path parameter.
598
- *
599
- * @param reportId The unique ID of the Promoted Listings report you want to get. This ID is generated by eBay when
600
- * you run a report task with a call to createReportTask.
601
- */
602
- getReport(reportId) {
603
- reportId = encodeURIComponent(reportId);
604
- return this.get(`/ad_report/${reportId}`);
605
- }
606
- /**
607
- * This call retrieves information that details the fields used in each of the Promoted Listings reports.
608
- */
609
- getReportMetadata() {
610
- return this.get(`/ad_report_metadata`);
611
- }
612
- /**
613
- * This call retrieves metadata that details the fields used by the Promoted Listings report type that's specified
614
- * by the report_type path parameter.
615
- *
616
- * @param reportType The name of the report type whose metadata you want to get.
617
- */
618
- getReportMetadataForReportType(reportType) {
619
- reportType = encodeURIComponent(reportType);
620
- return this.get(`/ad_report_metadata/${reportType}`);
621
- }
622
- /**
623
- * This method returns information on all the existing report tasks related to a seller.
624
- *
625
- * @param limit Specifies the maximum number of report tasks to return on a page in the paginated response.
626
- * Default: 10 Maximum: 500
627
- * @param offset Specifies the number of report tasks to skip in the result set before returning the first report
628
- * in the paginated response.
629
- * @param reportTaskStatuses This parameter filters the returned report tasks by their status. Supply a
630
- * comma-separated list of the report statuses you want returned.
631
- */
632
- getReportTasks({ limit, offset, reportTaskStatuses } = {}) {
633
- return this.get(`/ad_report_task`, {
634
- params: {
635
- limit,
636
- offset,
637
- report_task_statuses: reportTaskStatuses
638
- }
639
- });
640
- }
641
- /**
642
- * This call returns the details of a specific Promoted Listings report task, as specified by the report_task_id
643
- * path parameter. T
644
- *
645
- * @param reportTaskId A unique eBay-assigned ID for the report task that's generated when the report task is
646
- * created by a call to createReportTask.
647
- */
648
- getReportTask(reportTaskId) {
649
- reportTaskId = encodeURIComponent(reportTaskId);
650
- return this.get(`/ad_report_task/${reportTaskId}`);
651
- }
652
- /**
653
- * This method creates a report task, which generates a Promoted Listings report based on the values specified in
654
- * the call.
655
- *
656
- * @param body The container for the fields that define the report task.
657
- */
658
- createReportTask(body) {
659
- return this.post(`/ad_report_task`, body);
660
- }
661
- /**
662
- * This call deletes the report task specified by the report_task_id path parameter.
663
- *
664
- * @param reportTaskId A unique eBay-assigned ID for the report task that's generated when the report task is
665
- * created by a call to createReportTask.
666
- */
667
- deleteReportTask(reportTaskId) {
668
- reportTaskId = encodeURIComponent(reportTaskId);
669
- return this.delete(`/ad_report_task/${reportTaskId}`);
670
- }
671
- /**
672
- * This method creates an item price markdown promotion (know simply as a &quot;markdown promotion&quot;) where a
673
- * discount amount is applied directly to the items included the promotion.
674
- *
675
- * @param body This type defines the fields that describe an item price markdown promotion.
676
- */
677
- createItemPriceMarkdownPromotion(body) {
678
- return this.post(`/item_price_markdown`, body);
679
- }
680
- /**
681
- * This method updates the specified item price markdown promotion with the new configuration that you supply in
682
- * the payload of the request.
683
- *
684
- * @param promotionId The ID of the promotion you want to update.
685
- * @param body This type defines the fields that describe an item price markdown promotion.
686
- */
687
- updateItemPriceMarkdownPromotion(promotionId, body) {
688
- promotionId = encodeURIComponent(promotionId);
689
- return this.put(`/item_price_markdown/${promotionId}`, body);
690
- }
691
- /**
692
- * This method deletes the item price markdown promotion specified by the promotion_id path parameter.
693
- *
694
- * @param promotionId The ID of the promotion you want to delete.
695
- */
696
- deleteItemPriceMarkdownPromotion(promotionId) {
697
- promotionId = encodeURIComponent(promotionId);
698
- return this.delete(`/item_price_markdown/${promotionId}`);
699
- }
700
- /**
701
- * This method returns the complete details of the item price markdown promotion that's indicated by the
702
- * promotion_id path parameter.
703
- *
704
- * @param promotionId The ID of the promotion you want to retrieve.
705
- */
706
- getItemPriceMarkdownPromotion(promotionId) {
707
- promotionId = encodeURIComponent(promotionId);
708
- return this.get(`/item_price_markdown/${promotionId}`);
709
- }
710
- /**
711
- * This method creates an item promotion (known casually as a &quot;threshold promotion&quot;) where the buyer
712
- * receives a discount when they meet the buying criteria that's set for the promotion.
713
- *
714
- * @param body This type defines the fields that describe an item promotion.
715
- */
716
- createItemPromotion(body) {
717
- return this.post(`/item_promotion`, body);
718
- }
719
- /**
720
- * This method updates the specified threshold promotion with the new configuration that you supply in the request.
721
- *
722
- * @param promotionId The ID of the promotion you want to retrieve. The promotion ID is a unique eBay-assigned
723
- * value that's generated when the promotion is created.
724
- * @param body type defines the fields that describe an item promotion.
725
- */
726
- updateItemPromotion(promotionId, body) {
727
- promotionId = encodeURIComponent(promotionId);
728
- return this.put(`/item_promotion/${promotionId}`, body);
729
- }
730
- /**
731
- * This method deletes the threshold promotion specified by the promotion_id path parameter.
732
- *
733
- * @param promotionId The ID of the promotion you want to retrieve. The promotion ID is a unique eBay-assigned
734
- * value that's generated when the promotion is created.
735
- */
736
- deleteItemPromotion(promotionId) {
737
- promotionId = encodeURIComponent(promotionId);
738
- return this.delete(`/item_promotion/${promotionId}`);
739
- }
740
- /**
741
- * This method returns the complete details of the threshold promotion specified by the promotion_id path
742
- * parameter.
743
- *
744
- * @param promotionId The ID of the promotion you want to retrieve. The promotion ID is a unique eBay-assigned
745
- * value that's generated when the promotion is created.
746
- */
747
- getItemPromotion(promotionId) {
748
- promotionId = encodeURIComponent(promotionId);
749
- return this.get(`/item_promotion/${promotionId}`);
750
- }
751
- /**
752
- * This method returns the set of listings associated with the promotion_id specified in the path parameter.
753
- *
754
- * @param promotionId The ID of the promotion whose associated listings you want to retrieve.
755
- * @param limit Specifies the maximum number of promotions returned on a page from the result set. Default: 200
756
- * Maximum: 200
757
- * @param offset Specifies the number of promotions to skip in the result set before returning the first promotion
758
- * in the paginated response.
759
- * @param q Reserved for future use.
760
- * @param sort Specifies the order in which to sort the associated listings in the response.
761
- * @param status This query parameter applies only to markdown promotions.
762
- */
763
- getListingSet(promotionId, { limit, offset, q, sort, status } = {}) {
764
- promotionId = encodeURIComponent(promotionId);
765
- return this.get(`/promotion/${promotionId}/get_listing_set`, {
766
- params: {
767
- limit,
768
- offset,
769
- q,
770
- sort,
771
- status
772
- }
773
- });
774
- }
775
- /**
776
- * This method returns a list of a seller's undeleted promotions.
777
- *
778
- * @param marketplaceId The eBay marketplace ID of the site where the promotion is hosted.
779
- * @param limit Specifies the maximum number of promotions returned on a page from the result set. Default: 200
780
- * Maximum: 200
781
- * @param offset Specifies the number of promotions to skip in the result set before returning the first promotion
782
- * in the paginated response.
783
- * @param promotionStatus Specifies the promotion state by which you want to filter the results.
784
- * @param promotionType Filters the returned promotions based on the their campaign promotion type.
785
- * @param q A string consisting of one or more keywords.
786
- * @param sort Specifies the order for how to sort the response.
787
- */
788
- getPromotions(marketplaceId, { limit, offset, promotionStatus, promotionType, q, sort } = {}) {
789
- return this.get(`/promotion`, {
790
- params: {
791
- marketplace_id: marketplaceId,
792
- limit,
793
- offset,
794
- promotion_status: promotionStatus,
795
- promotion_type: promotionType,
796
- q,
797
- sort
798
- }
799
- });
800
- }
801
- /**
802
- * This method pauses a currently-active (RUNNING) threshold promotion and changes the state of the promotion from
803
- * RUNNING to PAUSED.
804
- *
805
- * @param promotionId Identifier of the promotion you want to pause.
806
- */
807
- pausePromotion(promotionId) {
808
- const id = encodeURIComponent(promotionId);
809
- return this.post(`/promotion/${id}/pause`);
810
- }
811
- /**
812
- * This method restarts a threshold promotion that was previously paused and changes the state of the promotion
813
- * from PAUSED to RUNNING.
814
- *
815
- * @param promotionId Identifier of the promotion you want to make active. The ID is a unique eBay-assigned value
816
- * that's generated when the promotion is created.
817
- */
818
- resumePromotion(promotionId) {
819
- const id = encodeURIComponent(promotionId);
820
- return this.post(`/promotion/${id}/resume`);
821
- }
822
- /**
823
- * This method generates a report that lists the seller's running, paused, and ended promotions for the specified
824
- * eBay marketplace.
825
- *
826
- * @param marketplaceId The eBay marketplace ID of the siteId for which you want the promotions report.
827
- * @param limit Specifies the maximum number of promotions returned on a page from the result set. Default: 200
828
- * Maximum: 200
829
- * @param offset Specifies the number of promotions to skip in the result set before returning the first promotion
830
- * in the paginated response.
831
- * @param promotionStatus Limits the results to the promotions that are in the state specified by this query
832
- * parameter.
833
- * @param promotionType Filters the returned promotions in the report based on the their campaign promotion type.
834
- * @param q A string consisting of one or more keywords. eBay filters the response by returning only the promotions
835
- * that contain the supplied keywords in the promotion title.
836
- */
837
- getPromotionReports(marketplaceId, { limit, offset, promotionStatus, promotionType, q } = {}) {
838
- return this.get(`/promotion_report`, {
839
- params: {
840
- marketplace_id: marketplaceId,
841
- limit,
842
- offset,
843
- promotion_status: promotionStatus,
844
- promotion_type: promotionType,
845
- q
846
- }
847
- });
848
- }
849
- /**
850
- * This method generates a report that summarizes the seller's promotions for the specified eBay marketplace.
851
- *
852
- * @param marketplaceId The eBay marketplace ID of the siteId you for which you want a promotion summary report.
853
- */
854
- getPromotionSummaryReport(marketplaceId) {
855
- return this.get(`/promotion_summary_report`, {
856
- params: {
857
- marketplace_id: marketplaceId
858
- }
859
- });
860
- }
861
- }
862
- Marketing.id = 'Marketing';
1
+ import Restful from '../../index.js';
2
+ /**
3
+ * <p>The <i>Marketing API </i> offers two platforms that sellers can use to promote and advertise their products:
4
+ * </p> <ul><li><b>Promoted Listings</b> is an eBay ad service that lets sellers set up <i>ad campaigns </i>
5
+ * for the products they want to promote. eBay displays the ads in search results and in other
6
+ * marketing modules as <b>SPONSORED</b> listings.
7
+ */
8
+ class Marketing extends Restful {
9
+ get basePath() {
10
+ return '/sell/marketing/v1';
11
+ }
12
+ /**
13
+ * This method creates an ad for each inventory reference ID specified in the request and associates the newly
14
+ * created ads with the specified campaign.
15
+ *
16
+ * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created.
17
+ * @param body This type defines the fields for the bulkCreateAdsByInventoryReference request.
18
+ */
19
+ bulkCreateAdsByInventoryReference(campaignId, body) {
20
+ campaignId = encodeURIComponent(campaignId);
21
+ return this.post(`/ad_campaign/${campaignId}/bulk_create_ads_by_inventory_reference`, body);
22
+ }
23
+ /**
24
+ * This method creates an ad for each listing ID specified in the request and associates the newly created ads with
25
+ * the specified campaign.
26
+ *
27
+ * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
28
+ * a seller's campaign IDs by calling getCampaigns.
29
+ * @param body The container for the bulk request to create ads for eBay listing IDs. eBay listing IDs are
30
+ * generated when the listing is created on eBay.
31
+ */
32
+ bulkCreateAdsByListingId(campaignId, body) {
33
+ campaignId = encodeURIComponent(campaignId);
34
+ return this.post(`/ad_campaign/${campaignId}/bulk_create_ads_by_listing_id`, body);
35
+ }
36
+ /**
37
+ * This method deletes a set of ads, as specified by a list of inventory reference IDs, from the specified
38
+ * campaign.
39
+ *
40
+ * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
41
+ * a seller's campaign IDs by calling getCampaigns.
42
+ * @param body This type defines the fields for a bulkDeleteAdsByInventoryReference request.
43
+ */
44
+ bulkDeleteAdsByInventoryReference(campaignId, body) {
45
+ campaignId = encodeURIComponent(campaignId);
46
+ return this.post(`/ad_campaign/${campaignId}/bulk_delete_ads_by_inventory_reference`, body);
47
+ }
48
+ /**
49
+ * This method deletes a set of ads, as specified by a list of listing IDs, from the specified campaign.
50
+ *
51
+ * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
52
+ * a seller's campaign IDs by calling getCampaigns.
53
+ * @param body This type defines the fields for the bulkDeleteAdsByListingId request.
54
+ */
55
+ bulkDeleteAdsByListingId(campaignId, body) {
56
+ campaignId = encodeURIComponent(campaignId);
57
+ return this.post(`/ad_campaign/${campaignId}/bulk_delete_ads_by_listing_id`, body);
58
+ }
59
+ /**
60
+ * This method replaces an ad bid based on a list of inventory references IDs associated with the specified
61
+ * campaign.
62
+ *
63
+ * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created.
64
+ * @param body This type defines the fields for the BulkCreateAdsByInventoryReference request.
65
+ */
66
+ bulkUpdateAdsBidByInventoryReference(campaignId, body) {
67
+ campaignId = encodeURIComponent(campaignId);
68
+ return this.post(`/ad_campaign/${campaignId}/bulk_update_ads_bid_by_inventory_reference`, body);
69
+ }
70
+ /**
71
+ * This method replaces an ad bid based on a supplied list of listing IDs that are associated with the specified
72
+ * campaign.
73
+ *
74
+ * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
75
+ * a seller's campaign IDs by calling getCampaigns.
76
+ * @param body Container for the bulk request to update ads.
77
+ */
78
+ bulkUpdateAdsBidByListingId(campaignId, body) {
79
+ campaignId = encodeURIComponent(campaignId);
80
+ return this.post(`/ad_campaign/${campaignId}/bulk_update_ads_bid_by_listing_id`, body);
81
+ }
82
+ /**
83
+ * This method is only available for select partners who have been approved for the eBay Promoted Listings Advanced (PLA) program.
84
+ *
85
+ * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
86
+ * a seller's campaign IDs by calling getCampaigns.
87
+ * @param body The bulk request to update the ads.
88
+ */
89
+ bulkUpdateAdsStatus(campaignId, body) {
90
+ campaignId = encodeURIComponent(campaignId);
91
+ return this.post(`/ad_campaign/${campaignId}/bulk_update_ads_status`, body);
92
+ }
93
+ /**
94
+ * This method is only available for select partners who have been approved for the eBay Promoted Listings Advanced (PLA) program.
95
+ *
96
+ * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
97
+ * a seller's campaign IDs by calling getCampaigns.
98
+ * @param body The bulk request to update ads.
99
+ */
100
+ bulkUpdateAdsStatusByListingId(campaignId, body) {
101
+ campaignId = encodeURIComponent(campaignId);
102
+ return this.post(`/ad_campaign/${campaignId}/bulk_update_ads_status_by_listing_id`, body);
103
+ }
104
+ /**
105
+ * This method retrieves all the ads for the specified campaign.
106
+ *
107
+ * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
108
+ * a seller's campaign IDs by calling getCampaigns.
109
+ * @param limit Specifies the maximum number of ads to return on a page in the paginated response. Default: 10
110
+ * Maximum: 500
111
+ * @param listingIds A comma separated list of eBay listing IDs. The response includes only active ads (ads
112
+ * associated with a RUNNING campaign).
113
+ * @param offset Specifies the number of ads to skip in the result set before returning the first ad in the
114
+ * paginated response.
115
+ */
116
+ getAds(campaignId, { limit, listingIds, offset } = {}) {
117
+ campaignId = encodeURIComponent(campaignId);
118
+ return this.get(`/ad_campaign/${campaignId}/ad`, {
119
+ params: {
120
+ limit,
121
+ listing_ids: listingIds,
122
+ offset
123
+ }
124
+ });
125
+ }
126
+ /**
127
+ * This method creates an ad for the specified listing ID, sets the bid percentage for that specific item, and
128
+ * associates the ad with the specified campaign.
129
+ *
130
+ * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
131
+ * a seller's campaign IDs by calling getCampaigns.
132
+ * @param body This type defines the fields for the createAd request.
133
+ */
134
+ createAdByListingId(campaignId, body) {
135
+ campaignId = encodeURIComponent(campaignId);
136
+ return this.post(`/ad_campaign/${campaignId}/ad`, body);
137
+ }
138
+ /**
139
+ * This method creates an ad for the specified inventory reference ID, sets the bid percentage for that specific
140
+ * item, and associates the ad with the specified campaign.
141
+ *
142
+ * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
143
+ * a seller's campaign IDs by calling getCampaigns.
144
+ * @param body This type defines the fields for the createAdsByInventoryReference request.
145
+ */
146
+ createAdsByInventoryReference(campaignId, body) {
147
+ campaignId = encodeURIComponent(campaignId);
148
+ return this.post(`/ad_campaign/${campaignId}/create_ads_by_inventory_reference`, body);
149
+ }
150
+ /**
151
+ * This method retrieves the specified ad from the specified campaign.
152
+ *
153
+ * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
154
+ * a seller's campaign IDs by calling getCampaigns.
155
+ * @param adId Identifier of an ad. This ID was generated when the ad was created.
156
+ */
157
+ getAd(campaignId, adId) {
158
+ campaignId = encodeURIComponent(campaignId);
159
+ adId = encodeURIComponent(adId);
160
+ return this.get(`/ad_campaign/${campaignId}/ad/${adId}`);
161
+ }
162
+ /**
163
+ * This method retrieves the specified ad from the specified campaign.
164
+ *
165
+ * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created.
166
+ * @param adId Identifier of an ad. This ID was generated when the ad was created.
167
+ */
168
+ deleteAd(campaignId, adId) {
169
+ campaignId = encodeURIComponent(campaignId);
170
+ adId = encodeURIComponent(adId);
171
+ return this.delete(`/ad_campaign/${campaignId}/ad/${adId}`);
172
+ }
173
+ /**
174
+ * This method deletes ads using a list of seller inventory reference IDs that are associated with the specified
175
+ * campaign ID.
176
+ *
177
+ * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
178
+ * a seller's campaign IDs by calling getCampaigns.
179
+ */
180
+ deleteAdsByInventoryReference(campaignId) {
181
+ campaignId = encodeURIComponent(campaignId);
182
+ return this.post(`/ad_campaign/${campaignId}/delete_ads_by_inventory_reference`);
183
+ }
184
+ /**
185
+ * This method retrieves ads from the specified campaign using the seller's inventory reference ID and inventory
186
+ * reference type.
187
+ *
188
+ * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
189
+ * a seller's campaign IDs by calling getCampaigns.
190
+ * @param inventoryReferenceId The inventory reference ID associated with the ad you want returned.
191
+ * @param inventoryReferenceType The type of the inventory reference ID. Set this value to either INVENTORY_ITEM (a
192
+ * single listing) or INVENTORY_ITEM_GROUP (a multi-variation listing).
193
+ */
194
+ getAdsByInventoryReference(campaignId, inventoryReferenceId, inventoryReferenceType) {
195
+ campaignId = encodeURIComponent(campaignId);
196
+ return this.get(`/ad_campaign/${campaignId}/get_ads_by_inventory_reference`, {
197
+ params: {
198
+ inventory_reference_id: inventoryReferenceId,
199
+ inventory_reference_type: inventoryReferenceType
200
+ }
201
+ });
202
+ }
203
+ /**
204
+ * This method updates the bid for the specified ad in the specified campaign. In the request, supply the
205
+ * campaign_id and ad_id as a URI parameters.
206
+ *
207
+ * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
208
+ * a seller's campaign IDs by calling getCampaigns.
209
+ * @param adId A unique eBay-assigned ID for an ad that's generated when an ad is created.
210
+ * @param body This type defines the fields for the updateBid request.
211
+ */
212
+ updateBid(campaignId, adId, body) {
213
+ campaignId = encodeURIComponent(campaignId);
214
+ adId = encodeURIComponent(adId);
215
+ return this.post(`/ad_campaign/${campaignId}/ad/${adId}/update_bid`, body);
216
+ }
217
+ /**
218
+ *
219
+ * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
220
+ * a seller's campaign IDs by calling getCampaigns.
221
+ * @param adGroupStatus A comma-separated list of ad group statuses.
222
+ * @param limit The number of results, from the current result set, to be returned in a single page.
223
+ * @param offset The number of results that will be skipped in the result set.
224
+ */
225
+ getAdGroups(campaignId, { adGroupStatus, limit, offset } = {}) {
226
+ campaignId = encodeURIComponent(campaignId);
227
+ return this.get(`/ad_campaign/${campaignId}/ad_group`, {
228
+ params: {
229
+ ad_group_status: adGroupStatus,
230
+ limit,
231
+ offset
232
+ }
233
+ });
234
+ }
235
+ /**
236
+ *
237
+ * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
238
+ * a seller's campaign IDs by calling getCampaigns.
239
+ * @param body This type defines the fields for the <b>createAdGroup</b> request.
240
+ */
241
+ createAdGroup(campaignId, body) {
242
+ campaignId = encodeURIComponent(campaignId);
243
+ return this.post(`/ad_campaign/${campaignId}/ad_group`, body);
244
+ }
245
+ /**
246
+ *
247
+ * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
248
+ * a seller's campaign IDs by calling getCampaigns.
249
+ * @param adGroupId The ID of the ad group that shall be retrieved.
250
+ */
251
+ getAdGroup(campaignId, adGroupId) {
252
+ adGroupId = encodeURIComponent(adGroupId);
253
+ campaignId = encodeURIComponent(campaignId);
254
+ return this.get(`/ad_campaign/${campaignId}/ad_group/${adGroupId}`);
255
+ }
256
+ /**
257
+ *
258
+ * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
259
+ * a seller's campaign IDs by calling getCampaigns.
260
+ * @param adGroupId The ID of the ad group that shall be retrieved.
261
+ * @param body This type defines the fields for the <b>UpdateAdGroup</b> request.
262
+ */
263
+ updateAdGroup(campaignId, adGroupId, body) {
264
+ adGroupId = encodeURIComponent(adGroupId);
265
+ campaignId = encodeURIComponent(campaignId);
266
+ return this.put(`/ad_campaign/${campaignId}/ad_group/${adGroupId}`, body);
267
+ }
268
+ /**
269
+ *
270
+ * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
271
+ * a seller's campaign IDs by calling getCampaigns.
272
+ * @param adGroupId The ID of the ad group that shall be retrieved.
273
+ * @param body The data requested to retrieve the suggested bids.
274
+ */
275
+ suggestBids(campaignId, adGroupId, body) {
276
+ adGroupId = encodeURIComponent(adGroupId);
277
+ campaignId = encodeURIComponent(campaignId);
278
+ return this.post(`/ad_campaign/${campaignId}/ad_group/${adGroupId}/suggest_bids`, body);
279
+ }
280
+ /**
281
+ *
282
+ * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
283
+ * a seller's campaign IDs by calling getCampaigns.
284
+ * @param adGroupId The ID of the ad group that shall be retrieved.
285
+ * @param body The required data to retrieve suggested keywords.
286
+ */
287
+ suggestKeywords(campaignId, adGroupId, body) {
288
+ adGroupId = encodeURIComponent(adGroupId);
289
+ campaignId = encodeURIComponent(campaignId);
290
+ return this.post(`/ad_campaign/${campaignId}/ad_group/${adGroupId}/suggest_keywords`, body);
291
+ }
292
+ /**
293
+ * This method clones (makes a copy of) the specified campaign.
294
+ *
295
+ * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
296
+ * a seller's campaign IDs by calling getCampaigns.
297
+ * @param body This type defines the fields for a clone campaign request.
298
+ */
299
+ cloneCampaign(campaignId, body) {
300
+ campaignId = encodeURIComponent(campaignId);
301
+ return this.post(`/ad_campaign/${campaignId}/clone`, body);
302
+ }
303
+ /**
304
+ * This method retrieves the details for all the campaigns of a seller, including the campaign's the selection
305
+ * rules.
306
+ *
307
+ * @param campaignName Specifies the campaign name. The results are filtered to include only the campaign by the
308
+ * specified name.
309
+ * @param campaignStatus Specifies the campaign status. The results are filtered to include only campaigns that are
310
+ * in the specified states.
311
+ * @param endDateRange Specifies the range of a campaign's end date. The results are filtered to include only
312
+ * campaigns with an end date that is within specified range.
313
+ * @param limit Specifies the maximum number of campaigns to return on a page in the paginated response. Default:
314
+ * 10 Maximum: 500
315
+ * @param offset Specifies the number of campaigns to skip in the result set before returning the first report in
316
+ * the paginated response.
317
+ * @param startDateRange Specifies the range of a campaign's start date in which to filter the results.
318
+ */
319
+ getCampaigns({ campaignName, campaignStatus, endDateRange, limit, offset, startDateRange } = {}) {
320
+ return this.get(`/ad_campaign`, {
321
+ params: {
322
+ campaign_name: campaignName,
323
+ campaign_status: campaignStatus,
324
+ end_date_range: endDateRange,
325
+ limit,
326
+ offset,
327
+ start_date_range: startDateRange
328
+ }
329
+ });
330
+ }
331
+ /**
332
+ * This method retrieves the details of a single campaign, as specified with the campaign_id query parameter.
333
+ *
334
+ * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
335
+ * a seller's campaign IDs by calling getCampaigns.
336
+ */
337
+ getCampaign(campaignId) {
338
+ campaignId = encodeURIComponent(campaignId);
339
+ return this.get(`/ad_campaign/${campaignId}`);
340
+ }
341
+ /**
342
+ * This method creates a Promoted Listings ad campaign.
343
+ *
344
+ * @param body his type defines the fields for the create campaign request.
345
+ */
346
+ createCampaign(body) {
347
+ return this.post(`/ad_campaign`, body);
348
+ }
349
+ /**
350
+ * This method deletes the campaign specified by the campaign_id query parameter.
351
+ *
352
+ * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
353
+ * a seller's campaign IDs by calling getCampaigns.
354
+ */
355
+ deleteCampaign(campaignId) {
356
+ campaignId = encodeURIComponent(campaignId);
357
+ return this.delete(`/ad_campaign/${campaignId}`);
358
+ }
359
+ /**
360
+ * This method ends an active (RUNNINGM) or paused campaign. Specify the campaign you want to end by supplying its
361
+ * campaign ID in a query parameter.
362
+ *
363
+ * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
364
+ * a seller's campaign IDs by calling getCampaigns.
365
+ */
366
+ endCampaign(campaignId) {
367
+ campaignId = encodeURIComponent(campaignId);
368
+ return this.post(`/ad_campaign/${campaignId}/end`);
369
+ }
370
+ /**
371
+ * This method retrieves the campaign containing the listing that is specified using either an eBay listing ID or
372
+ * an inventory reference ID and inventory reference type.
373
+ *
374
+ * @param inventoryReferenceId The seller's inventory reference ID of the listing to be used to find the campaign
375
+ * in which it is associated.
376
+ * @param inventoryReferenceType The type of the seller's inventory reference ID, which is a listing or group of
377
+ * items.
378
+ * @param listingId Identifier of the eBay listing associated with the ad.
379
+ */
380
+ findCampaignByAdReference({ inventoryReferenceId, inventoryReferenceType, listingId } = {}) {
381
+ return this.get(`/ad_campaign/find_campaign_by_ad_reference`, {
382
+ params: {
383
+ inventory_reference_id: inventoryReferenceId,
384
+ inventory_reference_type: inventoryReferenceType,
385
+ listing_id: listingId
386
+ }
387
+ });
388
+ }
389
+ /**
390
+ * This method retrieves the details of a single campaign, as specified with the campaign_name query parameter.
391
+ *
392
+ * @param campaignName Name of the campaign.
393
+ */
394
+ getCampaignByName(campaignName) {
395
+ return this.get(`/ad_campaign/get_campaign_by_name`, {
396
+ params: {
397
+ campaign_name: campaignName
398
+ }
399
+ });
400
+ }
401
+ /**
402
+ * This method pauses an active (RUNNING) campaign. You can restarted by calling resumeCampaign, as long as the
403
+ * campaign's end date is in the future..
404
+ *
405
+ * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
406
+ * a seller's campaign IDs by calling getCampaigns.
407
+ */
408
+ pauseCampaign(campaignId) {
409
+ campaignId = encodeURIComponent(campaignId);
410
+ return this.post(`/ad_campaign/${campaignId}/pause`);
411
+ }
412
+ /**
413
+ * This method resumes a paused campaign, as long as it's end date is in the future.
414
+ *
415
+ * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
416
+ * a seller's campaign IDs by calling getCampaigns.
417
+ */
418
+ resumeCampaign(campaignId) {
419
+ campaignId = encodeURIComponent(campaignId);
420
+ return this.post(`/ad_campaign/${campaignId}/resume`);
421
+ }
422
+ /**
423
+ *
424
+ * @param campaignId A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created.
425
+ * @param categoryIds Specifies the category ID that is used to limit the results.
426
+ * @param limit Specifies the maximum number of campaigns to return on a page in the paginated response.
427
+ * @param offset Specifies the number of campaigns to skip in the result set before returning the first report in the paginated response.
428
+ */
429
+ suggestItems(campaignId, { categoryIds, limit, offset } = {}) {
430
+ campaignId = encodeURIComponent(campaignId);
431
+ return this.get(`/ad_campaign/${campaignId}/suggest_items`, {
432
+ params: {
433
+ category_ids: categoryIds,
434
+ limit,
435
+ offset
436
+ }
437
+ });
438
+ }
439
+ /**
440
+ *
441
+ * @param campaignId A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created.
442
+ * @param body This type defines the request fields for the ad rate strategy that shall be updated.
443
+ */
444
+ updateAdRateStrategy(campaignId, body) {
445
+ campaignId = encodeURIComponent(campaignId);
446
+ return this.post(`/ad_campaign/${campaignId}/update_ad_rate_strategy`, body);
447
+ }
448
+ /**
449
+ *
450
+ * @param campaignId A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created.
451
+ * @param body This type defines the request fields for the budget details that shall be updated.
452
+ */
453
+ updateCampaignBudget(campaignId, body) {
454
+ campaignId = encodeURIComponent(campaignId);
455
+ return this.post(`/ad_campaign/${campaignId}/update_campaign_budget`, body);
456
+ }
457
+ /**
458
+ * This method replaces the name and the start and end dates of a campaign.
459
+ *
460
+ * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
461
+ * a seller's campaign IDs by calling getCampaigns.
462
+ * @param body This type defines the fields to updated the campaign name and start and end dates.
463
+ */
464
+ updateCampaignIdentification(campaignId, body) {
465
+ campaignId = encodeURIComponent(campaignId);
466
+ return this.post(`/ad_campaign/${campaignId}/update_campaign_identification`, body);
467
+ }
468
+ /**
469
+ *
470
+ * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
471
+ * a seller's campaign IDs by calling getCampaigns.
472
+ * @param body A type that defines the fields for the bulk request to create keywords.
473
+ */
474
+ bulkCreateKeyword(campaignId, body) {
475
+ campaignId = encodeURIComponent(campaignId);
476
+ return this.post(`/ad_campaign/${campaignId}/bulk_create_keyword`, body);
477
+ }
478
+ /**
479
+ *
480
+ * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
481
+ * a seller's campaign IDs by calling getCampaigns.
482
+ * @param body A type that defines the fields for the bulk request to update keywords.
483
+ */
484
+ bulkUpdateKeyword(campaignId, body) {
485
+ campaignId = encodeURIComponent(campaignId);
486
+ return this.post(`/ad_campaign/${campaignId}/bulk_update_keyword`, body);
487
+ }
488
+ /**
489
+ *
490
+ * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
491
+ * a seller's campaign IDs by calling getCampaigns.
492
+ * @param adGroupIds A comma-separated list of ad group IDs.
493
+ * @param keywordStatus A comma-separated list of keyword statuses.
494
+ * @param limit Specifies the maximum number of results to return on a page in the paginated response.
495
+ * @param offset Specifies the number of results to skip in the result set before returning the first report in the paginated response.
496
+ */
497
+ getKeywords(campaignId, { adGroupIds, keywordStatus, limit, offset } = {}) {
498
+ campaignId = encodeURIComponent(campaignId);
499
+ return this.get(`/ad_campaign/${campaignId}/keyword`, {
500
+ params: {
501
+ ad_group_ids: adGroupIds,
502
+ keyword_status: keywordStatus,
503
+ limit,
504
+ offset
505
+ }
506
+ });
507
+ }
508
+ /**
509
+ *
510
+ * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
511
+ * a seller's campaign IDs by calling getCampaigns.
512
+ * @param body A type that defines the fields for the request to create a keyword.
513
+ */
514
+ createKeyword(campaignId, body) {
515
+ campaignId = encodeURIComponent(campaignId);
516
+ return this.post(`/ad_campaign/${campaignId}/keyword`, body);
517
+ }
518
+ /**
519
+ *
520
+ * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
521
+ * a seller's campaign IDs by calling getCampaigns.
522
+ * @param keywordId This path parameter is used to identify the keyword to retrieve.
523
+ */
524
+ getKeyword(campaignId, keywordId) {
525
+ campaignId = encodeURIComponent(campaignId);
526
+ keywordId = encodeURIComponent(keywordId);
527
+ return this.get(`/ad_campaign/${campaignId}/keyword/${keywordId}`);
528
+ }
529
+ /**
530
+ *
531
+ * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
532
+ * a seller's campaign IDs by calling getCampaigns.
533
+ * @param keywordId This path parameter is used to identify the keyword to retrieve.
534
+ * @param body A type that defines the fields for the request to update a keyword.
535
+ */
536
+ updateKeyword(campaignId, keywordId, body) {
537
+ campaignId = encodeURIComponent(campaignId);
538
+ keywordId = encodeURIComponent(keywordId);
539
+ return this.put(`/ad_campaign/${campaignId}/keyword/${keywordId}`, body);
540
+ }
541
+ /**
542
+ *
543
+ * @param body A type that defines the fields for the bulk request to create negative keywords.
544
+ */
545
+ bulkCreateNegativeKeyword(body) {
546
+ return this.post(`/bulk_create_negative_keyword`, body);
547
+ }
548
+ /**
549
+ *
550
+ * @param body A type that defines the fields for the bulk request to create negative keywords.
551
+ */
552
+ bulkUpdateNegativeKeyword(body) {
553
+ return this.post(`/bulk_update_negative_keyword`, body);
554
+ }
555
+ /**
556
+ *
557
+ * @param adGroupIds A comma-separated list of ad group IDs.
558
+ * @param campaignIds A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created.
559
+ * @param limit The number of results, from the current result set, to be returned in a single page.
560
+ * @param negativeKeywordStatus A comma-separated list of negative keyword statuses.
561
+ * @param offset The number of results that will be skipped in the result set.
562
+ */
563
+ getNegativeKeywords({ adGroupIds, campaignIds, limit, negativeKeywordStatus, offset } = {}) {
564
+ return this.get(`/negative_keyword`, {
565
+ params: {
566
+ ad_group_ids: adGroupIds,
567
+ campaign_ids: campaignIds, limit,
568
+ negative_keyword_status: negativeKeywordStatus, offset
569
+ }
570
+ });
571
+ }
572
+ /**
573
+ *
574
+ * @param body A type that defines the fields for the request to create a negative keyword.
575
+ */
576
+ createNegativeKeyword(body) {
577
+ return this.post(`/negative_keyword`, body);
578
+ }
579
+ /**
580
+ *
581
+ * @param negativeKeywordId The unique identifier for the negative keyword.
582
+ */
583
+ getNegativeKeyword(negativeKeywordId) {
584
+ negativeKeywordId = encodeURIComponent(negativeKeywordId);
585
+ return this.get(`/negative_keyword/${negativeKeywordId}`);
586
+ }
587
+ /**
588
+ *
589
+ * @param negativeKeywordId The unique identifier for the negative keyword.
590
+ * @param body A type that defines the fields for the request to update a negative keyword.
591
+ */
592
+ updateNegativeKeyword(negativeKeywordId, body) {
593
+ negativeKeywordId = encodeURIComponent(negativeKeywordId);
594
+ return this.put(`/negative_keyword/${negativeKeywordId}`, body);
595
+ }
596
+ /**
597
+ * This call downloads the report as specified by the report_id path parameter.
598
+ *
599
+ * @param reportId The unique ID of the Promoted Listings report you want to get. This ID is generated by eBay when
600
+ * you run a report task with a call to createReportTask.
601
+ */
602
+ getReport(reportId) {
603
+ reportId = encodeURIComponent(reportId);
604
+ return this.get(`/ad_report/${reportId}`);
605
+ }
606
+ /**
607
+ * This call retrieves information that details the fields used in each of the Promoted Listings reports.
608
+ */
609
+ getReportMetadata() {
610
+ return this.get(`/ad_report_metadata`);
611
+ }
612
+ /**
613
+ * This call retrieves metadata that details the fields used by the Promoted Listings report type that's specified
614
+ * by the report_type path parameter.
615
+ *
616
+ * @param reportType The name of the report type whose metadata you want to get.
617
+ */
618
+ getReportMetadataForReportType(reportType) {
619
+ reportType = encodeURIComponent(reportType);
620
+ return this.get(`/ad_report_metadata/${reportType}`);
621
+ }
622
+ /**
623
+ * This method returns information on all the existing report tasks related to a seller.
624
+ *
625
+ * @param limit Specifies the maximum number of report tasks to return on a page in the paginated response.
626
+ * Default: 10 Maximum: 500
627
+ * @param offset Specifies the number of report tasks to skip in the result set before returning the first report
628
+ * in the paginated response.
629
+ * @param reportTaskStatuses This parameter filters the returned report tasks by their status. Supply a
630
+ * comma-separated list of the report statuses you want returned.
631
+ */
632
+ getReportTasks({ limit, offset, reportTaskStatuses } = {}) {
633
+ return this.get(`/ad_report_task`, {
634
+ params: {
635
+ limit,
636
+ offset,
637
+ report_task_statuses: reportTaskStatuses
638
+ }
639
+ });
640
+ }
641
+ /**
642
+ * This call returns the details of a specific Promoted Listings report task, as specified by the report_task_id
643
+ * path parameter. T
644
+ *
645
+ * @param reportTaskId A unique eBay-assigned ID for the report task that's generated when the report task is
646
+ * created by a call to createReportTask.
647
+ */
648
+ getReportTask(reportTaskId) {
649
+ reportTaskId = encodeURIComponent(reportTaskId);
650
+ return this.get(`/ad_report_task/${reportTaskId}`);
651
+ }
652
+ /**
653
+ * This method creates a report task, which generates a Promoted Listings report based on the values specified in
654
+ * the call.
655
+ *
656
+ * @param body The container for the fields that define the report task.
657
+ */
658
+ createReportTask(body) {
659
+ return this.post(`/ad_report_task`, body);
660
+ }
661
+ /**
662
+ * This call deletes the report task specified by the report_task_id path parameter.
663
+ *
664
+ * @param reportTaskId A unique eBay-assigned ID for the report task that's generated when the report task is
665
+ * created by a call to createReportTask.
666
+ */
667
+ deleteReportTask(reportTaskId) {
668
+ reportTaskId = encodeURIComponent(reportTaskId);
669
+ return this.delete(`/ad_report_task/${reportTaskId}`);
670
+ }
671
+ /**
672
+ * This method creates an item price markdown promotion (know simply as a &quot;markdown promotion&quot;) where a
673
+ * discount amount is applied directly to the items included the promotion.
674
+ *
675
+ * @param body This type defines the fields that describe an item price markdown promotion.
676
+ */
677
+ createItemPriceMarkdownPromotion(body) {
678
+ return this.post(`/item_price_markdown`, body);
679
+ }
680
+ /**
681
+ * This method updates the specified item price markdown promotion with the new configuration that you supply in
682
+ * the payload of the request.
683
+ *
684
+ * @param promotionId The ID of the promotion you want to update.
685
+ * @param body This type defines the fields that describe an item price markdown promotion.
686
+ */
687
+ updateItemPriceMarkdownPromotion(promotionId, body) {
688
+ promotionId = encodeURIComponent(promotionId);
689
+ return this.put(`/item_price_markdown/${promotionId}`, body);
690
+ }
691
+ /**
692
+ * This method deletes the item price markdown promotion specified by the promotion_id path parameter.
693
+ *
694
+ * @param promotionId The ID of the promotion you want to delete.
695
+ */
696
+ deleteItemPriceMarkdownPromotion(promotionId) {
697
+ promotionId = encodeURIComponent(promotionId);
698
+ return this.delete(`/item_price_markdown/${promotionId}`);
699
+ }
700
+ /**
701
+ * This method returns the complete details of the item price markdown promotion that's indicated by the
702
+ * promotion_id path parameter.
703
+ *
704
+ * @param promotionId The ID of the promotion you want to retrieve.
705
+ */
706
+ getItemPriceMarkdownPromotion(promotionId) {
707
+ promotionId = encodeURIComponent(promotionId);
708
+ return this.get(`/item_price_markdown/${promotionId}`);
709
+ }
710
+ /**
711
+ * This method creates an item promotion (known casually as a &quot;threshold promotion&quot;) where the buyer
712
+ * receives a discount when they meet the buying criteria that's set for the promotion.
713
+ *
714
+ * @param body This type defines the fields that describe an item promotion.
715
+ */
716
+ createItemPromotion(body) {
717
+ return this.post(`/item_promotion`, body);
718
+ }
719
+ /**
720
+ * This method updates the specified threshold promotion with the new configuration that you supply in the request.
721
+ *
722
+ * @param promotionId The ID of the promotion you want to retrieve. The promotion ID is a unique eBay-assigned
723
+ * value that's generated when the promotion is created.
724
+ * @param body type defines the fields that describe an item promotion.
725
+ */
726
+ updateItemPromotion(promotionId, body) {
727
+ promotionId = encodeURIComponent(promotionId);
728
+ return this.put(`/item_promotion/${promotionId}`, body);
729
+ }
730
+ /**
731
+ * This method deletes the threshold promotion specified by the promotion_id path parameter.
732
+ *
733
+ * @param promotionId The ID of the promotion you want to retrieve. The promotion ID is a unique eBay-assigned
734
+ * value that's generated when the promotion is created.
735
+ */
736
+ deleteItemPromotion(promotionId) {
737
+ promotionId = encodeURIComponent(promotionId);
738
+ return this.delete(`/item_promotion/${promotionId}`);
739
+ }
740
+ /**
741
+ * This method returns the complete details of the threshold promotion specified by the promotion_id path
742
+ * parameter.
743
+ *
744
+ * @param promotionId The ID of the promotion you want to retrieve. The promotion ID is a unique eBay-assigned
745
+ * value that's generated when the promotion is created.
746
+ */
747
+ getItemPromotion(promotionId) {
748
+ promotionId = encodeURIComponent(promotionId);
749
+ return this.get(`/item_promotion/${promotionId}`);
750
+ }
751
+ /**
752
+ * This method returns the set of listings associated with the promotion_id specified in the path parameter.
753
+ *
754
+ * @param promotionId The ID of the promotion whose associated listings you want to retrieve.
755
+ * @param limit Specifies the maximum number of promotions returned on a page from the result set. Default: 200
756
+ * Maximum: 200
757
+ * @param offset Specifies the number of promotions to skip in the result set before returning the first promotion
758
+ * in the paginated response.
759
+ * @param q Reserved for future use.
760
+ * @param sort Specifies the order in which to sort the associated listings in the response.
761
+ * @param status This query parameter applies only to markdown promotions.
762
+ */
763
+ getListingSet(promotionId, { limit, offset, q, sort, status } = {}) {
764
+ promotionId = encodeURIComponent(promotionId);
765
+ return this.get(`/promotion/${promotionId}/get_listing_set`, {
766
+ params: {
767
+ limit,
768
+ offset,
769
+ q,
770
+ sort,
771
+ status
772
+ }
773
+ });
774
+ }
775
+ /**
776
+ * This method returns a list of a seller's undeleted promotions.
777
+ *
778
+ * @param marketplaceId The eBay marketplace ID of the site where the promotion is hosted.
779
+ * @param limit Specifies the maximum number of promotions returned on a page from the result set. Default: 200
780
+ * Maximum: 200
781
+ * @param offset Specifies the number of promotions to skip in the result set before returning the first promotion
782
+ * in the paginated response.
783
+ * @param promotionStatus Specifies the promotion state by which you want to filter the results.
784
+ * @param promotionType Filters the returned promotions based on the their campaign promotion type.
785
+ * @param q A string consisting of one or more keywords.
786
+ * @param sort Specifies the order for how to sort the response.
787
+ */
788
+ getPromotions(marketplaceId, { limit, offset, promotionStatus, promotionType, q, sort } = {}) {
789
+ return this.get(`/promotion`, {
790
+ params: {
791
+ marketplace_id: marketplaceId,
792
+ limit,
793
+ offset,
794
+ promotion_status: promotionStatus,
795
+ promotion_type: promotionType,
796
+ q,
797
+ sort
798
+ }
799
+ });
800
+ }
801
+ /**
802
+ * This method pauses a currently-active (RUNNING) threshold promotion and changes the state of the promotion from
803
+ * RUNNING to PAUSED.
804
+ *
805
+ * @param promotionId Identifier of the promotion you want to pause.
806
+ */
807
+ pausePromotion(promotionId) {
808
+ const id = encodeURIComponent(promotionId);
809
+ return this.post(`/promotion/${id}/pause`);
810
+ }
811
+ /**
812
+ * This method restarts a threshold promotion that was previously paused and changes the state of the promotion
813
+ * from PAUSED to RUNNING.
814
+ *
815
+ * @param promotionId Identifier of the promotion you want to make active. The ID is a unique eBay-assigned value
816
+ * that's generated when the promotion is created.
817
+ */
818
+ resumePromotion(promotionId) {
819
+ const id = encodeURIComponent(promotionId);
820
+ return this.post(`/promotion/${id}/resume`);
821
+ }
822
+ /**
823
+ * This method generates a report that lists the seller's running, paused, and ended promotions for the specified
824
+ * eBay marketplace.
825
+ *
826
+ * @param marketplaceId The eBay marketplace ID of the siteId for which you want the promotions report.
827
+ * @param limit Specifies the maximum number of promotions returned on a page from the result set. Default: 200
828
+ * Maximum: 200
829
+ * @param offset Specifies the number of promotions to skip in the result set before returning the first promotion
830
+ * in the paginated response.
831
+ * @param promotionStatus Limits the results to the promotions that are in the state specified by this query
832
+ * parameter.
833
+ * @param promotionType Filters the returned promotions in the report based on the their campaign promotion type.
834
+ * @param q A string consisting of one or more keywords. eBay filters the response by returning only the promotions
835
+ * that contain the supplied keywords in the promotion title.
836
+ */
837
+ getPromotionReports(marketplaceId, { limit, offset, promotionStatus, promotionType, q } = {}) {
838
+ return this.get(`/promotion_report`, {
839
+ params: {
840
+ marketplace_id: marketplaceId,
841
+ limit,
842
+ offset,
843
+ promotion_status: promotionStatus,
844
+ promotion_type: promotionType,
845
+ q
846
+ }
847
+ });
848
+ }
849
+ /**
850
+ * This method generates a report that summarizes the seller's promotions for the specified eBay marketplace.
851
+ *
852
+ * @param marketplaceId The eBay marketplace ID of the siteId you for which you want a promotion summary report.
853
+ */
854
+ getPromotionSummaryReport(marketplaceId) {
855
+ return this.get(`/promotion_summary_report`, {
856
+ params: {
857
+ marketplace_id: marketplaceId
858
+ }
859
+ });
860
+ }
861
+ }
862
+ Marketing.id = 'Marketing';
863
+ export default Marketing;