ebay-api 8.5.0 → 8.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (320) hide show
  1. package/README.md +4 -4
  2. package/dist/api/apiFactory.d.ts +0 -3
  3. package/dist/api/apiFactory.js +0 -4
  4. package/dist/api/base.d.ts +0 -3
  5. package/dist/api/base.js +0 -3
  6. package/dist/api/digitalSignature.d.ts +0 -33
  7. package/dist/api/digitalSignature.js +1 -41
  8. package/dist/api/index.d.ts +0 -3
  9. package/dist/api/index.js +0 -3
  10. package/dist/api/restful/buy/browse/index.d.ts +0 -66
  11. package/dist/api/restful/buy/browse/index.js +0 -73
  12. package/dist/api/restful/buy/deal/index.d.ts +0 -32
  13. package/dist/api/restful/buy/deal/index.js +0 -32
  14. package/dist/api/restful/buy/feed/index.d.ts +0 -33
  15. package/dist/api/restful/buy/feed/index.js +0 -33
  16. package/dist/api/restful/buy/marketing/index.d.ts +0 -18
  17. package/dist/api/restful/buy/marketing/index.js +0 -22
  18. package/dist/api/restful/buy/marketplaceInsights/index.d.ts +0 -21
  19. package/dist/api/restful/buy/marketplaceInsights/index.js +0 -21
  20. package/dist/api/restful/buy/offer/index.d.ts +0 -15
  21. package/dist/api/restful/buy/offer/index.js +0 -15
  22. package/dist/api/restful/buy/order/index.d.ts +0 -227
  23. package/dist/api/restful/buy/order/index.js +0 -227
  24. package/dist/api/restful/commerce/catalog/index.d.ts +0 -54
  25. package/dist/api/restful/commerce/catalog/index.js +0 -54
  26. package/dist/api/restful/commerce/charity/index.d.ts +0 -21
  27. package/dist/api/restful/commerce/charity/index.js +0 -21
  28. package/dist/api/restful/commerce/identity/index.d.ts +0 -7
  29. package/dist/api/restful/commerce/identity/index.js +0 -7
  30. package/dist/api/restful/commerce/notification/index.d.ts +0 -93
  31. package/dist/api/restful/commerce/notification/index.js +0 -93
  32. package/dist/api/restful/commerce/taxonomy/index.d.ts +0 -64
  33. package/dist/api/restful/commerce/taxonomy/index.js +0 -64
  34. package/dist/api/restful/commerce/translation/index.d.ts +0 -8
  35. package/dist/api/restful/commerce/translation/index.js +0 -8
  36. package/dist/api/restful/developer/analytics/index.d.ts +0 -15
  37. package/dist/api/restful/developer/analytics/index.js +0 -15
  38. package/dist/api/restful/developer/keyManagement/index.d.ts +0 -15
  39. package/dist/api/restful/developer/keyManagement/index.js +0 -15
  40. package/dist/api/restful/index.d.ts +0 -16
  41. package/dist/api/restful/index.js +1 -23
  42. package/dist/api/restful/postOrder/cancellation/index.d.ts +0 -43
  43. package/dist/api/restful/postOrder/cancellation/index.js +0 -43
  44. package/dist/api/restful/postOrder/case/index.d.ts +0 -46
  45. package/dist/api/restful/postOrder/case/index.js +0 -46
  46. package/dist/api/restful/postOrder/inquiry/index.d.ts +0 -64
  47. package/dist/api/restful/postOrder/inquiry/index.js +0 -64
  48. package/dist/api/restful/postOrder/return/index.d.ts +0 -190
  49. package/dist/api/restful/postOrder/return/index.js +0 -190
  50. package/dist/api/restful/sell/account/index.d.ts +0 -241
  51. package/dist/api/restful/sell/account/index.js +0 -241
  52. package/dist/api/restful/sell/analytics/index.d.ts +0 -26
  53. package/dist/api/restful/sell/analytics/index.js +0 -26
  54. package/dist/api/restful/sell/compliance/index.d.ts +0 -23
  55. package/dist/api/restful/sell/compliance/index.js +0 -23
  56. package/dist/api/restful/sell/feed/index.d.ts +0 -135
  57. package/dist/api/restful/sell/feed/index.js +0 -135
  58. package/dist/api/restful/sell/finances/index.d.ts +0 -51
  59. package/dist/api/restful/sell/finances/index.js +0 -51
  60. package/dist/api/restful/sell/fulfillment/index.d.ts +0 -108
  61. package/dist/api/restful/sell/fulfillment/index.js +0 -108
  62. package/dist/api/restful/sell/inventory/index.d.ts +0 -197
  63. package/dist/api/restful/sell/inventory/index.js +0 -197
  64. package/dist/api/restful/sell/listing/index.d.ts +0 -8
  65. package/dist/api/restful/sell/listing/index.js +0 -8
  66. package/dist/api/restful/sell/logistics/index.d.ts +0 -33
  67. package/dist/api/restful/sell/logistics/index.js +0 -33
  68. package/dist/api/restful/sell/marketing/index.d.ts +16 -495
  69. package/dist/api/restful/sell/marketing/index.js +48 -494
  70. package/dist/api/restful/sell/metadata/index.d.ts +0 -65
  71. package/dist/api/restful/sell/metadata/index.js +0 -65
  72. package/dist/api/restful/sell/negotiation/index.d.ts +0 -14
  73. package/dist/api/restful/sell/negotiation/index.js +0 -14
  74. package/dist/api/restful/sell/recommendation/index.d.ts +0 -15
  75. package/dist/api/restful/sell/recommendation/index.js +0 -15
  76. package/dist/api/traditional/XMLRequest.d.ts +0 -44
  77. package/dist/api/traditional/XMLRequest.js +0 -46
  78. package/dist/api/traditional/clientAlerts/index.js +0 -1
  79. package/dist/api/traditional/index.d.ts +0 -3
  80. package/dist/api/traditional/index.js +0 -5
  81. package/dist/api/traditional/shopping/index.js +0 -1
  82. package/dist/auth/authNAuth.d.ts +0 -5
  83. package/dist/auth/authNAuth.js +0 -5
  84. package/dist/auth/index.d.ts +0 -3
  85. package/dist/auth/index.js +0 -3
  86. package/dist/auth/oAuth2.d.ts +0 -52
  87. package/dist/auth/oAuth2.js +0 -53
  88. package/dist/eBayApi.d.ts +1 -12
  89. package/dist/eBayApi.js +0 -14
  90. package/dist/ebay-api.min.mjs +1 -1
  91. package/dist/enums/restfulEnums.d.ts +24 -23
  92. package/dist/enums/restfulEnums.js +52 -51
  93. package/dist/errors/index.d.ts +0 -19
  94. package/dist/errors/index.js +1 -20
  95. package/dist/types/apiTypes.d.ts +2 -2
  96. package/dist/types/restful/specs/buy_browse_v1_oas3.d.ts +0 -697
  97. package/dist/types/restful/specs/buy_browse_v1_oas3.js +0 -4
  98. package/dist/types/restful/specs/buy_deal_v1_oas3.d.ts +0 -189
  99. package/dist/types/restful/specs/buy_deal_v1_oas3.js +0 -4
  100. package/dist/types/restful/specs/buy_feed_v1_beta_oas3.d.ts +0 -229
  101. package/dist/types/restful/specs/buy_feed_v1_beta_oas3.js +0 -4
  102. package/dist/types/restful/specs/buy_marketing_v1_beta_oas3.d.ts +0 -101
  103. package/dist/types/restful/specs/buy_marketing_v1_beta_oas3.js +0 -4
  104. package/dist/types/restful/specs/buy_marketplace_insights_v1_beta_oas3.d.ts +0 -150
  105. package/dist/types/restful/specs/buy_marketplace_insights_v1_beta_oas3.js +0 -4
  106. package/dist/types/restful/specs/buy_offer_v1_beta_oas3.d.ts +0 -62
  107. package/dist/types/restful/specs/buy_offer_v1_beta_oas3.js +0 -4
  108. package/dist/types/restful/specs/buy_order_v1_beta_oas3.d.ts +0 -600
  109. package/dist/types/restful/specs/buy_order_v1_beta_oas3.js +0 -4
  110. package/dist/types/restful/specs/cancellation_oas3.d.ts +0 -29
  111. package/dist/types/restful/specs/cancellation_oas3.js +0 -4
  112. package/dist/types/restful/specs/case_oas3.d.ts +0 -31
  113. package/dist/types/restful/specs/case_oas3.js +0 -4
  114. package/dist/types/restful/specs/commerce_catalog_v1_beta_oas3.d.ts +0 -331
  115. package/dist/types/restful/specs/commerce_catalog_v1_beta_oas3.js +0 -4
  116. package/dist/types/restful/specs/commerce_charity_v1_oas3.d.ts +0 -85
  117. package/dist/types/restful/specs/commerce_charity_v1_oas3.js +0 -4
  118. package/dist/types/restful/specs/commerce_identity_v1_oas3.d.ts +0 -63
  119. package/dist/types/restful/specs/commerce_identity_v1_oas3.js +0 -4
  120. package/dist/types/restful/specs/commerce_notification_v1_oas3.d.ts +0 -236
  121. package/dist/types/restful/specs/commerce_notification_v1_oas3.js +0 -4
  122. package/dist/types/restful/specs/commerce_taxonomy_v1_oas3.d.ts +0 -219
  123. package/dist/types/restful/specs/commerce_taxonomy_v1_oas3.js +0 -4
  124. package/dist/types/restful/specs/commerce_translation_v1_beta_oas3.d.ts +0 -36
  125. package/dist/types/restful/specs/commerce_translation_v1_beta_oas3.js +0 -4
  126. package/dist/types/restful/specs/developer_analytics_v1_beta_oas3.d.ts +0 -57
  127. package/dist/types/restful/specs/developer_analytics_v1_beta_oas3.js +0 -4
  128. package/dist/types/restful/specs/developer_key_management_v1_oas3.d.ts +0 -60
  129. package/dist/types/restful/specs/developer_key_management_v1_oas3.js +0 -4
  130. package/dist/types/restful/specs/inquiry_oas3.d.ts +0 -45
  131. package/dist/types/restful/specs/inquiry_oas3.js +0 -4
  132. package/dist/types/restful/specs/return_oas3.d.ts +0 -130
  133. package/dist/types/restful/specs/return_oas3.js +0 -4
  134. package/dist/types/restful/specs/sell_account_v1_oas3.d.ts +0 -751
  135. package/dist/types/restful/specs/sell_account_v1_oas3.js +0 -4
  136. package/dist/types/restful/specs/sell_analytics_v1_oas3.d.ts +0 -130
  137. package/dist/types/restful/specs/sell_analytics_v1_oas3.js +0 -4
  138. package/dist/types/restful/specs/sell_compliance_v1_oas3.d.ts +0 -102
  139. package/dist/types/restful/specs/sell_compliance_v1_oas3.js +0 -4
  140. package/dist/types/restful/specs/sell_feed_v1_oas3.d.ts +0 -461
  141. package/dist/types/restful/specs/sell_feed_v1_oas3.js +0 -4
  142. package/dist/types/restful/specs/sell_finances_v1_oas3.d.ts +0 -255
  143. package/dist/types/restful/specs/sell_finances_v1_oas3.js +0 -4
  144. package/dist/types/restful/specs/sell_fulfillment_v1_oas3.d.ts +0 -595
  145. package/dist/types/restful/specs/sell_fulfillment_v1_oas3.js +0 -4
  146. package/dist/types/restful/specs/sell_inventory_v1_oas3.d.ts +0 -844
  147. package/dist/types/restful/specs/sell_inventory_v1_oas3.js +0 -4
  148. package/dist/types/restful/specs/sell_listing_v1_beta_oas3.d.ts +0 -57
  149. package/dist/types/restful/specs/sell_listing_v1_beta_oas3.js +0 -4
  150. package/dist/types/restful/specs/sell_logistics_v1_oas3.d.ts +0 -173
  151. package/dist/types/restful/specs/sell_logistics_v1_oas3.js +0 -4
  152. package/dist/types/restful/specs/sell_marketing_v1_oas3.d.ts +454 -1411
  153. package/dist/types/restful/specs/sell_marketing_v1_oas3.js +0 -4
  154. package/dist/types/restful/specs/sell_metadata_v1_oas3.d.ts +0 -147
  155. package/dist/types/restful/specs/sell_metadata_v1_oas3.js +0 -4
  156. package/dist/types/restful/specs/sell_negotiation_v1_oas3.d.ts +0 -94
  157. package/dist/types/restful/specs/sell_negotiation_v1_oas3.js +0 -4
  158. package/dist/types/restful/specs/sell_recommendation_v1_oas3.d.ts +0 -60
  159. package/dist/types/restful/specs/sell_recommendation_v1_oas3.js +0 -4
  160. package/dist/types/restfulTypes.d.ts +3 -0
  161. package/lib/api/apiFactory.d.ts +0 -3
  162. package/lib/api/apiFactory.js +0 -4
  163. package/lib/api/base.d.ts +0 -3
  164. package/lib/api/base.js +0 -3
  165. package/lib/api/digitalSignature.d.ts +0 -33
  166. package/lib/api/digitalSignature.js +1 -41
  167. package/lib/api/index.d.ts +0 -3
  168. package/lib/api/index.js +0 -3
  169. package/lib/api/restful/buy/browse/index.d.ts +0 -66
  170. package/lib/api/restful/buy/browse/index.js +0 -73
  171. package/lib/api/restful/buy/deal/index.d.ts +0 -32
  172. package/lib/api/restful/buy/deal/index.js +0 -32
  173. package/lib/api/restful/buy/feed/index.d.ts +0 -33
  174. package/lib/api/restful/buy/feed/index.js +0 -33
  175. package/lib/api/restful/buy/marketing/index.d.ts +0 -18
  176. package/lib/api/restful/buy/marketing/index.js +0 -22
  177. package/lib/api/restful/buy/marketplaceInsights/index.d.ts +0 -21
  178. package/lib/api/restful/buy/marketplaceInsights/index.js +0 -21
  179. package/lib/api/restful/buy/offer/index.d.ts +0 -15
  180. package/lib/api/restful/buy/offer/index.js +0 -15
  181. package/lib/api/restful/buy/order/index.d.ts +0 -227
  182. package/lib/api/restful/buy/order/index.js +0 -227
  183. package/lib/api/restful/commerce/catalog/index.d.ts +0 -54
  184. package/lib/api/restful/commerce/catalog/index.js +0 -54
  185. package/lib/api/restful/commerce/charity/index.d.ts +0 -21
  186. package/lib/api/restful/commerce/charity/index.js +0 -21
  187. package/lib/api/restful/commerce/identity/index.d.ts +0 -7
  188. package/lib/api/restful/commerce/identity/index.js +0 -7
  189. package/lib/api/restful/commerce/notification/index.d.ts +0 -93
  190. package/lib/api/restful/commerce/notification/index.js +0 -93
  191. package/lib/api/restful/commerce/taxonomy/index.d.ts +0 -64
  192. package/lib/api/restful/commerce/taxonomy/index.js +0 -64
  193. package/lib/api/restful/commerce/translation/index.d.ts +0 -8
  194. package/lib/api/restful/commerce/translation/index.js +0 -8
  195. package/lib/api/restful/developer/analytics/index.d.ts +0 -15
  196. package/lib/api/restful/developer/analytics/index.js +0 -15
  197. package/lib/api/restful/developer/keyManagement/index.d.ts +0 -15
  198. package/lib/api/restful/developer/keyManagement/index.js +0 -15
  199. package/lib/api/restful/index.d.ts +0 -16
  200. package/lib/api/restful/index.js +1 -23
  201. package/lib/api/restful/postOrder/cancellation/index.d.ts +0 -43
  202. package/lib/api/restful/postOrder/cancellation/index.js +0 -43
  203. package/lib/api/restful/postOrder/case/index.d.ts +0 -46
  204. package/lib/api/restful/postOrder/case/index.js +0 -46
  205. package/lib/api/restful/postOrder/inquiry/index.d.ts +0 -64
  206. package/lib/api/restful/postOrder/inquiry/index.js +0 -64
  207. package/lib/api/restful/postOrder/return/index.d.ts +0 -190
  208. package/lib/api/restful/postOrder/return/index.js +0 -190
  209. package/lib/api/restful/sell/account/index.d.ts +0 -241
  210. package/lib/api/restful/sell/account/index.js +0 -241
  211. package/lib/api/restful/sell/analytics/index.d.ts +0 -26
  212. package/lib/api/restful/sell/analytics/index.js +0 -26
  213. package/lib/api/restful/sell/compliance/index.d.ts +0 -23
  214. package/lib/api/restful/sell/compliance/index.js +0 -23
  215. package/lib/api/restful/sell/feed/index.d.ts +0 -135
  216. package/lib/api/restful/sell/feed/index.js +0 -135
  217. package/lib/api/restful/sell/finances/index.d.ts +0 -51
  218. package/lib/api/restful/sell/finances/index.js +0 -51
  219. package/lib/api/restful/sell/fulfillment/index.d.ts +0 -108
  220. package/lib/api/restful/sell/fulfillment/index.js +0 -108
  221. package/lib/api/restful/sell/inventory/index.d.ts +0 -197
  222. package/lib/api/restful/sell/inventory/index.js +0 -197
  223. package/lib/api/restful/sell/listing/index.d.ts +0 -8
  224. package/lib/api/restful/sell/listing/index.js +0 -8
  225. package/lib/api/restful/sell/logistics/index.d.ts +0 -33
  226. package/lib/api/restful/sell/logistics/index.js +0 -33
  227. package/lib/api/restful/sell/marketing/index.d.ts +16 -495
  228. package/lib/api/restful/sell/marketing/index.js +48 -494
  229. package/lib/api/restful/sell/metadata/index.d.ts +0 -65
  230. package/lib/api/restful/sell/metadata/index.js +0 -65
  231. package/lib/api/restful/sell/negotiation/index.d.ts +0 -14
  232. package/lib/api/restful/sell/negotiation/index.js +0 -14
  233. package/lib/api/restful/sell/recommendation/index.d.ts +0 -15
  234. package/lib/api/restful/sell/recommendation/index.js +0 -15
  235. package/lib/api/traditional/XMLRequest.d.ts +0 -44
  236. package/lib/api/traditional/XMLRequest.js +0 -46
  237. package/lib/api/traditional/clientAlerts/index.js +0 -1
  238. package/lib/api/traditional/index.d.ts +0 -3
  239. package/lib/api/traditional/index.js +0 -5
  240. package/lib/api/traditional/shopping/index.js +0 -1
  241. package/lib/auth/authNAuth.d.ts +0 -5
  242. package/lib/auth/authNAuth.js +0 -5
  243. package/lib/auth/index.d.ts +0 -3
  244. package/lib/auth/index.js +0 -3
  245. package/lib/auth/oAuth2.d.ts +0 -52
  246. package/lib/auth/oAuth2.js +0 -53
  247. package/lib/eBayApi.d.ts +1 -12
  248. package/lib/eBayApi.js +0 -14
  249. package/lib/ebay-api.min.js +1 -1
  250. package/lib/enums/restfulEnums.d.ts +24 -23
  251. package/lib/enums/restfulEnums.js +52 -52
  252. package/lib/errors/index.d.ts +0 -19
  253. package/lib/errors/index.js +1 -20
  254. package/lib/types/apiTypes.d.ts +2 -2
  255. package/lib/types/restful/specs/buy_browse_v1_oas3.d.ts +0 -697
  256. package/lib/types/restful/specs/buy_browse_v1_oas3.js +0 -4
  257. package/lib/types/restful/specs/buy_deal_v1_oas3.d.ts +0 -189
  258. package/lib/types/restful/specs/buy_deal_v1_oas3.js +0 -4
  259. package/lib/types/restful/specs/buy_feed_v1_beta_oas3.d.ts +0 -229
  260. package/lib/types/restful/specs/buy_feed_v1_beta_oas3.js +0 -4
  261. package/lib/types/restful/specs/buy_marketing_v1_beta_oas3.d.ts +0 -101
  262. package/lib/types/restful/specs/buy_marketing_v1_beta_oas3.js +0 -4
  263. package/lib/types/restful/specs/buy_marketplace_insights_v1_beta_oas3.d.ts +0 -150
  264. package/lib/types/restful/specs/buy_marketplace_insights_v1_beta_oas3.js +0 -4
  265. package/lib/types/restful/specs/buy_offer_v1_beta_oas3.d.ts +0 -62
  266. package/lib/types/restful/specs/buy_offer_v1_beta_oas3.js +0 -4
  267. package/lib/types/restful/specs/buy_order_v1_beta_oas3.d.ts +0 -600
  268. package/lib/types/restful/specs/buy_order_v1_beta_oas3.js +0 -4
  269. package/lib/types/restful/specs/cancellation_oas3.d.ts +0 -29
  270. package/lib/types/restful/specs/cancellation_oas3.js +0 -4
  271. package/lib/types/restful/specs/case_oas3.d.ts +0 -31
  272. package/lib/types/restful/specs/case_oas3.js +0 -4
  273. package/lib/types/restful/specs/commerce_catalog_v1_beta_oas3.d.ts +0 -331
  274. package/lib/types/restful/specs/commerce_catalog_v1_beta_oas3.js +0 -4
  275. package/lib/types/restful/specs/commerce_charity_v1_oas3.d.ts +0 -85
  276. package/lib/types/restful/specs/commerce_charity_v1_oas3.js +0 -4
  277. package/lib/types/restful/specs/commerce_identity_v1_oas3.d.ts +0 -63
  278. package/lib/types/restful/specs/commerce_identity_v1_oas3.js +0 -4
  279. package/lib/types/restful/specs/commerce_notification_v1_oas3.d.ts +0 -236
  280. package/lib/types/restful/specs/commerce_notification_v1_oas3.js +0 -4
  281. package/lib/types/restful/specs/commerce_taxonomy_v1_oas3.d.ts +0 -219
  282. package/lib/types/restful/specs/commerce_taxonomy_v1_oas3.js +0 -4
  283. package/lib/types/restful/specs/commerce_translation_v1_beta_oas3.d.ts +0 -36
  284. package/lib/types/restful/specs/commerce_translation_v1_beta_oas3.js +0 -4
  285. package/lib/types/restful/specs/developer_analytics_v1_beta_oas3.d.ts +0 -57
  286. package/lib/types/restful/specs/developer_analytics_v1_beta_oas3.js +0 -4
  287. package/lib/types/restful/specs/developer_key_management_v1_oas3.d.ts +0 -60
  288. package/lib/types/restful/specs/developer_key_management_v1_oas3.js +0 -4
  289. package/lib/types/restful/specs/inquiry_oas3.d.ts +0 -45
  290. package/lib/types/restful/specs/inquiry_oas3.js +0 -4
  291. package/lib/types/restful/specs/return_oas3.d.ts +0 -130
  292. package/lib/types/restful/specs/return_oas3.js +0 -4
  293. package/lib/types/restful/specs/sell_account_v1_oas3.d.ts +0 -751
  294. package/lib/types/restful/specs/sell_account_v1_oas3.js +0 -4
  295. package/lib/types/restful/specs/sell_analytics_v1_oas3.d.ts +0 -130
  296. package/lib/types/restful/specs/sell_analytics_v1_oas3.js +0 -4
  297. package/lib/types/restful/specs/sell_compliance_v1_oas3.d.ts +0 -102
  298. package/lib/types/restful/specs/sell_compliance_v1_oas3.js +0 -4
  299. package/lib/types/restful/specs/sell_feed_v1_oas3.d.ts +0 -461
  300. package/lib/types/restful/specs/sell_feed_v1_oas3.js +0 -4
  301. package/lib/types/restful/specs/sell_finances_v1_oas3.d.ts +0 -255
  302. package/lib/types/restful/specs/sell_finances_v1_oas3.js +0 -4
  303. package/lib/types/restful/specs/sell_fulfillment_v1_oas3.d.ts +0 -595
  304. package/lib/types/restful/specs/sell_fulfillment_v1_oas3.js +0 -4
  305. package/lib/types/restful/specs/sell_inventory_v1_oas3.d.ts +0 -844
  306. package/lib/types/restful/specs/sell_inventory_v1_oas3.js +0 -4
  307. package/lib/types/restful/specs/sell_listing_v1_beta_oas3.d.ts +0 -57
  308. package/lib/types/restful/specs/sell_listing_v1_beta_oas3.js +0 -4
  309. package/lib/types/restful/specs/sell_logistics_v1_oas3.d.ts +0 -173
  310. package/lib/types/restful/specs/sell_logistics_v1_oas3.js +0 -4
  311. package/lib/types/restful/specs/sell_marketing_v1_oas3.d.ts +454 -1411
  312. package/lib/types/restful/specs/sell_marketing_v1_oas3.js +0 -4
  313. package/lib/types/restful/specs/sell_metadata_v1_oas3.d.ts +0 -147
  314. package/lib/types/restful/specs/sell_metadata_v1_oas3.js +0 -4
  315. package/lib/types/restful/specs/sell_negotiation_v1_oas3.d.ts +0 -94
  316. package/lib/types/restful/specs/sell_negotiation_v1_oas3.js +0 -4
  317. package/lib/types/restful/specs/sell_recommendation_v1_oas3.d.ts +0 -60
  318. package/lib/types/restful/specs/sell_recommendation_v1_oas3.js +0 -4
  319. package/lib/types/restfulTypes.d.ts +3 -0
  320. package/package.json +2 -2
