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,460 +1,461 @@
1
- import Restful from '../../index.js';
2
- /**
3
- * The <b>Account API</b> gives sellers the ability to configure their eBay seller accounts,
4
- * including the seller's policies (the Fulfillment Policy, Payment Policy, and Return Policy),
5
- * opt in and out of eBay seller programs, configure sales tax tables, and get account information.
6
- */
7
- export default class Account extends Restful {
8
- get basePath() {
9
- return '/sell/account/v1';
10
- }
11
- /**
12
- * This method retrieves the list of custom policies specified by the <b>policy_types</b> query parameter for the selected eBay marketplace.
13
- * @param policyTypes This query parameter specifies the type of custom policies to be returned.
14
- */
15
- getCustomPolicies(policyTypes) {
16
- return this.get(`/custom_policy/`, {
17
- params: {
18
- policy_types: policyTypes
19
- }
20
- });
21
- }
22
- /**
23
- * This method creates a new custom policy in which a seller specifies their terms for complying with local governmental regulations.
24
- * @param body Request to create a new Custom Policy.
25
- */
26
- createCustomPolicy(body) {
27
- return this.post(`/custom_policy/`, body);
28
- }
29
- /**
30
- * This method retrieves the custom policy specified by the <b>custom_policy_id</b> path parameter for the selected eBay marketplace.
31
- * @param customPolicyId This path parameter is the unique custom policy identifier for the policy to be returned.
32
- */
33
- getCustomPolicy(customPolicyId) {
34
- customPolicyId = encodeURIComponent(customPolicyId);
35
- return this.get(`/custom_policy/${customPolicyId}`);
36
- }
37
- /**
38
- * This method updates an existing custom policy specified by the <b>custom_policy_id</b> path parameter for the selected marketplace.
39
- * @param customPolicyId This path parameter is the unique custom policy identifier for the policy to be returned.
40
- * @param body Request to update a current custom policy.
41
- */
42
- updateCustomPolicy(customPolicyId, body) {
43
- customPolicyId = encodeURIComponent(customPolicyId);
44
- return this.put(`/custom_policy/${customPolicyId}`, body);
45
- }
46
- /**
47
- * This method retrieves all the fulfillment policies configured for the marketplace you specify using the
48
- * marketplace_id query parameter.
49
- *
50
- * @param marketplaceId This query parameter specifies the eBay marketplace of the policies you want to retrieve.
51
- */
52
- getFulfillmentPolicies(marketplaceId) {
53
- return this.get(`/fulfillment_policy`, {
54
- params: {
55
- marketplace_id: marketplaceId
56
- }
57
- });
58
- }
59
- /**
60
- * This method creates a new fulfillment policy where the policy encapsulates seller's terms for fulfilling item
61
- * purchases.
62
- *
63
- * @param body Request to create a seller account fulfillment policy.
64
- */
65
- createFulfillmentPolicy(body) {
66
- return this.post(`/fulfillment_policy/`, body);
67
- }
68
- /**
69
- * This method updates an existing fulfillment policy.
70
- *
71
- * @param fulfillmentPolicyId This path parameter specifies the ID of the fulfillment policy you want to update.
72
- * @param body Request to create a seller account fulfillment policy.
73
- */
74
- updateFulfillmentPolicy(fulfillmentPolicyId, body) {
75
- fulfillmentPolicyId = encodeURIComponent(fulfillmentPolicyId);
76
- return this.put(`/fulfillment_policy/${fulfillmentPolicyId}`, body);
77
- }
78
- /**
79
- * This method deletes a fulfillment policy.
80
- *
81
- * @param fulfillmentPolicyId This path parameter specifies the ID of the fulfillment policy to delete.
82
- */
83
- deleteFulfillmentPolicy(fulfillmentPolicyId) {
84
- fulfillmentPolicyId = encodeURIComponent(fulfillmentPolicyId);
85
- return this.delete(`/fulfillment_policy/${fulfillmentPolicyId}`);
86
- }
87
- /**
88
- * This method retrieves the complete details of a fulfillment policy.
89
- * Supply the ID of the policy you want to retrieve using the fulfillmentPolicyId path parameter.
90
- *
91
- * @param fulfillmentPolicyId This path parameter specifies the ID of the fulfillment policy you want to retrieve.
92
- */
93
- getFulfillmentPolicy(fulfillmentPolicyId) {
94
- return this.get(`/fulfillment_policy/${fulfillmentPolicyId}`);
95
- }
96
- /**
97
- * This method retrieves the complete details for a single fulfillment policy.
98
- *
99
- * @param marketplaceId This query parameter specifies the eBay marketplace of the policy you want to retrieve.
100
- * @param name This query parameter specifies the user-defined name of the fulfillment policy you want to retrieve.
101
- */
102
- getFulfillmentPolicyByName(marketplaceId, name) {
103
- return this.get(`/fulfillment_policy/get_by_policy_name`, {
104
- params: {
105
- marketplace_id: marketplaceId,
106
- name
107
- }
108
- });
109
- }
110
- /**
111
- * This method retrieves all the payment policies configured for the marketplace you specify using the
112
- * marketplace_id query parameter.
113
- *
114
- * @param marketplaceId This query parameter specifies the eBay marketplace of the policy you want to retrieve.
115
- */
116
- getPaymentPolicies(marketplaceId) {
117
- return this.get(`/payment_policy`, {
118
- params: {
119
- marketplace_id: marketplaceId
120
- }
121
- });
122
- }
123
- /**
124
- * This method retrieves the complete details of a payment policy. Supply the ID of the policy you want to retrieve
125
- * using the paymentPolicyId path parameter.
126
- *
127
- * @param paymentPolicyId This path parameter specifies the ID of the payment policy you want to retrieve.
128
- */
129
- getPaymentPolicy(paymentPolicyId) {
130
- paymentPolicyId = encodeURIComponent(paymentPolicyId);
131
- return this.get(`/payment_policy/${paymentPolicyId}`);
132
- }
133
- /**
134
- * This method creates a new payment policy where the policy encapsulates seller's terms for purchase payments.
135
- *
136
- * @param body Payment policy request
137
- */
138
- createPaymentPolicy(body) {
139
- return this.post(`/payment_policy`, body);
140
- }
141
- /**
142
- * This method updates an existing payment policy.
143
- *
144
- * @param paymentPolicyId This path parameter specifies the ID of the payment policy you want to update.
145
- * @param body Payment policy request
146
- */
147
- updatePaymentPolicy(paymentPolicyId, body) {
148
- paymentPolicyId = encodeURIComponent(paymentPolicyId);
149
- return this.put(`/payment_policy/${paymentPolicyId}`, body);
150
- }
151
- /**
152
- * This method updates an existing payment policy.
153
- *
154
- * @param paymentPolicyId This path parameter specifies the ID of the payment policy you want to delete.
155
- */
156
- deletePaymentPolicy(paymentPolicyId) {
157
- paymentPolicyId = encodeURIComponent(paymentPolicyId);
158
- return this.delete(`/payment_policy/${paymentPolicyId}`);
159
- }
160
- /**
161
- * This method retrieves the complete details of a single payment policy.
162
- *
163
- * @param marketplaceId This query parameter specifies the eBay marketplace of the policy you want to retrieve.
164
- * @param name This query parameter specifies the user-defined name of the payment policy you want to retrieve.
165
- */
166
- getPaymentPolicyByName(marketplaceId, name) {
167
- return this.get(`/payment_policy/get_by_policy_name`, {
168
- params: {
169
- marketplace_id: marketplaceId,
170
- name
171
- }
172
- });
173
- }
174
- /**
175
- * This method returns whether or not the user is opted-in to the payment program.
176
- *
177
- * @param marketplaceId This query parameter specifies the eBay marketplace of the policy you want to retrieve.
178
- * @param paymentsProgramType This path parameter specifies the payments program whose status is returned by the
179
- * call.
180
- */
181
- getPaymentsProgram(marketplaceId, paymentsProgramType) {
182
- marketplaceId = encodeURIComponent(marketplaceId);
183
- const type = encodeURIComponent(paymentsProgramType);
184
- return this.get(`/payments_program/${marketplaceId}/${type}`);
185
- }
186
- /**
187
- * This method retrieves a seller's onboarding status of eBay managed payments for a specified marketplace.
188
- *
189
- * @param marketplaceId This query parameter specifies the eBay marketplace of the policy you want to retrieve.
190
- * @param paymentsProgramType This path parameter specifies the payments program whose status is returned by the
191
- * call.
192
- */
193
- getPaymentsProgramOnboarding(marketplaceId, paymentsProgramType) {
194
- marketplaceId = encodeURIComponent(marketplaceId);
195
- const type = encodeURIComponent(paymentsProgramType);
196
- return this.get(`/payments_program/${marketplaceId}/${type}/onboarding`);
197
- }
198
- /**
199
- * This method retrieves the seller's current set of privileges.
200
- */
201
- getPrivileges() {
202
- return this.get(`/privilege`);
203
- }
204
- /**
205
- * This method gets a list of the seller programs that the seller has opted-in to.
206
- */
207
- getOptedInPrograms() {
208
- return this.get(`/program/get_opted_in_programs`);
209
- }
210
- /**
211
- * This method opts the seller in to an eBay seller program.
212
- *
213
- * @param body Program being opted-in to.
214
- */
215
- optInToProgram(body) {
216
- return this.post(`/program/opt_in`, body);
217
- }
218
- /**
219
- * This method opts the seller out of a seller program to which you have previously opted-in to.
220
- *
221
- * @param body Program being opted-out of.
222
- */
223
- optOutOfProgram(body) {
224
- return this.post(`/program/opt_out`, body);
225
- }
226
- /**
227
- * This method retrieves a seller's shipping rate tables for the country specified in the country_code query
228
- * parameter.
229
- *
230
- * @param countryCode This query parameter specifies the two-letter ISO 3166-1 Alpha-2 code of country for which
231
- * you want shipping-rate table information.
232
- */
233
- getRateTables(countryCode) {
234
- return this.get(`/rate_table`, {
235
- params: {
236
- country_code: countryCode
237
- }
238
- });
239
- }
240
- /**
241
- * This method retrieves all the return policies configured for the marketplace you specify using the
242
- * marketplace_id query parameter.
243
- *
244
- * @param marketplaceId This query parameter specifies the ID of the eBay marketplace of the policy you want to
245
- * retrieve.
246
- */
247
- getReturnPolicies(marketplaceId) {
248
- return this.get(`/return_policy`, {
249
- params: {
250
- marketplace_id: marketplaceId
251
- }
252
- });
253
- }
254
- /**
255
- * This method retrieves the complete details of the return policy specified by the returnPolicyId path parameter.
256
- *
257
- * @param returnPolicyId This path parameter specifies the of the return policy you want to retrieve.
258
- */
259
- getReturnPolicy(returnPolicyId) {
260
- returnPolicyId = encodeURIComponent(returnPolicyId);
261
- return this.get(`/return_policy/${returnPolicyId}`);
262
- }
263
- /**
264
- * This method creates a new return policy where the policy encapsulates seller's terms for returning items.
265
- *
266
- * @param body Return policy request
267
- */
268
- createReturnPolicy(body) {
269
- return this.post(`/return_policy`, body);
270
- }
271
- /**
272
- * This method creates a new return policy where the policy encapsulates seller's terms for returning items.
273
- *
274
- * @param returnPolicyId This path parameter specifies the ID of the return policy you want to update.
275
- * @param body Return policy request
276
- */
277
- updateReturnPolicy(returnPolicyId, body) {
278
- returnPolicyId = encodeURIComponent(returnPolicyId);
279
- return this.put(`/return_policy/${returnPolicyId}`, body);
280
- }
281
- /**
282
- * This method deletes a return policy.
283
- *
284
- * @param returnPolicyId This path parameter specifies the ID of the return policy you want to delete.
285
- */
286
- deleteReturnPolicy(returnPolicyId) {
287
- returnPolicyId = encodeURIComponent(returnPolicyId);
288
- return this.delete(`/return_policy/${returnPolicyId}`);
289
- }
290
- /**
291
- * This method retrieves the complete details of a single return policy.
292
- *
293
- * @param marketplaceId This query parameter specifies the ID of the eBay marketplace of the policy you want to
294
- * retrieve.
295
- * @param name This query parameter specifies the user-defined name of the return policy you want to retrieve.
296
- */
297
- getReturnPolicyByName(marketplaceId, name) {
298
- return this.get(`/return_policy/get_by_policy_name`, {
299
- params: {
300
- marketplace_id: marketplaceId,
301
- name
302
- }
303
- });
304
- }
305
- /**
306
- * This call gets the current tax table entry for a specific tax jurisdiction.
307
- *
308
- * @param countryCode This path parameter specifies the two-letter ISO 3166-1 Alpha-2 code for the country whose
309
- * tax table you want to retrieve.
310
- * @param jurisdictionId This path parameter specifies the ID of the sales tax jurisdiction for the tax table entry
311
- * you want to retrieve.
312
- */
313
- getSalesTax(countryCode, jurisdictionId) {
314
- countryCode = encodeURIComponent(countryCode);
315
- jurisdictionId = encodeURIComponent(jurisdictionId);
316
- return this.get(`/sales_tax/${countryCode}/${jurisdictionId}`);
317
- }
318
- /**
319
- * This method creates or updates a sales tax table entry for a jurisdiction.
320
- *
321
- * @param countryCode This path parameter specifies the two-letter ISO 3166-1 Alpha-2 code for the country for
322
- * which you want to create tax table entry.
323
- * @param jurisdictionId This path parameter specifies the ID of the sales-tax jurisdiction for the table entry you
324
- * want to create.
325
- * @param body A container that describes the how the sales tax is calculated.
326
- */
327
- createOrReplaceSalesTax(countryCode, jurisdictionId, body) {
328
- countryCode = encodeURIComponent(countryCode);
329
- jurisdictionId = encodeURIComponent(jurisdictionId);
330
- return this.put(`/sales_tax/${countryCode}/${jurisdictionId}`, body);
331
- }
332
- /**
333
- * This call deletes a tax table entry for a jurisdiction.
334
- *
335
- * @param countryCode This path parameter specifies the two-letter ISO 3166-1 Alpha-2 code for the country for
336
- * which you want to create tax table entry.
337
- * @param jurisdictionId This path parameter specifies the ID of the sales-tax jurisdiction for the table entry you
338
- * want to delete.
339
- */
340
- deleteSalesTax(countryCode, jurisdictionId) {
341
- countryCode = encodeURIComponent(countryCode);
342
- jurisdictionId = encodeURIComponent(jurisdictionId);
343
- return this.delete(`/sales_tax/${countryCode}/${jurisdictionId}`);
344
- }
345
- /**
346
- * Use this call to retrieve a sales tax table that the seller established for a specific country.
347
- *
348
- * @param countryCode This path parameter specifies the two-letter ISO 3166-1 Alpha-2 code for the country whose
349
- * tax table you want to retrieve.
350
- */
351
- getSalesTaxes(countryCode) {
352
- return this.get(`/sales_tax`, {
353
- params: {
354
- country_code: countryCode
355
- }
356
- });
357
- }
358
- /**
359
- * This method retrieves a list of subscriptions associated with the seller account.
360
- * @param limit This field is for future use.
361
- * @param continuationToken This field is for future use.
362
- */
363
- getSubscription({ limit, continuationToken } = {}) {
364
- return this.get(`/subscription`, {
365
- params: {
366
- limit,
367
- continuation_token: continuationToken
368
- }
369
- });
370
- }
371
- /**
372
- * his method is used by sellers onboarded for eBay managed payments, or sellers who are currently going through, or who are eligible for onboarding for eBay managed payments.
373
- */
374
- getKYC() {
375
- return this.get(`/kyc`);
376
- }
377
- /**
378
- * This method allows developers to check the seller eligibility status for eBay advertising programs.
379
- * @param programTypes A comma-separated list of eBay advertising programs.
380
- */
381
- getAdvertisingEligibility(programTypes) {
382
- return this.get(`/advertising_eligibility`, {
383
- params: {
384
- program_types: programTypes
385
- }
386
- });
387
- }
388
- /**
389
- * This call retrieves all defined details of the inventory location that is specified by the <b>merchantLocationKey</b> path parameter.
390
- * @param merchantLocationKey A unique merchant-defined key (ID) for an inventory location.
391
- */
392
- getInventoryLocation(merchantLocationKey) {
393
- merchantLocationKey = encodeURIComponent(merchantLocationKey);
394
- return this.get(`/location/${merchantLocationKey}`);
395
- }
396
- /**
397
- * <p>Use this call to create a new inventory location.
398
- * @param merchantLocationKey A unique, merchant-defined key (ID) for an inventory location.
399
- * @param body Inventory Location details
400
- */
401
- createInventoryLocation(merchantLocationKey, body) {
402
- merchantLocationKey = encodeURIComponent(merchantLocationKey);
403
- return this.post(`/location/${merchantLocationKey}`, body);
404
- }
405
- /**
406
- * <p>This call deletes the inventory location that is specified in the <code>merchantLocationKey</code> path parameter.
407
- * @param merchantLocationKey
408
- */
409
- deleteInventoryLocation(merchantLocationKey) {
410
- merchantLocationKey = encodeURIComponent(merchantLocationKey);
411
- return this.delete(`/location/${merchantLocationKey}`);
412
- }
413
- /**
414
- * <p>This call disables the inventory location that is specified in the <code>merchantLocationKey</code> path parameter.
415
- * @param merchantLocationKey A unique merchant-defined key (ID) for an inventory location.
416
- */
417
- disableInventoryLocation(merchantLocationKey) {
418
- merchantLocationKey = encodeURIComponent(merchantLocationKey);
419
- return this.post(`/location/${merchantLocationKey}/disable`);
420
- }
421
- /**
422
- * <p>This call enables a disabled inventory location that is specified in the <code>merchantLocationKey</code> path parameter.
423
- * @param merchantLocationKey A unique merchant-defined key (ID) for an inventory location.
424
- */
425
- enableInventoryLocation(merchantLocationKey) {
426
- merchantLocationKey = encodeURIComponent(merchantLocationKey);
427
- return this.post(`/location/${merchantLocationKey}/enable`);
428
- }
429
- /**
430
- * This call retrieves all defined details for every inventory location associated with the seller's account.
431
- * @param limit The value passed in this query parameter sets the maximum number of records to return per page of data.
432
- * @param offset Specifies the number of locations to skip in the result set before returning the first location in the paginated response.
433
- */
434
- getInventoryLocations({ limit, offset } = {}) {
435
- return this.get(`/location`, {
436
- params: {
437
- limit,
438
- offset
439
- }
440
- });
441
- }
442
- /**
443
- * <p>Use this call to update non-physical location details for an existing inventory location.
444
- * @param merchantLocationKey A unique merchant-defined key (ID) for an inventory location.
445
- * @param body The inventory location details to be updated (other than the address and geo co-ordinates).
446
- */
447
- updateInventoryLocation(merchantLocationKey, body) {
448
- merchantLocationKey = encodeURIComponent(merchantLocationKey);
449
- return this.post(`/location/${merchantLocationKey}/update_location_details`, body);
450
- }
451
- /**
452
- * This method retrieves all the sales tax jurisdictions for the country that you specify in the <b>countryCode</b> path parameter.
453
- * @param countryCode This path parameter specifies the two-letter <a href="https://www.iso.org/iso-3166-country-codes.html " title="https://www.iso.org " target="_blank">ISO 3166</a> country code for the country whose jurisdictions you want to retrieve. eBay provides sales tax jurisdiction information for Canada and the United States.
454
- */
455
- getSalesTaxJurisdictions(countryCode) {
456
- countryCode = encodeURIComponent(countryCode);
457
- return this.get(`/country/${countryCode}/sales_tax_jurisdiction`);
458
- }
459
- }
460
- Account.id = 'Account';
1
+ import Restful from '../../index.js';
2
+ /**
3
+ * The <b>Account API</b> gives sellers the ability to configure their eBay seller accounts,
4
+ * including the seller's policies (the Fulfillment Policy, Payment Policy, and Return Policy),
5
+ * opt in and out of eBay seller programs, configure sales tax tables, and get account information.
6
+ */
7
+ class Account extends Restful {
8
+ get basePath() {
9
+ return '/sell/account/v1';
10
+ }
11
+ /**
12
+ * This method retrieves the list of custom policies specified by the <b>policy_types</b> query parameter for the selected eBay marketplace.
13
+ * @param policyTypes This query parameter specifies the type of custom policies to be returned.
14
+ */
15
+ getCustomPolicies(policyTypes) {
16
+ return this.get(`/custom_policy/`, {
17
+ params: {
18
+ policy_types: policyTypes
19
+ }
20
+ });
21
+ }
22
+ /**
23
+ * This method creates a new custom policy in which a seller specifies their terms for complying with local governmental regulations.
24
+ * @param body Request to create a new Custom Policy.
25
+ */
26
+ createCustomPolicy(body) {
27
+ return this.post(`/custom_policy/`, body);
28
+ }
29
+ /**
30
+ * This method retrieves the custom policy specified by the <b>custom_policy_id</b> path parameter for the selected eBay marketplace.
31
+ * @param customPolicyId This path parameter is the unique custom policy identifier for the policy to be returned.
32
+ */
33
+ getCustomPolicy(customPolicyId) {
34
+ customPolicyId = encodeURIComponent(customPolicyId);
35
+ return this.get(`/custom_policy/${customPolicyId}`);
36
+ }
37
+ /**
38
+ * This method updates an existing custom policy specified by the <b>custom_policy_id</b> path parameter for the selected marketplace.
39
+ * @param customPolicyId This path parameter is the unique custom policy identifier for the policy to be returned.
40
+ * @param body Request to update a current custom policy.
41
+ */
42
+ updateCustomPolicy(customPolicyId, body) {
43
+ customPolicyId = encodeURIComponent(customPolicyId);
44
+ return this.put(`/custom_policy/${customPolicyId}`, body);
45
+ }
46
+ /**
47
+ * This method retrieves all the fulfillment policies configured for the marketplace you specify using the
48
+ * marketplace_id query parameter.
49
+ *
50
+ * @param marketplaceId This query parameter specifies the eBay marketplace of the policies you want to retrieve.
51
+ */
52
+ getFulfillmentPolicies(marketplaceId) {
53
+ return this.get(`/fulfillment_policy`, {
54
+ params: {
55
+ marketplace_id: marketplaceId
56
+ }
57
+ });
58
+ }
59
+ /**
60
+ * This method creates a new fulfillment policy where the policy encapsulates seller's terms for fulfilling item
61
+ * purchases.
62
+ *
63
+ * @param body Request to create a seller account fulfillment policy.
64
+ */
65
+ createFulfillmentPolicy(body) {
66
+ return this.post(`/fulfillment_policy/`, body);
67
+ }
68
+ /**
69
+ * This method updates an existing fulfillment policy.
70
+ *
71
+ * @param fulfillmentPolicyId This path parameter specifies the ID of the fulfillment policy you want to update.
72
+ * @param body Request to create a seller account fulfillment policy.
73
+ */
74
+ updateFulfillmentPolicy(fulfillmentPolicyId, body) {
75
+ fulfillmentPolicyId = encodeURIComponent(fulfillmentPolicyId);
76
+ return this.put(`/fulfillment_policy/${fulfillmentPolicyId}`, body);
77
+ }
78
+ /**
79
+ * This method deletes a fulfillment policy.
80
+ *
81
+ * @param fulfillmentPolicyId This path parameter specifies the ID of the fulfillment policy to delete.
82
+ */
83
+ deleteFulfillmentPolicy(fulfillmentPolicyId) {
84
+ fulfillmentPolicyId = encodeURIComponent(fulfillmentPolicyId);
85
+ return this.delete(`/fulfillment_policy/${fulfillmentPolicyId}`);
86
+ }
87
+ /**
88
+ * This method retrieves the complete details of a fulfillment policy.
89
+ * Supply the ID of the policy you want to retrieve using the fulfillmentPolicyId path parameter.
90
+ *
91
+ * @param fulfillmentPolicyId This path parameter specifies the ID of the fulfillment policy you want to retrieve.
92
+ */
93
+ getFulfillmentPolicy(fulfillmentPolicyId) {
94
+ return this.get(`/fulfillment_policy/${fulfillmentPolicyId}`);
95
+ }
96
+ /**
97
+ * This method retrieves the complete details for a single fulfillment policy.
98
+ *
99
+ * @param marketplaceId This query parameter specifies the eBay marketplace of the policy you want to retrieve.
100
+ * @param name This query parameter specifies the user-defined name of the fulfillment policy you want to retrieve.
101
+ */
102
+ getFulfillmentPolicyByName(marketplaceId, name) {
103
+ return this.get(`/fulfillment_policy/get_by_policy_name`, {
104
+ params: {
105
+ marketplace_id: marketplaceId,
106
+ name
107
+ }
108
+ });
109
+ }
110
+ /**
111
+ * This method retrieves all the payment policies configured for the marketplace you specify using the
112
+ * marketplace_id query parameter.
113
+ *
114
+ * @param marketplaceId This query parameter specifies the eBay marketplace of the policy you want to retrieve.
115
+ */
116
+ getPaymentPolicies(marketplaceId) {
117
+ return this.get(`/payment_policy`, {
118
+ params: {
119
+ marketplace_id: marketplaceId
120
+ }
121
+ });
122
+ }
123
+ /**
124
+ * This method retrieves the complete details of a payment policy. Supply the ID of the policy you want to retrieve
125
+ * using the paymentPolicyId path parameter.
126
+ *
127
+ * @param paymentPolicyId This path parameter specifies the ID of the payment policy you want to retrieve.
128
+ */
129
+ getPaymentPolicy(paymentPolicyId) {
130
+ paymentPolicyId = encodeURIComponent(paymentPolicyId);
131
+ return this.get(`/payment_policy/${paymentPolicyId}`);
132
+ }
133
+ /**
134
+ * This method creates a new payment policy where the policy encapsulates seller's terms for purchase payments.
135
+ *
136
+ * @param body Payment policy request
137
+ */
138
+ createPaymentPolicy(body) {
139
+ return this.post(`/payment_policy`, body);
140
+ }
141
+ /**
142
+ * This method updates an existing payment policy.
143
+ *
144
+ * @param paymentPolicyId This path parameter specifies the ID of the payment policy you want to update.
145
+ * @param body Payment policy request
146
+ */
147
+ updatePaymentPolicy(paymentPolicyId, body) {
148
+ paymentPolicyId = encodeURIComponent(paymentPolicyId);
149
+ return this.put(`/payment_policy/${paymentPolicyId}`, body);
150
+ }
151
+ /**
152
+ * This method updates an existing payment policy.
153
+ *
154
+ * @param paymentPolicyId This path parameter specifies the ID of the payment policy you want to delete.
155
+ */
156
+ deletePaymentPolicy(paymentPolicyId) {
157
+ paymentPolicyId = encodeURIComponent(paymentPolicyId);
158
+ return this.delete(`/payment_policy/${paymentPolicyId}`);
159
+ }
160
+ /**
161
+ * This method retrieves the complete details of a single payment policy.
162
+ *
163
+ * @param marketplaceId This query parameter specifies the eBay marketplace of the policy you want to retrieve.
164
+ * @param name This query parameter specifies the user-defined name of the payment policy you want to retrieve.
165
+ */
166
+ getPaymentPolicyByName(marketplaceId, name) {
167
+ return this.get(`/payment_policy/get_by_policy_name`, {
168
+ params: {
169
+ marketplace_id: marketplaceId,
170
+ name
171
+ }
172
+ });
173
+ }
174
+ /**
175
+ * This method returns whether or not the user is opted-in to the payment program.
176
+ *
177
+ * @param marketplaceId This query parameter specifies the eBay marketplace of the policy you want to retrieve.
178
+ * @param paymentsProgramType This path parameter specifies the payments program whose status is returned by the
179
+ * call.
180
+ */
181
+ getPaymentsProgram(marketplaceId, paymentsProgramType) {
182
+ marketplaceId = encodeURIComponent(marketplaceId);
183
+ const type = encodeURIComponent(paymentsProgramType);
184
+ return this.get(`/payments_program/${marketplaceId}/${type}`);
185
+ }
186
+ /**
187
+ * This method retrieves a seller's onboarding status of eBay managed payments for a specified marketplace.
188
+ *
189
+ * @param marketplaceId This query parameter specifies the eBay marketplace of the policy you want to retrieve.
190
+ * @param paymentsProgramType This path parameter specifies the payments program whose status is returned by the
191
+ * call.
192
+ */
193
+ getPaymentsProgramOnboarding(marketplaceId, paymentsProgramType) {
194
+ marketplaceId = encodeURIComponent(marketplaceId);
195
+ const type = encodeURIComponent(paymentsProgramType);
196
+ return this.get(`/payments_program/${marketplaceId}/${type}/onboarding`);
197
+ }
198
+ /**
199
+ * This method retrieves the seller's current set of privileges.
200
+ */
201
+ getPrivileges() {
202
+ return this.get(`/privilege`);
203
+ }
204
+ /**
205
+ * This method gets a list of the seller programs that the seller has opted-in to.
206
+ */
207
+ getOptedInPrograms() {
208
+ return this.get(`/program/get_opted_in_programs`);
209
+ }
210
+ /**
211
+ * This method opts the seller in to an eBay seller program.
212
+ *
213
+ * @param body Program being opted-in to.
214
+ */
215
+ optInToProgram(body) {
216
+ return this.post(`/program/opt_in`, body);
217
+ }
218
+ /**
219
+ * This method opts the seller out of a seller program to which you have previously opted-in to.
220
+ *
221
+ * @param body Program being opted-out of.
222
+ */
223
+ optOutOfProgram(body) {
224
+ return this.post(`/program/opt_out`, body);
225
+ }
226
+ /**
227
+ * This method retrieves a seller's shipping rate tables for the country specified in the country_code query
228
+ * parameter.
229
+ *
230
+ * @param countryCode This query parameter specifies the two-letter ISO 3166-1 Alpha-2 code of country for which
231
+ * you want shipping-rate table information.
232
+ */
233
+ getRateTables(countryCode) {
234
+ return this.get(`/rate_table`, {
235
+ params: {
236
+ country_code: countryCode
237
+ }
238
+ });
239
+ }
240
+ /**
241
+ * This method retrieves all the return policies configured for the marketplace you specify using the
242
+ * marketplace_id query parameter.
243
+ *
244
+ * @param marketplaceId This query parameter specifies the ID of the eBay marketplace of the policy you want to
245
+ * retrieve.
246
+ */
247
+ getReturnPolicies(marketplaceId) {
248
+ return this.get(`/return_policy`, {
249
+ params: {
250
+ marketplace_id: marketplaceId
251
+ }
252
+ });
253
+ }
254
+ /**
255
+ * This method retrieves the complete details of the return policy specified by the returnPolicyId path parameter.
256
+ *
257
+ * @param returnPolicyId This path parameter specifies the of the return policy you want to retrieve.
258
+ */
259
+ getReturnPolicy(returnPolicyId) {
260
+ returnPolicyId = encodeURIComponent(returnPolicyId);
261
+ return this.get(`/return_policy/${returnPolicyId}`);
262
+ }
263
+ /**
264
+ * This method creates a new return policy where the policy encapsulates seller's terms for returning items.
265
+ *
266
+ * @param body Return policy request
267
+ */
268
+ createReturnPolicy(body) {
269
+ return this.post(`/return_policy`, body);
270
+ }
271
+ /**
272
+ * This method creates a new return policy where the policy encapsulates seller's terms for returning items.
273
+ *
274
+ * @param returnPolicyId This path parameter specifies the ID of the return policy you want to update.
275
+ * @param body Return policy request
276
+ */
277
+ updateReturnPolicy(returnPolicyId, body) {
278
+ returnPolicyId = encodeURIComponent(returnPolicyId);
279
+ return this.put(`/return_policy/${returnPolicyId}`, body);
280
+ }
281
+ /**
282
+ * This method deletes a return policy.
283
+ *
284
+ * @param returnPolicyId This path parameter specifies the ID of the return policy you want to delete.
285
+ */
286
+ deleteReturnPolicy(returnPolicyId) {
287
+ returnPolicyId = encodeURIComponent(returnPolicyId);
288
+ return this.delete(`/return_policy/${returnPolicyId}`);
289
+ }
290
+ /**
291
+ * This method retrieves the complete details of a single return policy.
292
+ *
293
+ * @param marketplaceId This query parameter specifies the ID of the eBay marketplace of the policy you want to
294
+ * retrieve.
295
+ * @param name This query parameter specifies the user-defined name of the return policy you want to retrieve.
296
+ */
297
+ getReturnPolicyByName(marketplaceId, name) {
298
+ return this.get(`/return_policy/get_by_policy_name`, {
299
+ params: {
300
+ marketplace_id: marketplaceId,
301
+ name
302
+ }
303
+ });
304
+ }
305
+ /**
306
+ * This call gets the current tax table entry for a specific tax jurisdiction.
307
+ *
308
+ * @param countryCode This path parameter specifies the two-letter ISO 3166-1 Alpha-2 code for the country whose
309
+ * tax table you want to retrieve.
310
+ * @param jurisdictionId This path parameter specifies the ID of the sales tax jurisdiction for the tax table entry
311
+ * you want to retrieve.
312
+ */
313
+ getSalesTax(countryCode, jurisdictionId) {
314
+ countryCode = encodeURIComponent(countryCode);
315
+ jurisdictionId = encodeURIComponent(jurisdictionId);
316
+ return this.get(`/sales_tax/${countryCode}/${jurisdictionId}`);
317
+ }
318
+ /**
319
+ * This method creates or updates a sales tax table entry for a jurisdiction.
320
+ *
321
+ * @param countryCode This path parameter specifies the two-letter ISO 3166-1 Alpha-2 code for the country for
322
+ * which you want to create tax table entry.
323
+ * @param jurisdictionId This path parameter specifies the ID of the sales-tax jurisdiction for the table entry you
324
+ * want to create.
325
+ * @param body A container that describes the how the sales tax is calculated.
326
+ */
327
+ createOrReplaceSalesTax(countryCode, jurisdictionId, body) {
328
+ countryCode = encodeURIComponent(countryCode);
329
+ jurisdictionId = encodeURIComponent(jurisdictionId);
330
+ return this.put(`/sales_tax/${countryCode}/${jurisdictionId}`, body);
331
+ }
332
+ /**
333
+ * This call deletes a tax table entry for a jurisdiction.
334
+ *
335
+ * @param countryCode This path parameter specifies the two-letter ISO 3166-1 Alpha-2 code for the country for
336
+ * which you want to create tax table entry.
337
+ * @param jurisdictionId This path parameter specifies the ID of the sales-tax jurisdiction for the table entry you
338
+ * want to delete.
339
+ */
340
+ deleteSalesTax(countryCode, jurisdictionId) {
341
+ countryCode = encodeURIComponent(countryCode);
342
+ jurisdictionId = encodeURIComponent(jurisdictionId);
343
+ return this.delete(`/sales_tax/${countryCode}/${jurisdictionId}`);
344
+ }
345
+ /**
346
+ * Use this call to retrieve a sales tax table that the seller established for a specific country.
347
+ *
348
+ * @param countryCode This path parameter specifies the two-letter ISO 3166-1 Alpha-2 code for the country whose
349
+ * tax table you want to retrieve.
350
+ */
351
+ getSalesTaxes(countryCode) {
352
+ return this.get(`/sales_tax`, {
353
+ params: {
354
+ country_code: countryCode
355
+ }
356
+ });
357
+ }
358
+ /**
359
+ * This method retrieves a list of subscriptions associated with the seller account.
360
+ * @param limit This field is for future use.
361
+ * @param continuationToken This field is for future use.
362
+ */
363
+ getSubscription({ limit, continuationToken } = {}) {
364
+ return this.get(`/subscription`, {
365
+ params: {
366
+ limit,
367
+ continuation_token: continuationToken
368
+ }
369
+ });
370
+ }
371
+ /**
372
+ * his method is used by sellers onboarded for eBay managed payments, or sellers who are currently going through, or who are eligible for onboarding for eBay managed payments.
373
+ */
374
+ getKYC() {
375
+ return this.get(`/kyc`);
376
+ }
377
+ /**
378
+ * This method allows developers to check the seller eligibility status for eBay advertising programs.
379
+ * @param programTypes A comma-separated list of eBay advertising programs.
380
+ */
381
+ getAdvertisingEligibility(programTypes) {
382
+ return this.get(`/advertising_eligibility`, {
383
+ params: {
384
+ program_types: programTypes
385
+ }
386
+ });
387
+ }
388
+ /**
389
+ * This call retrieves all defined details of the inventory location that is specified by the <b>merchantLocationKey</b> path parameter.
390
+ * @param merchantLocationKey A unique merchant-defined key (ID) for an inventory location.
391
+ */
392
+ getInventoryLocation(merchantLocationKey) {
393
+ merchantLocationKey = encodeURIComponent(merchantLocationKey);
394
+ return this.get(`/location/${merchantLocationKey}`);
395
+ }
396
+ /**
397
+ * <p>Use this call to create a new inventory location.
398
+ * @param merchantLocationKey A unique, merchant-defined key (ID) for an inventory location.
399
+ * @param body Inventory Location details
400
+ */
401
+ createInventoryLocation(merchantLocationKey, body) {
402
+ merchantLocationKey = encodeURIComponent(merchantLocationKey);
403
+ return this.post(`/location/${merchantLocationKey}`, body);
404
+ }
405
+ /**
406
+ * <p>This call deletes the inventory location that is specified in the <code>merchantLocationKey</code> path parameter.
407
+ * @param merchantLocationKey
408
+ */
409
+ deleteInventoryLocation(merchantLocationKey) {
410
+ merchantLocationKey = encodeURIComponent(merchantLocationKey);
411
+ return this.delete(`/location/${merchantLocationKey}`);
412
+ }
413
+ /**
414
+ * <p>This call disables the inventory location that is specified in the <code>merchantLocationKey</code> path parameter.
415
+ * @param merchantLocationKey A unique merchant-defined key (ID) for an inventory location.
416
+ */
417
+ disableInventoryLocation(merchantLocationKey) {
418
+ merchantLocationKey = encodeURIComponent(merchantLocationKey);
419
+ return this.post(`/location/${merchantLocationKey}/disable`);
420
+ }
421
+ /**
422
+ * <p>This call enables a disabled inventory location that is specified in the <code>merchantLocationKey</code> path parameter.
423
+ * @param merchantLocationKey A unique merchant-defined key (ID) for an inventory location.
424
+ */
425
+ enableInventoryLocation(merchantLocationKey) {
426
+ merchantLocationKey = encodeURIComponent(merchantLocationKey);
427
+ return this.post(`/location/${merchantLocationKey}/enable`);
428
+ }
429
+ /**
430
+ * This call retrieves all defined details for every inventory location associated with the seller's account.
431
+ * @param limit The value passed in this query parameter sets the maximum number of records to return per page of data.
432
+ * @param offset Specifies the number of locations to skip in the result set before returning the first location in the paginated response.
433
+ */
434
+ getInventoryLocations({ limit, offset } = {}) {
435
+ return this.get(`/location`, {
436
+ params: {
437
+ limit,
438
+ offset
439
+ }
440
+ });
441
+ }
442
+ /**
443
+ * <p>Use this call to update non-physical location details for an existing inventory location.
444
+ * @param merchantLocationKey A unique merchant-defined key (ID) for an inventory location.
445
+ * @param body The inventory location details to be updated (other than the address and geo co-ordinates).
446
+ */
447
+ updateInventoryLocation(merchantLocationKey, body) {
448
+ merchantLocationKey = encodeURIComponent(merchantLocationKey);
449
+ return this.post(`/location/${merchantLocationKey}/update_location_details`, body);
450
+ }
451
+ /**
452
+ * This method retrieves all the sales tax jurisdictions for the country that you specify in the <b>countryCode</b> path parameter.
453
+ * @param countryCode This path parameter specifies the two-letter <a href="https://www.iso.org/iso-3166-country-codes.html " title="https://www.iso.org " target="_blank">ISO 3166</a> country code for the country whose jurisdictions you want to retrieve. eBay provides sales tax jurisdiction information for Canada and the United States.
454
+ */
455
+ getSalesTaxJurisdictions(countryCode) {
456
+ countryCode = encodeURIComponent(countryCode);
457
+ return this.get(`/country/${countryCode}/sales_tax_jurisdiction`);
458
+ }
459
+ }
460
+ Account.id = 'Account';
461
+ export default Account;