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
@@ -1,17 +1,8 @@
1
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
2
  class Account extends Restful {
8
3
  get basePath() {
9
4
  return '/sell/account/v1';
10
5
  }
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
6
  getCustomPolicies(policyTypes) {
16
7
  return this.get(`/custom_policy/`, {
17
8
  params: {
@@ -19,36 +10,17 @@ class Account extends Restful {
19
10
  }
20
11
  });
21
12
  }
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
13
  createCustomPolicy(body) {
27
14
  return this.post(`/custom_policy/`, body);
28
15
  }
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
16
  getCustomPolicy(customPolicyId) {
34
17
  customPolicyId = encodeURIComponent(customPolicyId);
35
18
  return this.get(`/custom_policy/${customPolicyId}`);
36
19
  }
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
20
  updateCustomPolicy(customPolicyId, body) {
43
21
  customPolicyId = encodeURIComponent(customPolicyId);
44
22
  return this.put(`/custom_policy/${customPolicyId}`, body);
45
23
  }
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
24
  getFulfillmentPolicies(marketplaceId) {
53
25
  return this.get(`/fulfillment_policy`, {
54
26
  params: {
@@ -56,49 +28,20 @@ class Account extends Restful {
56
28
  }
57
29
  });
58
30
  }
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
31
  createFulfillmentPolicy(body) {
66
32
  return this.post(`/fulfillment_policy/`, body);
67
33
  }
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
34
  updateFulfillmentPolicy(fulfillmentPolicyId, body) {
75
35
  fulfillmentPolicyId = encodeURIComponent(fulfillmentPolicyId);
76
36
  return this.put(`/fulfillment_policy/${fulfillmentPolicyId}`, body);
77
37
  }
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
38
  deleteFulfillmentPolicy(fulfillmentPolicyId) {
84
39
  fulfillmentPolicyId = encodeURIComponent(fulfillmentPolicyId);
85
40
  return this.delete(`/fulfillment_policy/${fulfillmentPolicyId}`);
86
41
  }
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
42
  getFulfillmentPolicy(fulfillmentPolicyId) {
94
43
  return this.get(`/fulfillment_policy/${fulfillmentPolicyId}`);
95
44
  }
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
45
  getFulfillmentPolicyByName(marketplaceId, name) {
103
46
  return this.get(`/fulfillment_policy/get_by_policy_name`, {
104
47
  params: {
@@ -107,12 +50,6 @@ class Account extends Restful {
107
50
  }
108
51
  });
109
52
  }
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
53
  getPaymentPolicies(marketplaceId) {
117
54
  return this.get(`/payment_policy`, {
118
55
  params: {
@@ -120,49 +57,21 @@ class Account extends Restful {
120
57
  }
121
58
  });
122
59
  }
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
60
  getPaymentPolicy(paymentPolicyId) {
130
61
  paymentPolicyId = encodeURIComponent(paymentPolicyId);
131
62
  return this.get(`/payment_policy/${paymentPolicyId}`);
132
63
  }
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
64
  createPaymentPolicy(body) {
139
65
  return this.post(`/payment_policy`, body);
140
66
  }
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
67
  updatePaymentPolicy(paymentPolicyId, body) {
148
68
  paymentPolicyId = encodeURIComponent(paymentPolicyId);
149
69
  return this.put(`/payment_policy/${paymentPolicyId}`, body);
150
70
  }
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
71
  deletePaymentPolicy(paymentPolicyId) {
157
72
  paymentPolicyId = encodeURIComponent(paymentPolicyId);
158
73
  return this.delete(`/payment_policy/${paymentPolicyId}`);
159
74
  }
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
75
  getPaymentPolicyByName(marketplaceId, name) {
167
76
  return this.get(`/payment_policy/get_by_policy_name`, {
168
77
  params: {
@@ -171,65 +80,28 @@ class Account extends Restful {
171
80
  }
172
81
  });
173
82
  }
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
83
  getPaymentsProgram(marketplaceId, paymentsProgramType) {
182
84
  marketplaceId = encodeURIComponent(marketplaceId);
183
85
  const type = encodeURIComponent(paymentsProgramType);
184
86
  return this.get(`/payments_program/${marketplaceId}/${type}`);
185
87
  }
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
88
  getPaymentsProgramOnboarding(marketplaceId, paymentsProgramType) {
194
89
  marketplaceId = encodeURIComponent(marketplaceId);
195
90
  const type = encodeURIComponent(paymentsProgramType);
196
91
  return this.get(`/payments_program/${marketplaceId}/${type}/onboarding`);
197
92
  }
198
- /**
199
- * This method retrieves the seller's current set of privileges.
200
- */
201
93
  getPrivileges() {
202
94
  return this.get(`/privilege`);
203
95
  }
204
- /**
205
- * This method gets a list of the seller programs that the seller has opted-in to.
206
- */
207
96
  getOptedInPrograms() {
208
97
  return this.get(`/program/get_opted_in_programs`);
209
98
  }
210
- /**
211
- * This method opts the seller in to an eBay seller program.
212
- *
213
- * @param body Program being opted-in to.
214
- */
215
99
  optInToProgram(body) {
216
100
  return this.post(`/program/opt_in`, body);
217
101
  }
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
102
  optOutOfProgram(body) {
224
103
  return this.post(`/program/opt_out`, body);
225
104
  }
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
105
  getRateTables(countryCode) {
234
106
  return this.get(`/rate_table`, {
235
107
  params: {
@@ -237,13 +109,6 @@ class Account extends Restful {
237
109
  }
238
110
  });
239
111
  }
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
112
  getReturnPolicies(marketplaceId) {
248
113
  return this.get(`/return_policy`, {
249
114
  params: {
@@ -251,49 +116,21 @@ class Account extends Restful {
251
116
  }
252
117
  });
253
118
  }
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
119
  getReturnPolicy(returnPolicyId) {
260
120
  returnPolicyId = encodeURIComponent(returnPolicyId);
261
121
  return this.get(`/return_policy/${returnPolicyId}`);
262
122
  }
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
123
  createReturnPolicy(body) {
269
124
  return this.post(`/return_policy`, body);
270
125
  }
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
126
  updateReturnPolicy(returnPolicyId, body) {
278
127
  returnPolicyId = encodeURIComponent(returnPolicyId);
279
128
  return this.put(`/return_policy/${returnPolicyId}`, body);
280
129
  }
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
130
  deleteReturnPolicy(returnPolicyId) {
287
131
  returnPolicyId = encodeURIComponent(returnPolicyId);
288
132
  return this.delete(`/return_policy/${returnPolicyId}`);
289
133
  }
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
134
  getReturnPolicyByName(marketplaceId, name) {
298
135
  return this.get(`/return_policy/get_by_policy_name`, {
299
136
  params: {
@@ -302,52 +139,21 @@ class Account extends Restful {
302
139
  }
303
140
  });
304
141
  }
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
142
  getSalesTax(countryCode, jurisdictionId) {
314
143
  countryCode = encodeURIComponent(countryCode);
315
144
  jurisdictionId = encodeURIComponent(jurisdictionId);
316
145
  return this.get(`/sales_tax/${countryCode}/${jurisdictionId}`);
317
146
  }
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
147
  createOrReplaceSalesTax(countryCode, jurisdictionId, body) {
328
148
  countryCode = encodeURIComponent(countryCode);
329
149
  jurisdictionId = encodeURIComponent(jurisdictionId);
330
150
  return this.put(`/sales_tax/${countryCode}/${jurisdictionId}`, body);
331
151
  }
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
152
  deleteSalesTax(countryCode, jurisdictionId) {
341
153
  countryCode = encodeURIComponent(countryCode);
342
154
  jurisdictionId = encodeURIComponent(jurisdictionId);
343
155
  return this.delete(`/sales_tax/${countryCode}/${jurisdictionId}`);
344
156
  }
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
157
  getSalesTaxes(countryCode) {
352
158
  return this.get(`/sales_tax`, {
353
159
  params: {
@@ -355,11 +161,6 @@ class Account extends Restful {
355
161
  }
356
162
  });
357
163
  }
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
164
  getSubscription({ limit, continuationToken } = {}) {
364
165
  return this.get(`/subscription`, {
365
166
  params: {
@@ -368,16 +169,9 @@ class Account extends Restful {
368
169
  }
369
170
  });
370
171
  }
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
172
  getKYC() {
375
173
  return this.get(`/kyc`);
376
174
  }
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
175
  getAdvertisingEligibility(programTypes) {
382
176
  return this.get(`/advertising_eligibility`, {
383
177
  params: {
@@ -385,52 +179,26 @@ class Account extends Restful {
385
179
  }
386
180
  });
387
181
  }
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
182
  getInventoryLocation(merchantLocationKey) {
393
183
  merchantLocationKey = encodeURIComponent(merchantLocationKey);
394
184
  return this.get(`/location/${merchantLocationKey}`);
395
185
  }
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
186
  createInventoryLocation(merchantLocationKey, body) {
402
187
  merchantLocationKey = encodeURIComponent(merchantLocationKey);
403
188
  return this.post(`/location/${merchantLocationKey}`, body);
404
189
  }
405
- /**
406
- * <p>This call deletes the inventory location that is specified in the <code>merchantLocationKey</code> path parameter.
407
- * @param merchantLocationKey
408
- */
409
190
  deleteInventoryLocation(merchantLocationKey) {
410
191
  merchantLocationKey = encodeURIComponent(merchantLocationKey);
411
192
  return this.delete(`/location/${merchantLocationKey}`);
412
193
  }
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
194
  disableInventoryLocation(merchantLocationKey) {
418
195
  merchantLocationKey = encodeURIComponent(merchantLocationKey);
419
196
  return this.post(`/location/${merchantLocationKey}/disable`);
420
197
  }
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
198
  enableInventoryLocation(merchantLocationKey) {
426
199
  merchantLocationKey = encodeURIComponent(merchantLocationKey);
427
200
  return this.post(`/location/${merchantLocationKey}/enable`);
428
201
  }
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
202
  getInventoryLocations({ limit, offset } = {}) {
435
203
  return this.get(`/location`, {
436
204
  params: {
@@ -439,19 +207,10 @@ class Account extends Restful {
439
207
  }
440
208
  });
441
209
  }
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
210
  updateInventoryLocation(merchantLocationKey, body) {
448
211
  merchantLocationKey = encodeURIComponent(merchantLocationKey);
449
212
  return this.post(`/location/${merchantLocationKey}/update_location_details`, body);
450
213
  }
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
214
  getSalesTaxJurisdictions(countryCode) {
456
215
  countryCode = encodeURIComponent(countryCode);
457
216
  return this.get(`/country/${countryCode}/sales_tax_jurisdiction`);
@@ -1,42 +1,16 @@
1
1
  import { Metric } from '../../../../enums/index.js';
2
2
  import { operations } from '../../../../types/restful/specs/sell_analytics_v1_oas3.js';
3
3
  import Restful, { OpenApi } from '../../index.js';
4
- /**
5
- * The Analytics API provides information about a seller's business performance.
6
- */
7
4
  export default class Analytics extends Restful implements OpenApi<operations> {
8
5
  static id: string;
9
6
  get basePath(): string;
10
- /**
11
- * This call retrieves all the profiles for the associated seller.
12
- */
13
7
  findSellerStandardsProfiles(): Promise<any>;
14
- /**
15
- * This call retrieves seller's profiles based on a program or cycle.
16
- *
17
- * @param program Specifies the program of the requested profile.
18
- * @param cycle Specifies the cycle of the requested profile.
19
- */
20
8
  getSellerStandardsProfile(program: string, cycle: string): Promise<any>;
21
- /**
22
- * This call returns a report that details the user-traffic a seller's listings receives.
23
- *
24
- * @param dimension Specifies the basis of the report data.
25
- * @param filter Limits the report data returned.
26
- * @param metric Specifies a comma separated list of the metrics you want included in the report.
27
- * @param sort Specifies a single metric to be sorted and whether you want to sort in ascending or descending order.
28
- */
29
9
  getTrafficReport({ dimension, filter, metric, sort }?: {
30
10
  dimension?: string;
31
11
  filter?: string;
32
12
  metric?: Metric | `${Metric}`;
33
13
  sort?: string;
34
14
  }): Promise<any>;
35
- /**
36
- * Use this method to retrieve a seller's performance and rating for the customer service metric.
37
- *
38
- * @param customerServiceMetricType Use this path parameter to specify the type of customer service metrics and benchmark data you want returned for the seller.
39
- * @param evaluationType Use this query parameter to specify the Marketplace ID to evaluate for the customer service metrics and benchmark data.
40
- */
41
15
  getCustomerServiceMetric(customerServiceMetricType: string, evaluationType: string): Promise<any>;
42
16
  }
@@ -1,36 +1,16 @@
1
1
  import Restful from '../../index.js';
2
- /**
3
- * The Analytics API provides information about a seller's business performance.
4
- */
5
2
  class Analytics extends Restful {
6
3
  get basePath() {
7
4
  return '/sell/analytics/v1';
8
5
  }
9
- /**
10
- * This call retrieves all the profiles for the associated seller.
11
- */
12
6
  findSellerStandardsProfiles() {
13
7
  return this.get(`/seller_standards_profile`);
14
8
  }
15
- /**
16
- * This call retrieves seller's profiles based on a program or cycle.
17
- *
18
- * @param program Specifies the program of the requested profile.
19
- * @param cycle Specifies the cycle of the requested profile.
20
- */
21
9
  getSellerStandardsProfile(program, cycle) {
22
10
  program = encodeURIComponent(program);
23
11
  cycle = encodeURIComponent(cycle);
24
12
  return this.get(`/seller_standards_profile/${program}/${cycle}`);
25
13
  }
26
- /**
27
- * This call returns a report that details the user-traffic a seller's listings receives.
28
- *
29
- * @param dimension Specifies the basis of the report data.
30
- * @param filter Limits the report data returned.
31
- * @param metric Specifies a comma separated list of the metrics you want included in the report.
32
- * @param sort Specifies a single metric to be sorted and whether you want to sort in ascending or descending order.
33
- */
34
14
  getTrafficReport({ dimension, filter, metric, sort } = {}) {
35
15
  return this.get(`/traffic_report`, {
36
16
  params: {
@@ -41,12 +21,6 @@ class Analytics extends Restful {
41
21
  }
42
22
  });
43
23
  }
44
- /**
45
- * Use this method to retrieve a seller's performance and rating for the customer service metric.
46
- *
47
- * @param customerServiceMetricType Use this path parameter to specify the type of customer service metrics and benchmark data you want returned for the seller.
48
- * @param evaluationType Use this query parameter to specify the Marketplace ID to evaluate for the customer service metrics and benchmark data.
49
- */
50
24
  getCustomerServiceMetric(customerServiceMetricType, evaluationType) {
51
25
  return this.get(`/customer_service_metric/${customerServiceMetricType}/${evaluationType}`);
52
26
  }
@@ -1,38 +1,15 @@
1
1
  import { SuppressViolationRequest } from '../../../../types/index.js';
2
2
  import { operations } from '../../../../types/restful/specs/sell_compliance_v1_oas3.js';
3
3
  import Restful, { OpenApi } from '../../index.js';
4
- /**
5
- * Service for providing the compliance violations of seller account/listings
6
- */
7
4
  export default class Compliance extends Restful implements OpenApi<operations> {
8
5
  static id: string;
9
6
  get basePath(): string;
10
- /**
11
- * This call returns listing violation counts for a seller.
12
- *
13
- * @param complianceType A user passes in one or more compliance type values through this query parameter.
14
- */
15
7
  getListingViolationsSummary(complianceType?: string): Promise<any>;
16
- /**
17
- * This call returns specific listing violations for five different compliance types.
18
- *
19
- * @param complianceType A user passes in one or more compliance type values through this query parameter.
20
- * @param offset The first policy violation to return based on its position in the collection of listing
21
- * violations.
22
- * @param listingId
23
- * @param limit This query parameter is used if the user wants to set a limit on the number of listing violations
24
- * that are returned in the current result set.
25
- */
26
8
  getListingViolations({ complianceType, offset, listingId, limit }?: {
27
9
  complianceType?: string;
28
10
  offset?: number;
29
11
  listingId?: string;
30
12
  limit?: number;
31
13
  }): Promise<any>;
32
- /**
33
- * This call suppresses a listing violation for a specific listing. Only listing violations in the AT_RISK state (returned in the violations.complianceState field of the getListingViolations call) can be suppressed.
34
- *
35
- * @param body SuppressViolationRequest
36
- */
37
14
  suppressViolation(body: SuppressViolationRequest): Promise<any>;
38
15
  }
@@ -1,16 +1,8 @@
1
1
  import Restful from '../../index.js';
2
- /**
3
- * Service for providing the compliance violations of seller account/listings
4
- */
5
2
  class Compliance extends Restful {
6
3
  get basePath() {
7
4
  return '/sell/compliance/v1';
8
5
  }
9
- /**
10
- * This call returns listing violation counts for a seller.
11
- *
12
- * @param complianceType A user passes in one or more compliance type values through this query parameter.
13
- */
14
6
  getListingViolationsSummary(complianceType) {
15
7
  return this.get(`/listing_violation_summary`, {
16
8
  params: {
@@ -18,16 +10,6 @@ class Compliance extends Restful {
18
10
  }
19
11
  });
20
12
  }
21
- /**
22
- * This call returns specific listing violations for five different compliance types.
23
- *
24
- * @param complianceType A user passes in one or more compliance type values through this query parameter.
25
- * @param offset The first policy violation to return based on its position in the collection of listing
26
- * violations.
27
- * @param listingId
28
- * @param limit This query parameter is used if the user wants to set a limit on the number of listing violations
29
- * that are returned in the current result set.
30
- */
31
13
  getListingViolations({ complianceType, offset, listingId, limit } = {}) {
32
14
  return this.get(`/listing_violation`, {
33
15
  params: {
@@ -38,11 +20,6 @@ class Compliance extends Restful {
38
20
  }
39
21
  });
40
22
  }
41
- /**
42
- * This call suppresses a listing violation for a specific listing. Only listing violations in the AT_RISK state (returned in the violations.complianceState field of the getListingViolations call) can be suppressed.
43
- *
44
- * @param body SuppressViolationRequest
45
- */
46
23
  suppressViolation(body) {
47
24
  return this.post(`/suppress_listing_violation`, body);
48
25
  }