package/README.md CHANGED
@@ -21,7 +21,7 @@ It supports `client credentials grant` and `authorization code grant` \(Auth'N'A
21
21
 
22
22
  ## Changelog
23
23
 
24
- * `v8.5.0` is the latest release.
24
+ * `v8.6.0` is the latest release.
25
25
  * See [here](https://github.com/hendt/ebay-api/blob/master/CHANGELOG.md) for the full changelog.
26
26
 
27
27
  ## Implementation status
@@ -34,7 +34,7 @@ It supports `client credentials grant` and `authorization code grant` \(Auth'N'A
34
34
  | **Commerce API** | ✔ Catalog API<br>✔ Charity API `v1.2.0`<br>✔ Identity API<br>✔ Notification API `v1.2.0`<br>✔ Taxonomy API `v1.0.0`<br>✔ Translation API `v1_beta.1.4` |
35
35
  | **Developer API** | ✔ Analytics API |
36
36
  | **Post Order API** | ✔ Cancellation API<br>✔ Case Management API<br>✔ Inquiry API<br>✔ Return API |
37
- | **Sell API** | ✔ Account API `v1.9.0`<br>✔ Analytics API `v1.3.0`<br>✔ Compliance API `v1.4.1`<br>✔ Feed API<br>✔ Finance API `v1.9.0`<br>✔ Fulfillment API `v1.19.10`<br>✔ Inventory API `v1.14.0`<br>✔ Listing API<br>✔ Logistics API<br>✔ Marketing API `v1.14.0`<br>✔ Metadata API<br>✔ Negotiation API `v1.1.0`<br>✔ Recommendation API `v1.1.0` |
37
+ | **Sell API** | ✔ Account API `v1.9.0`<br>✔ Analytics API `v1.3.0`<br>✔ Compliance API `v1.4.1`<br>✔ Feed API<br>✔ Finance API `v1.9.0`<br>✔ Fulfillment API `v1.19.10`<br>✔ Inventory API `v1.14.0`<br>✔ Listing API<br>✔ Logistics API<br>✔ Marketing API `v1.17.0`<br>✔ Metadata API<br>✔ Negotiation API `v1.1.0`<br>✔ Recommendation API `v1.1.0` |
38
38
 
39
39
  ### Traditional API
40
40
 
@@ -90,7 +90,7 @@ const eBay = new eBayApi({
90
90
 
91
91
  marketplaceId: eBayApi.MarketplaceId.EBAY_US, // default. required for RESTful APIs
92
92
  acceptLanguage: eBayApi.Locale.en_US, // default
93
- contentLanguage: eBayApi.ContentLanguage.en_US, // default.
93
+ contentLanguage: eBayApi.Locale.en_US, // default.
94
94
 
95
95
  // optional parameters, should be omitted if not used
96
96
  devId: '-- devId --', // required for traditional Trading API
@@ -166,7 +166,7 @@ The first (required) parameter in eBayApi instance takes an object with followin
166
166
  | marketplaceId<br><i>RESTful</i> | Required<br><pre>Default: `MarketplaceId.EBAY_US`</pre> | [Docs](https://developer.ebay.com/api-docs/static/rest-request-components.html#marketpl) REST HTTP Header. X-EBAY-C-MARKETPLACE-ID identifies the user's business context and is specified using a marketplace ID value. Note that this header does not indicate a language preference or consumer location. |
167
167
  | scope<br><i>RESTful</i> | Conditionally<bre><pre>Default:<br>`['https://api.ebay.com/oauth/api_scope']` </pre> | The scopes assigned to your application allow access to different API resources and functionality. |
168
168
  | endUserCtx<br><i>RESTful</i> | Conditionally recommended<br><i>RESTful</i> | [Docs](https://developer.ebay.com/api-docs/static/rest-request-components.html#headers) X-EBAY\_C\_ENDUSERCTX provides various types of information associated with the request. |
169
- | contentLanguage<br><i>RESTful</i> | Conditionally required<br><pre>Default: `ContentLanguage.en_US`</pre> | [Docs](https://developer.ebay.com/api-docs/static/rest-request-components.html#headers)Content-Language indicates the locale preferred by the client for the response. |
169
+ | contentLanguage<br><i>RESTful</i> | Conditionally required<br><pre>Default: `Locale.en_US`</pre> | [Docs](https://developer.ebay.com/api-docs/static/rest-request-components.html#headers)Content-Language indicates the locale preferred by the client for the response. |
170
170
  | acceptLanguage<br><i>RESTful</i> | Optional<pre>Default: `Locale.en_US`</pre> | [Docs](https://developer.ebay.com/api-docs/static/rest-request-components.html#headers) Accept-Language indicates the natural language the client prefers for the response. This specifies the language the client wants to use when the field values provided in the request body are displayed to consumers. |
171
171
 
172
172
  ## Load config from environment
@@ -6,9 +6,6 @@ import { Developer } from './restful/developer/index.js';
6
6
  import { PostOrder } from './restful/postOrder/index.js';
7
7
  import { Sell } from './restful/sell/index.js';
8
8
  import Traditional from './traditional/index.js';
9
- /**
10
- * Factory class to create RESTFul API or Traditional API.
11
- */
12
9
  export default class ApiFactory extends Api {
13
10
  private _traditional?;
14
11
  private _restful;
@@ -5,9 +5,6 @@ import { Analytics as DeveloperAnalytics, KeyManagement } from './restful/develo
5
5
  import { Cancellation, Case, Inquiry, Return, } from './restful/postOrder/index.js';
6
6
  import { Account, Analytics as SellAnalytics, Compliance, Feed as SellFeed, Finances, Fulfillment, Inventory, Listing, Logistics, Marketing as SellMarketing, Metadata, Negotiation, Recommendation } from './restful/sell/index.js';
7
7
  import Traditional from './traditional/index.js';
8
- /**
9
- * Factory class to create RESTFul API or Traditional API.
10
- */
11
8
  export default class ApiFactory extends Api {
12
9
  constructor() {
13
10
  super(...arguments);
@@ -86,7 +83,6 @@ export default class ApiFactory extends Api {
86
83
  createMerchandisingApi() {
87
84
  return this.traditional.createMerchandisingApi();
88
85
  }
89
- // tslint:disable-next-line:variable-name
90
86
  createRestfulApi(RestfulApiClass) {
91
87
  const id = RestfulApiClass.id;
92
88
  return (this._restful[id] || (this._restful[id] = new RestfulApiClass(this.config, this.req, this.auth)));
@@ -1,8 +1,5 @@
1
1
  import { IEBayApiRequest } from '../request.js';
2
2
  import { AppConfig } from '../types/index.js';
3
- /**
4
- * Abstract superclass.
5
- */
6
3
  export default abstract class Base {
7
4
  readonly config: AppConfig;
8
5
  readonly req: IEBayApiRequest;
package/dist/api/base.js CHANGED
@@ -1,7 +1,4 @@
1
1
  import { AxiosRequest } from '../request.js';
2
- /**
3
- * Abstract superclass.
4
- */
5
2
  export default class Base {
6
3
  constructor(config, req = new AxiosRequest(config.axiosConfig)) {
7
4
  this.config = config;
@@ -1,43 +1,10 @@
1
1
  import { Cipher, Headers } from '../types/index.js';
2
- /**
3
- * Generates the 'Content-Digest' header value for the input payload.
4
- *
5
- * @param {any} payload The request payload.
6
- * @param {string} cipher The algorithm used to calculate the digest.
7
- * @returns {string} contentDigest The 'Content-Digest' header value.
8
- */
9
2
  export declare const generateContentDigestValue: (payload: unknown, cipher?: Cipher) => string;
10
3
  export type SignatureComponents = {
11
4
  method: string;
12
5
  authority: string;
13
6
  path: string;
14
7
  };
15
- /**
16
- * Generates the base string.
17
- *
18
- * @param {any} headers The HTTP request headers.
19
- * @param {SignatureComponents} signatureComponents The config.
20
- * @param {any} payload The payload.
21
- * @param {number} timestamp The timestamp.
22
- * @returns {string} payload The base string.
23
- */
24
8
  export declare function generateBaseString(headers: Headers, signatureComponents: SignatureComponents, payload: any, timestamp?: number): string;
25
- /**
26
- * Generates the Signature-Input header value for the input payload.
27
- *
28
- * @param {any} payload The input config.
29
- * @param {number} timestamp The timestamp.
30
- * @returns {string} the 'Signature-Input' header value.
31
- */
32
9
  export declare const generateSignatureInput: (payload: any, timestamp?: number) => string;
33
- /**
34
- * Generates the 'Signature' header.
35
- *
36
- * @param {any} headers The HTTP headers.
37
- * @param {string} privateKey The HTTP headers.
38
- * @param {SignatureComponents} signatureComponents The signature components
39
- * @param {any} payload The payload
40
- * @param {number} timestamp The payload
41
- * @returns {string} the signature header value.
42
- */
43
10
  export declare function generateSignature(headers: any, privateKey: string, signatureComponents: SignatureComponents, payload: any, timestamp?: number): string;
@@ -1,12 +1,6 @@
1
1
  import { createHash, sign } from 'crypto';
2
2
  const beginPrivateKey = '-----BEGIN PRIVATE KEY-----';
3
3
  const endPrivateKey = '-----END PRIVATE KEY-----';
4
- // based on https://github.com/ebay/digital-signature-nodejs-sdk
5
- /**
6
- * Returns the current UNIX timestamp.
7
- *
8
- * @returns {number} The unix timestamp.
9
- */
10
4
  const getUnixTimestamp = () => Date.now() / 1000 | 0;
11
5
  const getSignatureParams = (payload) => [
12
6
  ...payload ? ['content-digest'] : [],
@@ -16,28 +10,12 @@ const getSignatureParams = (payload) => [
16
10
  '@authority'
17
11
  ];
18
12
  const getSignatureParamsValue = (payload) => getSignatureParams(payload).map(param => `"${param}"`).join(' ');
19
- /**
20
- * Generates the 'Content-Digest' header value for the input payload.
21
- *
22
- * @param {any} payload The request payload.
23
- * @param {string} cipher The algorithm used to calculate the digest.
24
- * @returns {string} contentDigest The 'Content-Digest' header value.
25
- */
26
13
  export const generateContentDigestValue = (payload, cipher = 'sha256') => {
27
14
  const payloadBuffer = Buffer.from(typeof payload === 'string' ? payload : JSON.stringify(payload));
28
15
  const hash = createHash(cipher).update(payloadBuffer).digest('base64');
29
16
  const algo = cipher === 'sha512' ? 'sha-512' : 'sha-256';
30
17
  return `${algo}=:${hash}:`;
31
18
  };
32
- /**
33
- * Generates the base string.
34
- *
35
- * @param {any} headers The HTTP request headers.
36
- * @param {SignatureComponents} signatureComponents The config.
37
- * @param {any} payload The payload.
38
- * @param {number} timestamp The timestamp.
39
- * @returns {string} payload The base string.
40
- */
41
19
  export function generateBaseString(headers, signatureComponents, payload, timestamp = getUnixTimestamp()) {
42
20
  try {
43
21
  let baseString = '';
@@ -74,32 +52,14 @@ export function generateBaseString(headers, signatureComponents, payload, timest
74
52
  throw new Error(`Error calculating signature base: ${ex.message}`);
75
53
  }
76
54
  }
77
- /**
78
- * Generates the Signature-Input header value for the input payload.
79
- *
80
- * @param {any} payload The input config.
81
- * @param {number} timestamp The timestamp.
82
- * @returns {string} the 'Signature-Input' header value.
83
- */
84
55
  export const generateSignatureInput = (payload, timestamp = getUnixTimestamp()) => `sig1=(${getSignatureParamsValue(payload)});created=${timestamp}`;
85
- /**
86
- * Generates the 'Signature' header.
87
- *
88
- * @param {any} headers The HTTP headers.
89
- * @param {string} privateKey The HTTP headers.
90
- * @param {SignatureComponents} signatureComponents The signature components
91
- * @param {any} payload The payload
92
- * @param {number} timestamp The payload
93
- * @returns {string} the signature header value.
94
- */
95
56
  export function generateSignature(headers, privateKey, signatureComponents, payload, timestamp = getUnixTimestamp()) {
96
57
  const baseString = generateBaseString(headers, signatureComponents, payload, timestamp);
97
58
  privateKey = privateKey.trim();
98
59
  if (!privateKey.startsWith(beginPrivateKey)) {
99
60
  privateKey = beginPrivateKey + '\n' + privateKey + '\n' + endPrivateKey;
100
61
  }
101
- const signatureBuffer = sign(undefined, // If algorithm is undefined, then it is dependent upon the private key type.
102
- Buffer.from(baseString), privateKey);
62
+ const signatureBuffer = sign(undefined, Buffer.from(baseString), privateKey);
103
63
  const signature = signatureBuffer.toString('base64');
104
64
  return `sig1=:${signature}:`;
105
65
  }
@@ -3,9 +3,6 @@ import { IEBayApiRequest } from '../request.js';
3
3
  import { AppConfig } from '../types/index.js';
4
4
  import Base from './base.js';
5
5
  import { SignatureComponents } from './digitalSignature.js';
6
- /**
7
- * Superclass with Auth container.
8
- */
9
6
  export default abstract class Api extends Base {
10
7
  readonly auth: Auth;
11
8
  constructor(config: AppConfig, req?: IEBayApiRequest, auth?: Auth);
package/dist/api/index.js CHANGED
@@ -1,9 +1,6 @@
1
1
  import Auth from '../auth/index.js';
2
2
  import Base from './base.js';
3
3
  import { generateContentDigestValue, generateSignature, generateSignatureInput } from './digitalSignature.js';
4
- /**
5
- * Superclass with Auth container.
6
- */
7
4
  export default class Api extends Base {
8
5
  constructor(config, req, auth) {
9
6
  super(config, req);
@@ -1,84 +1,18 @@
1
1
  import { AddCartItemInput, BuyBrowseGetItemsParams, BuyBrowseItemByLegacyIdParams, BuyBrowseSearchByImageParams, BuyBrowseSearchParams, CompatibilityPayload, RemoveCartItemInput, SearchByImageRequest, UpdateCartItemInput } from '../../../../types/index.js';
2
2
  import { operations } from '../../../../types/restful/specs/buy_browse_v1_oas3.js';
3
3
  import Restful, { OpenApi } from '../../index.js';
4
- /**
5
- * The Browse API has the following resources: item_summary: Lets shoppers search for specific items by keyword, GTIN,
6
- * category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility,
7
- * and fields values.
8
- */
9
4
  export default class Browse extends Restful implements OpenApi<operations> {
10
5
  static id: string;
11
6
  get basePath(): string;
12
- /**
13
- * This method searches for eBay items by various query parameters and retrieves summaries of the items.
14
- *
15
- * @param {BrowseSearchParams} params
16
- */
17
7
  search(params: BuyBrowseSearchParams): Promise<any>;
18
- /**
19
- * This is an Experimental method. This method searches for eBay items based on a image and retrieves summaries of
20
- * the items.
21
- *
22
- * @param {params} params
23
- * @param {Object} body The container for the image information fields.
24
- */
25
8
  searchByImage(params: BuyBrowseSearchByImageParams, body?: SearchByImageRequest): Promise<any>;
26
- /**
27
- * This method retrieves the details of specific items that the buyer needs to make a purchasing decision.
28
- *
29
- * @param {params} params
30
- */
31
9
  getItems(params: BuyBrowseGetItemsParams): Promise<any>;
32
- /**
33
- * This method retrieves the details of a specific item, such as description, price, category, all item aspects,
34
- * condition, return policies, seller feedback and score, shipping options, shipping costs, estimated delivery,
35
- * and other information the buyer needs to make a purchasing decision.
36
- *
37
- * @param {String} itemId The eBay RESTful identifier of an item.
38
- * @param {String} fieldgroups
39
- */
40
10
  getItem(itemId: string, fieldgroups?: string): Promise<any>;
41
- /**
42
- * This method is a bridge between the eBay legacy APIs, such as Shopping, and Finding and the eBay Api APIs.
43
- *
44
- * @param {LegacyItemParams} params
45
- */
46
11
  getItemByLegacyId(params: BuyBrowseItemByLegacyIdParams): Promise<any>;
47
- /**
48
- * This method retrieves the details of the individual items in an item group.
49
- *
50
- * @param itemGroupId
51
- */
52
12
  getItemsByItemGroup(itemGroupId: string): Promise<any>;
53
- /**
54
- * This method checks if a product is compatible with the specified item.
55
- * @param {String} itemId The eBay RESTful identifier of an item (such as a part you want to check).
56
- * @param {Object} body CompatibilityPayload
57
- */
58
13
  checkCompatibility(itemId: string, body?: CompatibilityPayload): Promise<any>;
59
- /**
60
- * This is an Experimental method. This method creates an eBay cart for the eBay member, if one does not exist, and
61
- * adds items to that cart.
62
- *
63
- * @param {Object} item AddCartItemInput
64
- */
65
14
  addItem(item: AddCartItemInput): Promise<any>;
66
- /**
67
- * This is an experimental method. This method retrieves all the items in the eBay member's cart;
68
- * items added to the cart while on ebay.com as well as items added to the cart using the Browse API.
69
- */
70
15
  getShoppingCart(): Promise<any>;
71
- /**
72
- * This is an experimental method. This method removes a specific item from the eBay member's cart.
73
- *
74
- * @param {Object} item RemoveCartItemInput
75
- */
76
16
  removeItem(item: RemoveCartItemInput): Promise<any>;
77
- /**
78
- * This is an experimental method. This method updates the quantity value of a specific item in the eBay member's
79
- * cart.
80
- *
81
- * @param {UpdateCartItemInput} item UpdateCartItemInput
82
- */
83
17
  updateQuantity(item: UpdateCartItemInput): Promise<any>;
84
18
  }
@@ -1,57 +1,23 @@
1
1
  import Restful from '../../index.js';
2
- /**
3
- * The Browse API has the following resources: item_summary: Lets shoppers search for specific items by keyword, GTIN,
4
- * category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility,
5
- * and fields values.
6
- */
7
2
  class Browse extends Restful {
8
3
  get basePath() {
9
4
  return '/buy/browse/v1';
10
5
  }
11
- //
12
- // Item
13
- // Client Credentials: https://api.ebay.com/oauth/api_scope
14
- //
15
- /**
16
- * This method searches for eBay items by various query parameters and retrieves summaries of the items.
17
- *
18
- * @param {BrowseSearchParams} params
19
- */
20
6
  search(params) {
21
7
  return this.get(`/item_summary/search`, {
22
8
  params
23
9
  });
24
10
  }
25
- /**
26
- * This is an Experimental method. This method searches for eBay items based on a image and retrieves summaries of
27
- * the items.
28
- *
29
- * @param {params} params
30
- * @param {Object} body The container for the image information fields.
31
- */
32
11
  searchByImage(params, body) {
33
12
  return this.post(`/item_summary/search_by_image`, body, {
34
13
  params
35
14
  });
36
15
  }
37
- /**
38
- * This method retrieves the details of specific items that the buyer needs to make a purchasing decision.
39
- *
40
- * @param {params} params
41
- */
42
16
  getItems(params) {
43
17
  return this.get(`/item/`, {
44
18
  params
45
19
  });
46
20
  }
47
- /**
48
- * This method retrieves the details of a specific item, such as description, price, category, all item aspects,
49
- * condition, return policies, seller feedback and score, shipping options, shipping costs, estimated delivery,
50
- * and other information the buyer needs to make a purchasing decision.
51
- *
52
- * @param {String} itemId The eBay RESTful identifier of an item.
53
- * @param {String} fieldgroups
54
- */
55
21
  getItem(itemId, fieldgroups) {
56
22
  const id = encodeURIComponent(itemId);
57
23
  return this.get(`/item/${id}`, {
@@ -60,21 +26,11 @@ class Browse extends Restful {
60
26
  }
61
27
  });
62
28
  }
63
- /**
64
- * This method is a bridge between the eBay legacy APIs, such as Shopping, and Finding and the eBay Api APIs.
65
- *
66
- * @param {LegacyItemParams} params
67
- */
68
29
  getItemByLegacyId(params) {
69
30
  return this.get(`/item/get_item_by_legacy_id`, {
70
31
  params
71
32
  });
72
33
  }
73
- /**
74
- * This method retrieves the details of the individual items in an item group.
75
- *
76
- * @param itemGroupId
77
- */
78
34
  getItemsByItemGroup(itemGroupId) {
79
35
  return this.get(`/item/get_items_by_item_group`, {
80
36
  params: {
@@ -82,48 +38,19 @@ class Browse extends Restful {
82
38
  }
83
39
  });
84
40
  }
85
- /**
86
- * This method checks if a product is compatible with the specified item.
87
- * @param {String} itemId The eBay RESTful identifier of an item (such as a part you want to check).
88
- * @param {Object} body CompatibilityPayload
89
- */
90
41
  checkCompatibility(itemId, body) {
91
42
  const id = encodeURIComponent(itemId);
92
43
  return this.post(`/item/${id}/check_compatibility`, body);
93
44
  }
94
- //
95
- // Shopping Cart
96
- //
97
- /**
98
- * This is an Experimental method. This method creates an eBay cart for the eBay member, if one does not exist, and
99
- * adds items to that cart.
100
- *
101
- * @param {Object} item AddCartItemInput
102
- */
103
45
  addItem(item) {
104
46
  return this.post(`/shopping_cart/add_item`, item);
105
47
  }
106
- /**
107
- * This is an experimental method. This method retrieves all the items in the eBay member's cart;
108
- * items added to the cart while on ebay.com as well as items added to the cart using the Browse API.
109
- */
110
48
  getShoppingCart() {
111
49
  return this.get(`/shopping_cart/`);
112
50
  }
113
- /**
114
- * This is an experimental method. This method removes a specific item from the eBay member's cart.
115
- *
116
- * @param {Object} item RemoveCartItemInput
117
- */
118
51
  removeItem(item) {
119
52
  return this.post(`/shopping_cart/remove_item`, item);
120
53
  }
121
- /**
122
- * This is an experimental method. This method updates the quantity value of a specific item in the eBay member's
123
- * cart.
124
- *
125
- * @param {UpdateCartItemInput} item UpdateCartItemInput
126
- */
127
54
  updateQuantity(item) {
128
55
  return this.post(`/shopping_cart/update_quantity`, item);
129
56
  }
@@ -1,20 +1,8 @@
1
1
  import { operations } from '../../../../types/restful/specs/buy_deal_v1_oas3.js';
2
2
  import Restful, { OpenApi } from '../../index.js';
3
- /**
4
- * This API allows third-party developers to search for and retrieve details about eBay deals and events, as well as the items associated with those deals and events.
5
- */
6
3
  export default class Deal extends Restful implements OpenApi<operations> {
7
4
  static id: string;
8
5
  get basePath(): string;
9
- /**
10
- * This method retrieves a paginated set of deal items.
11
- *
12
- * @param categoryIds The unique identifier of the eBay category for the search.
13
- * @param commissionable A filter for commissionable deals. Restriction: This filter is currently only supported for the US marketplace.
14
- * @param deliveryCountry A filter for items that can be shipped to the specified country.
15
- * @param limit The maximum number of items, from the current result set, returned on a single page.
16
- * @param offset The number of items that will be skipped in the result set.
17
- */
18
6
  getDealItems({ categoryIds, commissionable, deliveryCountry, limit, offset }: {
19
7
  categoryIds?: string;
20
8
  commissionable?: string;
@@ -22,31 +10,11 @@ export default class Deal extends Restful implements OpenApi<operations> {
22
10
  limit?: string;
23
11
  offset?: string;
24
12
  }): Promise<any>;
25
- /**
26
- * This method retrieves the details for an eBay event.
27
- *
28
- * @param eventId The unique identifier for the eBay event.
29
- */
30
13
  getEvent(eventId: string): Promise<any>;
31
- /**
32
- * This method returns paginated results containing all eBay events for the specified marketplace.
33
- *
34
- * @param limit The maximum number of items, from the current result set, returned on a single page. Default: 20 Maximum Value: 100
35
- * @param offset The number of items that will be skipped in the result set.
36
- */
37
14
  getEvents({ limit, offset }: {
38
15
  limit?: string;
39
16
  offset?: string;
40
17
  }): Promise<any>;
41
- /**
42
- * This method returns paginated results containing all eBay events for the specified marketplace.
43
- *
44
- * @param eventIds The unique identifiers for the eBay events. Maximum Value: 1
45
- * @param categoryIds The unique identifier of the eBay category for the search. Maximum Value: 1
46
- * @param deliveryCountry A filter for items that can be shipped to the specified country.
47
- * @param limit The maximum number of items, from the current result set, returned on a single page. Default: 20 Maximum Value: 100
48
- * @param offset The number of items that will be skipped in the result set.
49
- */
50
18
  getEventItems(eventIds: string, { categoryIds, deliveryCountry, limit, offset }?: {
51
19
  categoryIds?: string;
52
20
  deliveryCountry?: string;
@@ -1,20 +1,8 @@
1
1
  import Restful from '../../index.js';
2
- /**
3
- * This API allows third-party developers to search for and retrieve details about eBay deals and events, as well as the items associated with those deals and events.
4
- */
5
2
  class Deal extends Restful {
6
3
  get basePath() {
7
4
  return '/buy/deal/v1';
8
5
  }
9
- /**
10
- * This method retrieves a paginated set of deal items.
11
- *
12
- * @param categoryIds The unique identifier of the eBay category for the search.
13
- * @param commissionable A filter for commissionable deals. Restriction: This filter is currently only supported for the US marketplace.
14
- * @param deliveryCountry A filter for items that can be shipped to the specified country.
15
- * @param limit The maximum number of items, from the current result set, returned on a single page.
16
- * @param offset The number of items that will be skipped in the result set.
17
- */
18
6
  getDealItems({ categoryIds, commissionable, deliveryCountry, limit, offset }) {
19
7
  return this.get(`/deal_item`, {
20
8
  params: {
@@ -26,21 +14,10 @@ class Deal extends Restful {
26
14
  }
27
15
  });
28
16
  }
29
- /**
30
- * This method retrieves the details for an eBay event.
31
- *
32
- * @param eventId The unique identifier for the eBay event.
33
- */
34
17
  getEvent(eventId) {
35
18
  eventId = encodeURIComponent(eventId);
36
19
  return this.get(`/event/${eventId}`);
37
20
  }
38
- /**
39
- * This method returns paginated results containing all eBay events for the specified marketplace.
40
- *
41
- * @param limit The maximum number of items, from the current result set, returned on a single page. Default: 20 Maximum Value: 100
42
- * @param offset The number of items that will be skipped in the result set.
43
- */
44
21
  getEvents({ limit, offset }) {
45
22
  return this.get(`/event`, {
46
23
  params: {
@@ -49,15 +26,6 @@ class Deal extends Restful {
49
26
  }
50
27
  });
51
28
  }
52
- /**
53
- * This method returns paginated results containing all eBay events for the specified marketplace.
54
- *
55
- * @param eventIds The unique identifiers for the eBay events. Maximum Value: 1
56
- * @param categoryIds The unique identifier of the eBay category for the search. Maximum Value: 1
57
- * @param deliveryCountry A filter for items that can be shipped to the specified country.
58
- * @param limit The maximum number of items, from the current result set, returned on a single page. Default: 20 Maximum Value: 100
59
- * @param offset The number of items that will be skipped in the result set.
60
- */
61
29
  getEventItems(eventIds, { categoryIds, deliveryCountry, limit, offset } = {}) {
62
30
  return this.get(`/event_item`, {
63
31
  params: {
@@ -1,44 +1,11 @@
1
1
  import { BuyFeedParams } from '../../../../types/index.js';
2
2
  import { operations } from '../../../../types/restful/specs/buy_feed_v1_beta_oas3.js';
3
3
  import Restful, { OpenApi } from '../../index.js';
4
- /**
5
- * The Feed API provides the ability to download TSV_GZIP feed files containing eBay items and an hourly snapshot file
6
- * of the items that have changed within an hour for a specific category, date and marketplace.
7
- */
8
4
  export default class Feed extends Restful implements OpenApi<operations> {
9
5
  static id: string;
10
6
  get basePath(): string;
11
- /**
12
- * This method lets you download a TSV_GZIP (tab separated value gzip) Item feed file.
13
- *
14
- * @param {BuyFeedParams} params
15
- * @param range his header specifies the range in bytes of the chunks of the gzip file being returned.
16
- * Format: bytes=startpos-endpos For example, the following retrieves the first 10 MBs of the feed file.
17
- */
18
7
  getItemFeed(params: BuyFeedParams, range: string): Promise<any>;
19
- /**
20
- * This method lets you download a TSV_GZIP (tab separated value gzip) Item Group feed file.
21
- * @param {BuyFeedParams} params
22
- * @param range his header specifies the range in bytes of the chunks of the gzip file being returned.
23
- * Format: bytes=startpos-endpos For example, the following retrieves the first 10 MBs of the feed file.
24
- */
25
8
  getItemGroupFeed(params: BuyFeedParams, range: string): Promise<any>;
26
- /**
27
- * The Hourly Snapshot feed file is generated each hour every day for all categories.
28
- *
29
- * @param {BuyFeedParams} params
30
- * @param {String} snapshotDate
31
- * @param range his header specifies the range in bytes of the chunks of the gzip file being returned.
32
- * Format: bytes=startpos-endpos For example, the following retrieves the first 10 MBs of the feed file.
33
- */
34
9
  getItemSnapshotFeed(params: BuyFeedParams, snapshotDate: string, range: string): Promise<any>;
35
- /**
36
- * The Hourly Snapshot feed file is generated each hour every day for all categories.
37
- *
38
- * @param {BuyFeedParams} params
39
- * @param {String} snapshotDate
40
- * @param range his header specifies the range in bytes of the chunks of the gzip file being returned.
41
- * Format: bytes=startpos-endpos For example, the following retrieves the first 10 MBs of the feed file.
42
- */
43
10
  getProductFeed(params: BuyFeedParams, snapshotDate: string, range: string): Promise<any>;
44
11
  }
@@ -1,19 +1,8 @@
1
1
  import Restful from '../../index.js';
2
- /**
3
- * The Feed API provides the ability to download TSV_GZIP feed files containing eBay items and an hourly snapshot file
4
- * of the items that have changed within an hour for a specific category, date and marketplace.
5
- */
6
2
  class Feed extends Restful {
7
3
  get basePath() {
8
4
  return '/buy/feed/v1_beta';
9
5
  }
10
- /**
11
- * This method lets you download a TSV_GZIP (tab separated value gzip) Item feed file.
12
- *
13
- * @param {BuyFeedParams} params
14
- * @param range his header specifies the range in bytes of the chunks of the gzip file being returned.
15
- * Format: bytes=startpos-endpos For example, the following retrieves the first 10 MBs of the feed file.
16
- */
17
6
  getItemFeed(params, range) {
18
7
  return this.get(`/item`, {
19
8
  params,
@@ -22,12 +11,6 @@ class Feed extends Restful {
22
11
  }
23
12
  });
24
13
  }
25
- /**
26
- * This method lets you download a TSV_GZIP (tab separated value gzip) Item Group feed file.
27
- * @param {BuyFeedParams} params
28
- * @param range his header specifies the range in bytes of the chunks of the gzip file being returned.
29
- * Format: bytes=startpos-endpos For example, the following retrieves the first 10 MBs of the feed file.
30
- */
31
14
  getItemGroupFeed(params, range) {
32
15
  return this.get(`/item_group`, {
33
16
  params,
@@ -36,14 +19,6 @@ class Feed extends Restful {
36
19
  }
37
20
  });
38
21
  }
39
- /**
40
- * The Hourly Snapshot feed file is generated each hour every day for all categories.
41
- *
42
- * @param {BuyFeedParams} params
43
- * @param {String} snapshotDate
44
- * @param range his header specifies the range in bytes of the chunks of the gzip file being returned.
45
- * Format: bytes=startpos-endpos For example, the following retrieves the first 10 MBs of the feed file.
46
- */
47
22
  getItemSnapshotFeed(params, snapshotDate, range) {
48
23
  return this.get(`/item_snapshot`, {
49
24
  params: {
@@ -55,14 +30,6 @@ class Feed extends Restful {
55
30
  }
56
31
  });
57
32
  }
58
- /**
59
- * The Hourly Snapshot feed file is generated each hour every day for all categories.
60
- *
61
- * @param {BuyFeedParams} params
62
- * @param {String} snapshotDate
63
- * @param range his header specifies the range in bytes of the chunks of the gzip file being returned.
64
- * Format: bytes=startpos-endpos For example, the following retrieves the first 10 MBs of the feed file.
65
- */
66
33
  getProductFeed(params, snapshotDate, range) {
67
34
  return this.get(`/product`, {
68
35
  params: {