workarea-api 4.4.6

Sign up to get free protection for your applications and to get access to all the features.
Files changed (622) hide show
  1. checksums.yaml +7 -0
  2. data/.editorconfig +20 -0
  3. data/.github/ISSUE_TEMPLATE/bug_report.md +37 -0
  4. data/.github/ISSUE_TEMPLATE/documentation-request.md +17 -0
  5. data/.github/ISSUE_TEMPLATE/feature_request.md +20 -0
  6. data/.gitignore +24 -0
  7. data/.yardopts +1 -0
  8. data/CHANGELOG.md +807 -0
  9. data/CODE_OF_CONDUCT.md +3 -0
  10. data/CONTRIBUTING.md +3 -0
  11. data/Gemfile +21 -0
  12. data/LICENSE +52 -0
  13. data/README.md +107 -0
  14. data/Rakefile +121 -0
  15. data/admin/.gitignore +12 -0
  16. data/admin/README.md +82 -0
  17. data/admin/Rakefile +10 -0
  18. data/admin/app/assets/images/workarea/api/admin/icons/api.svg +1 -0
  19. data/admin/app/controllers/workarea/api/admin/application_controller.rb +73 -0
  20. data/admin/app/controllers/workarea/api/admin/categories_controller.rb +305 -0
  21. data/admin/app/controllers/workarea/api/admin/category_product_rules_controller.rb +232 -0
  22. data/admin/app/controllers/workarea/api/admin/content_assets_controller.rb +299 -0
  23. data/admin/app/controllers/workarea/api/admin/content_controller.rb +268 -0
  24. data/admin/app/controllers/workarea/api/admin/discounts_controller.rb +271 -0
  25. data/admin/app/controllers/workarea/api/admin/email_signups_controller.rb +108 -0
  26. data/admin/app/controllers/workarea/api/admin/fulfillments_controller.rb +268 -0
  27. data/admin/app/controllers/workarea/api/admin/inventory_skus_controller.rb +305 -0
  28. data/admin/app/controllers/workarea/api/admin/navigation_menus_controller.rb +267 -0
  29. data/admin/app/controllers/workarea/api/admin/navigation_taxons_controller.rb +305 -0
  30. data/admin/app/controllers/workarea/api/admin/orders_controller.rb +160 -0
  31. data/admin/app/controllers/workarea/api/admin/pages_controller.rb +305 -0
  32. data/admin/app/controllers/workarea/api/admin/payment_profiles_controller.rb +305 -0
  33. data/admin/app/controllers/workarea/api/admin/payment_transactions_controller.rb +108 -0
  34. data/admin/app/controllers/workarea/api/admin/payments_controller.rb +115 -0
  35. data/admin/app/controllers/workarea/api/admin/prices_controller.rb +232 -0
  36. data/admin/app/controllers/workarea/api/admin/pricing_skus_controller.rb +305 -0
  37. data/admin/app/controllers/workarea/api/admin/product_images_controller.rb +232 -0
  38. data/admin/app/controllers/workarea/api/admin/products_controller.rb +305 -0
  39. data/admin/app/controllers/workarea/api/admin/promo_code_lists_controller.rb +305 -0
  40. data/admin/app/controllers/workarea/api/admin/recommendation_settings_controller.rb +122 -0
  41. data/admin/app/controllers/workarea/api/admin/redirects_controller.rb +305 -0
  42. data/admin/app/controllers/workarea/api/admin/releases_controller.rb +304 -0
  43. data/admin/app/controllers/workarea/api/admin/saved_addresses_controller.rb +232 -0
  44. data/admin/app/controllers/workarea/api/admin/saved_credit_cards_controller.rb +256 -0
  45. data/admin/app/controllers/workarea/api/admin/shipping_rates_controller.rb +232 -0
  46. data/admin/app/controllers/workarea/api/admin/shipping_services_controller.rb +299 -0
  47. data/admin/app/controllers/workarea/api/admin/shippings_controller.rb +105 -0
  48. data/admin/app/controllers/workarea/api/admin/swagger_controller.rb +41 -0
  49. data/admin/app/controllers/workarea/api/admin/tax_categories_controller.rb +242 -0
  50. data/admin/app/controllers/workarea/api/admin/tax_rates_controller.rb +292 -0
  51. data/admin/app/controllers/workarea/api/admin/users_controller.rb +296 -0
  52. data/admin/app/controllers/workarea/api/admin/variants_controller.rb +232 -0
  53. data/admin/app/models/workarea/api/admin/bulk_upsert.rb +74 -0
  54. data/admin/app/models/workarea/user.decorator +7 -0
  55. data/admin/app/views/workarea/admin/users/_api_permissions.html.haml +6 -0
  56. data/admin/app/workers/workarea/perform_api_bulk_upsert.rb +15 -0
  57. data/admin/bin/rails +18 -0
  58. data/admin/config/initializers/append_points.rb +4 -0
  59. data/admin/config/initializers/config.rb +15 -0
  60. data/admin/config/locales/en.yml +9 -0
  61. data/admin/config/routes.rb +81 -0
  62. data/admin/lib/workarea/api/admin/engine.rb +14 -0
  63. data/admin/lib/workarea/api/admin/swagger.rb +106 -0
  64. data/admin/lib/workarea/api/admin.rb +21 -0
  65. data/admin/test/documentation/workarea/api/admin/categories_documentation_test.rb +106 -0
  66. data/admin/test/documentation/workarea/api/admin/category_product_rules_documentation_test.rb +78 -0
  67. data/admin/test/documentation/workarea/api/admin/content_assets_documentation_test.rb +94 -0
  68. data/admin/test/documentation/workarea/api/admin/content_documentation_test.rb +87 -0
  69. data/admin/test/documentation/workarea/api/admin/discounts_documentation_test.rb +85 -0
  70. data/admin/test/documentation/workarea/api/admin/email_signups_documentation_test.rb +41 -0
  71. data/admin/test/documentation/workarea/api/admin/fulfillment_documentation_test.rb +84 -0
  72. data/admin/test/documentation/workarea/api/admin/inventory_skus_documentation_test.rb +95 -0
  73. data/admin/test/documentation/workarea/api/admin/navigation_menus_documentation_test.rb +81 -0
  74. data/admin/test/documentation/workarea/api/admin/navigation_taxons_documentation_test.rb +94 -0
  75. data/admin/test/documentation/workarea/api/admin/orders_documentation_test.rb +65 -0
  76. data/admin/test/documentation/workarea/api/admin/pages_documentation_test.rb +93 -0
  77. data/admin/test/documentation/workarea/api/admin/payment_profiles_documentation_test.rb +98 -0
  78. data/admin/test/documentation/workarea/api/admin/payment_transactions_documentation_test.rb +43 -0
  79. data/admin/test/documentation/workarea/api/admin/payments_documentation_test.rb +41 -0
  80. data/admin/test/documentation/workarea/api/admin/prices_documentation_test.rb +82 -0
  81. data/admin/test/documentation/workarea/api/admin/pricing_skus_documentation_test.rb +95 -0
  82. data/admin/test/documentation/workarea/api/admin/product_images_documentation_test.rb +101 -0
  83. data/admin/test/documentation/workarea/api/admin/products_documentation_test.rb +96 -0
  84. data/admin/test/documentation/workarea/api/admin/promo_code_lists_documentation_test.rb +94 -0
  85. data/admin/test/documentation/workarea/api/admin/recommendation_settings_documentation_test.rb +37 -0
  86. data/admin/test/documentation/workarea/api/admin/redirects_documentation_test.rb +96 -0
  87. data/admin/test/documentation/workarea/api/admin/release_changes_documentation_test.rb +32 -0
  88. data/admin/test/documentation/workarea/api/admin/releases_documentation_test.rb +93 -0
  89. data/admin/test/documentation/workarea/api/admin/saved_addresses_documentation_test.rb +92 -0
  90. data/admin/test/documentation/workarea/api/admin/saved_credit_cards_documentation_test.rb +86 -0
  91. data/admin/test/documentation/workarea/api/admin/shipping_rates_documentation_test.rb +78 -0
  92. data/admin/test/documentation/workarea/api/admin/shipping_services_documentation_test.rb +93 -0
  93. data/admin/test/documentation/workarea/api/admin/shippings_documentation_test.rb +41 -0
  94. data/admin/test/documentation/workarea/api/admin/tax_categories_documentation_test.rb +95 -0
  95. data/admin/test/documentation/workarea/api/admin/tax_rates_documentation_test.rb +78 -0
  96. data/admin/test/documentation/workarea/api/admin/users_documentation_test.rb +99 -0
  97. data/admin/test/documentation/workarea/api/admin/variants_documentation_test.rb +80 -0
  98. data/admin/test/dummy/Rakefile +7 -0
  99. data/admin/test/dummy/app/assets/config/manifest.js +4 -0
  100. data/admin/test/dummy/app/assets/images/.keep +0 -0
  101. data/admin/test/dummy/app/assets/javascripts/application.js +13 -0
  102. data/admin/test/dummy/app/assets/stylesheets/application.css +15 -0
  103. data/admin/test/dummy/app/controllers/application_controller.rb +3 -0
  104. data/admin/test/dummy/app/controllers/concerns/.keep +0 -0
  105. data/admin/test/dummy/app/helpers/application_helper.rb +2 -0
  106. data/admin/test/dummy/app/jobs/application_job.rb +2 -0
  107. data/admin/test/dummy/app/mailers/.keep +0 -0
  108. data/admin/test/dummy/app/mailers/application_mailer.rb +4 -0
  109. data/admin/test/dummy/app/models/.keep +0 -0
  110. data/admin/test/dummy/app/models/concerns/.keep +0 -0
  111. data/admin/test/dummy/app/views/layouts/application.html.erb +14 -0
  112. data/admin/test/dummy/app/views/layouts/mailer.html.erb +13 -0
  113. data/admin/test/dummy/app/views/layouts/mailer.text.erb +1 -0
  114. data/admin/test/dummy/bin/bundle +3 -0
  115. data/admin/test/dummy/bin/rails +4 -0
  116. data/admin/test/dummy/bin/rake +4 -0
  117. data/admin/test/dummy/bin/setup +34 -0
  118. data/admin/test/dummy/bin/update +29 -0
  119. data/admin/test/dummy/config/application.rb +25 -0
  120. data/admin/test/dummy/config/boot.rb +5 -0
  121. data/admin/test/dummy/config/cable.yml +9 -0
  122. data/admin/test/dummy/config/environment.rb +5 -0
  123. data/admin/test/dummy/config/environments/development.rb +55 -0
  124. data/admin/test/dummy/config/environments/production.rb +86 -0
  125. data/admin/test/dummy/config/environments/test.rb +43 -0
  126. data/admin/test/dummy/config/initializers/application_controller_renderer.rb +6 -0
  127. data/admin/test/dummy/config/initializers/assets.rb +11 -0
  128. data/admin/test/dummy/config/initializers/backtrace_silencers.rb +7 -0
  129. data/admin/test/dummy/config/initializers/cookies_serializer.rb +5 -0
  130. data/admin/test/dummy/config/initializers/filter_parameter_logging.rb +4 -0
  131. data/admin/test/dummy/config/initializers/inflections.rb +16 -0
  132. data/admin/test/dummy/config/initializers/mime_types.rb +4 -0
  133. data/admin/test/dummy/config/initializers/new_framework_defaults.rb +21 -0
  134. data/admin/test/dummy/config/initializers/session_store.rb +3 -0
  135. data/admin/test/dummy/config/initializers/workarea.rb +8 -0
  136. data/admin/test/dummy/config/initializers/wrap_parameters.rb +14 -0
  137. data/admin/test/dummy/config/locales/en.yml +23 -0
  138. data/admin/test/dummy/config/puma.rb +47 -0
  139. data/admin/test/dummy/config/routes.rb +6 -0
  140. data/admin/test/dummy/config/secrets.yml +22 -0
  141. data/admin/test/dummy/config/spring.rb +6 -0
  142. data/admin/test/dummy/config.ru +4 -0
  143. data/admin/test/dummy/db/seeds.rb +2 -0
  144. data/admin/test/dummy/log/.keep +0 -0
  145. data/admin/test/dummy/public/404.html +67 -0
  146. data/admin/test/dummy/public/422.html +67 -0
  147. data/admin/test/dummy/public/500.html +66 -0
  148. data/admin/test/dummy/public/apple-touch-icon-precomposed.png +0 -0
  149. data/admin/test/dummy/public/apple-touch-icon.png +0 -0
  150. data/admin/test/dummy/public/favicon.ico +1 -0
  151. data/admin/test/integration/workarea/api/admin/audit_log_integration_test.rb +20 -0
  152. data/admin/test/integration/workarea/api/admin/authentication_integration_test.rb +61 -0
  153. data/admin/test/integration/workarea/api/admin/categories_integration_test.rb +64 -0
  154. data/admin/test/integration/workarea/api/admin/category_product_rules_integration_test.rb +58 -0
  155. data/admin/test/integration/workarea/api/admin/content_assets_integration_test.rb +65 -0
  156. data/admin/test/integration/workarea/api/admin/content_integration_test.rb +59 -0
  157. data/admin/test/integration/workarea/api/admin/discounts_integration_test.rb +64 -0
  158. data/admin/test/integration/workarea/api/admin/email_signups_integration_test.rb +32 -0
  159. data/admin/test/integration/workarea/api/admin/error_handling_integration_test.rb +16 -0
  160. data/admin/test/integration/workarea/api/admin/fulfillments_integration_test.rb +62 -0
  161. data/admin/test/integration/workarea/api/admin/inventory_skus_integration_test.rb +70 -0
  162. data/admin/test/integration/workarea/api/admin/navigation_menus_integration_test.rb +54 -0
  163. data/admin/test/integration/workarea/api/admin/navigation_taxons_integration_test.rb +63 -0
  164. data/admin/test/integration/workarea/api/admin/orders_integration_test.rb +53 -0
  165. data/admin/test/integration/workarea/api/admin/pages_integration_test.rb +64 -0
  166. data/admin/test/integration/workarea/api/admin/payment_profiles_integration_test.rb +75 -0
  167. data/admin/test/integration/workarea/api/admin/payment_transactions_integration_test.rb +45 -0
  168. data/admin/test/integration/workarea/api/admin/payments_integration_test.rb +29 -0
  169. data/admin/test/integration/workarea/api/admin/prices_integration_test.rb +55 -0
  170. data/admin/test/integration/workarea/api/admin/pricing_skus_integration_test.rb +72 -0
  171. data/admin/test/integration/workarea/api/admin/product_images_integration_test.rb +56 -0
  172. data/admin/test/integration/workarea/api/admin/products_integration_test.rb +66 -0
  173. data/admin/test/integration/workarea/api/admin/promo_code_lists_integration_test.rb +70 -0
  174. data/admin/test/integration/workarea/api/admin/recommendation_settings_integration_test.rb +41 -0
  175. data/admin/test/integration/workarea/api/admin/redirects_integration_test.rb +69 -0
  176. data/admin/test/integration/workarea/api/admin/release_changes_integration_test.rb +32 -0
  177. data/admin/test/integration/workarea/api/admin/releases_integration_test.rb +60 -0
  178. data/admin/test/integration/workarea/api/admin/saved_addresses_integration_test.rb +70 -0
  179. data/admin/test/integration/workarea/api/admin/saved_credit_cards_integration_test.rb +76 -0
  180. data/admin/test/integration/workarea/api/admin/shipping_rates_integration_test.rb +54 -0
  181. data/admin/test/integration/workarea/api/admin/shipping_services_integration_test.rb +64 -0
  182. data/admin/test/integration/workarea/api/admin/shippings_integration_test.rb +34 -0
  183. data/admin/test/integration/workarea/api/admin/tax_categories_integration_test.rb +64 -0
  184. data/admin/test/integration/workarea/api/admin/tax_rates_integration_test.rb +66 -0
  185. data/admin/test/integration/workarea/api/admin/users_integration_test.rb +67 -0
  186. data/admin/test/integration/workarea/api/admin/variants_integration_test.rb +59 -0
  187. data/admin/test/models/workarea/api/admin/bulk_upsert_test.rb +79 -0
  188. data/admin/test/test_helper.rb +10 -0
  189. data/admin/test/vcr_cassettes/product_image_from_url.yml +43 -0
  190. data/admin/workarea-api-admin.gemspec +18 -0
  191. data/app/views/workarea/api/docs/engine_index.haml +1 -0
  192. data/app/views/workarea/api/docs/example.haml +114 -0
  193. data/app/views/workarea/api/docs/index.haml +28 -0
  194. data/app/views/workarea/api/docs/javascripts.haml +31 -0
  195. data/app/views/workarea/api/docs/javascripts_head.haml +5 -0
  196. data/app/views/workarea/api/docs/layout.haml +32 -0
  197. data/app/views/workarea/api/docs/logo.haml +1 -0
  198. data/app/views/workarea/api/docs/nav.haml +7 -0
  199. data/app/views/workarea/api/docs/stylesheets.haml +278 -0
  200. data/config/initializers/raddocs.rb +12 -0
  201. data/config/initializers/workarea.rb +3 -0
  202. data/config/routes.rb +5 -0
  203. data/doc/api/admin/categories/bulk_upserting_categories.json +42 -0
  204. data/doc/api/admin/categories/creating_a_category.json +46 -0
  205. data/doc/api/admin/categories/listing_categories.json +58 -0
  206. data/doc/api/admin/categories/removing_a_category.json +42 -0
  207. data/doc/api/admin/categories/showing_a_category.json +44 -0
  208. data/doc/api/admin/categories/updating_a_category.json +42 -0
  209. data/doc/api/admin/category_product_rules/creating_a_category_product_rule.json +46 -0
  210. data/doc/api/admin/category_product_rules/listing_category_product_rules.json +44 -0
  211. data/doc/api/admin/category_product_rules/removing_a_category_product_rule.json +42 -0
  212. data/doc/api/admin/category_product_rules/updating_a_category_product_rule.json +42 -0
  213. data/doc/api/admin/content/bulk_upserting_content.json +42 -0
  214. data/doc/api/admin/content/creating_content.json +46 -0
  215. data/doc/api/admin/content/listing_content.json +57 -0
  216. data/doc/api/admin/content/showing_content.json +44 -0
  217. data/doc/api/admin/content/updating_content.json +42 -0
  218. data/doc/api/admin/content_assets/bulk_upserting_content_assets.json +42 -0
  219. data/doc/api/admin/content_assets/creating_a_content_asset.json +46 -0
  220. data/doc/api/admin/content_assets/listing_content_assets.json +58 -0
  221. data/doc/api/admin/content_assets/removing_a_content_asset.json +42 -0
  222. data/doc/api/admin/content_assets/showing_a_content_asset.json +44 -0
  223. data/doc/api/admin/content_assets/updating_a_content_asset.json +42 -0
  224. data/doc/api/admin/discounts/creating_a_discount.json +46 -0
  225. data/doc/api/admin/discounts/listing_discounts.json +58 -0
  226. data/doc/api/admin/discounts/removing_a_discount.json +42 -0
  227. data/doc/api/admin/discounts/showing_a_discount.json +44 -0
  228. data/doc/api/admin/discounts/updating_discounts.json +42 -0
  229. data/doc/api/admin/email_signups/listing_email_signups.json +58 -0
  230. data/doc/api/admin/email_signups/showing_an_email_signup.json +44 -0
  231. data/doc/api/admin/fulfillment/listing_fulfillments.json +55 -0
  232. data/doc/api/admin/fulfillment/marking_items_as_canceled.json +46 -0
  233. data/doc/api/admin/fulfillment/marking_items_as_shipped.json +46 -0
  234. data/doc/api/admin/fulfillment/showing_fulfillment.json +44 -0
  235. data/doc/api/admin/index.json +1219 -0
  236. data/doc/api/admin/inventory_skus/bulk_upserting_inventory_skus.json +42 -0
  237. data/doc/api/admin/inventory_skus/creating_an_inventory_sku.json +46 -0
  238. data/doc/api/admin/inventory_skus/listing_inventory_skus.json +58 -0
  239. data/doc/api/admin/inventory_skus/removing_an_inventory_sku.json +42 -0
  240. data/doc/api/admin/inventory_skus/showing_an_inventory_sku.json +44 -0
  241. data/doc/api/admin/inventory_skus/updating_an_inventory_sku.json +42 -0
  242. data/doc/api/admin/navigation_menus/creating_a_menu.json +46 -0
  243. data/doc/api/admin/navigation_menus/listing_menus.json +58 -0
  244. data/doc/api/admin/navigation_menus/removing_a_navigation_menu.json +42 -0
  245. data/doc/api/admin/navigation_menus/showing_a_navigation_menu.json +44 -0
  246. data/doc/api/admin/navigation_menus/updating_a_navigation_menus.json +42 -0
  247. data/doc/api/admin/navigation_taxonomy/bulk_upserting_navigation_taxons.json +42 -0
  248. data/doc/api/admin/navigation_taxonomy/creating_a_taxon.json +46 -0
  249. data/doc/api/admin/navigation_taxonomy/listing_taxons.json +58 -0
  250. data/doc/api/admin/navigation_taxonomy/removing_a_navigation_taxon.json +42 -0
  251. data/doc/api/admin/navigation_taxonomy/showing_a_navigation_taxon.json +44 -0
  252. data/doc/api/admin/navigation_taxonomy/updating_a_navigation_taxons.json +42 -0
  253. data/doc/api/admin/orders/listing_orders.json +58 -0
  254. data/doc/api/admin/orders/showing_an_order.json +44 -0
  255. data/doc/api/admin/orders/viewing_orders_by_date_range.json +68 -0
  256. data/doc/api/admin/pages/bulk_upserting_pages.json +42 -0
  257. data/doc/api/admin/pages/creating_a_page.json +46 -0
  258. data/doc/api/admin/pages/listing_pages.json +58 -0
  259. data/doc/api/admin/pages/removing_a_page.json +42 -0
  260. data/doc/api/admin/pages/showing_a_page.json +44 -0
  261. data/doc/api/admin/pages/updating_a_page.json +42 -0
  262. data/doc/api/admin/payment_profiles/bulk_upserting_payment_profiles.json +42 -0
  263. data/doc/api/admin/payment_profiles/creating_a_payment_profile.json +46 -0
  264. data/doc/api/admin/payment_profiles/listing_payment_profiles.json +58 -0
  265. data/doc/api/admin/payment_profiles/removing_a_payment_profile.json +42 -0
  266. data/doc/api/admin/payment_profiles/showing_a_payment_profile.json +44 -0
  267. data/doc/api/admin/payment_profiles/updating_a_payment_profiles.json +42 -0
  268. data/doc/api/admin/payment_transactions/listing_payment_transactions.json +58 -0
  269. data/doc/api/admin/payment_transactions/showing_a_payment_transaction.json +44 -0
  270. data/doc/api/admin/payments/listing_payments.json +58 -0
  271. data/doc/api/admin/payments/showing_an_payment.json +44 -0
  272. data/doc/api/admin/prices/creating_a_pricing_sku_price.json +46 -0
  273. data/doc/api/admin/prices/listing_pricing_sku_prices.json +58 -0
  274. data/doc/api/admin/prices/removing_a_pricing_sku_price.json +42 -0
  275. data/doc/api/admin/prices/updating_a_pricing_sku_price.json +42 -0
  276. data/doc/api/admin/pricing_skus/bulk_upserting_pricing_skus.json +42 -0
  277. data/doc/api/admin/pricing_skus/creating_an_pricing_sku.json +46 -0
  278. data/doc/api/admin/pricing_skus/listing_pricing_skus.json +58 -0
  279. data/doc/api/admin/pricing_skus/removing_an_pricing_sku.json +42 -0
  280. data/doc/api/admin/pricing_skus/showing_an_pricing_sku.json +44 -0
  281. data/doc/api/admin/pricing_skus/updating_an_pricing_sku.json +42 -0
  282. data/doc/api/admin/product_images/creating_a_product_image_from_base64.json +46 -0
  283. data/doc/api/admin/product_images/creating_a_product_image_from_url.json +46 -0
  284. data/doc/api/admin/product_images/listing_product_images.json +44 -0
  285. data/doc/api/admin/product_images/removing_a_product_image.json +42 -0
  286. data/doc/api/admin/product_images/updating_a_product_image.json +42 -0
  287. data/doc/api/admin/products/bulk_upserting_products.json +42 -0
  288. data/doc/api/admin/products/creating_a_product.json +46 -0
  289. data/doc/api/admin/products/listing_products.json +58 -0
  290. data/doc/api/admin/products/removing_a_product.json +42 -0
  291. data/doc/api/admin/products/showing_a_product.json +44 -0
  292. data/doc/api/admin/products/updating_a_product.json +42 -0
  293. data/doc/api/admin/promo_code_lists/bulk_upserting_promo_code_lists.json +42 -0
  294. data/doc/api/admin/promo_code_lists/creating_a_promo_code_list.json +46 -0
  295. data/doc/api/admin/promo_code_lists/listing_promo_code_lists.json +58 -0
  296. data/doc/api/admin/promo_code_lists/removing_a_promo_code_list.json +42 -0
  297. data/doc/api/admin/promo_code_lists/showing_a_promo_code_list.json +44 -0
  298. data/doc/api/admin/promo_code_lists/updating_a_promo_code_list.json +42 -0
  299. data/doc/api/admin/recommendation_settings/showing_recommendation_settings.json +44 -0
  300. data/doc/api/admin/recommendation_settings/updating_recommendation_settings.json +42 -0
  301. data/doc/api/admin/redirects/bulk_upserting_redirects.json +42 -0
  302. data/doc/api/admin/redirects/creating_a_redirect.json +46 -0
  303. data/doc/api/admin/redirects/listing_redirects.json +58 -0
  304. data/doc/api/admin/redirects/removing_a_redirect.json +42 -0
  305. data/doc/api/admin/redirects/showing_a_redirect.json +44 -0
  306. data/doc/api/admin/redirects/updating_a_redirects.json +42 -0
  307. data/doc/api/admin/release_changes/adding_changes_to_a_release.json +43 -0
  308. data/doc/api/admin/releases/bulk_upserting_releases.json +42 -0
  309. data/doc/api/admin/releases/creating_a_release.json +46 -0
  310. data/doc/api/admin/releases/listing_releases.json +58 -0
  311. data/doc/api/admin/releases/removing_a_release.json +42 -0
  312. data/doc/api/admin/releases/showing_a_release.json +44 -0
  313. data/doc/api/admin/releases/updating_a_release.json +42 -0
  314. data/doc/api/admin/saved_addresses/creating_a_saved_address.json +46 -0
  315. data/doc/api/admin/saved_addresses/listing_saved_address.json +44 -0
  316. data/doc/api/admin/saved_addresses/removing_a_saved_address.json +42 -0
  317. data/doc/api/admin/saved_addresses/updating_a_saved_address.json +42 -0
  318. data/doc/api/admin/saved_credit_cards/creating_a_saved_credit_card.json +46 -0
  319. data/doc/api/admin/saved_credit_cards/listing_saved_credit_cards.json +55 -0
  320. data/doc/api/admin/saved_credit_cards/removing_a_saved_credit_card.json +42 -0
  321. data/doc/api/admin/saved_credit_cards/updating_a_saved_credit_card.json +42 -0
  322. data/doc/api/admin/shipping/listing_shipments.json +58 -0
  323. data/doc/api/admin/shipping/showing_a_shipment.json +44 -0
  324. data/doc/api/admin/shipping_rates/creating_a_shipping_rate.json +46 -0
  325. data/doc/api/admin/shipping_rates/listing_shipping_rates.json +44 -0
  326. data/doc/api/admin/shipping_rates/removing_a_shipping_rate.json +42 -0
  327. data/doc/api/admin/shipping_rates/updating_a_shipping_rate.json +42 -0
  328. data/doc/api/admin/shipping_services/bulk_upserting_shipping_services.json +42 -0
  329. data/doc/api/admin/shipping_services/creating_a_shipping_service.json +46 -0
  330. data/doc/api/admin/shipping_services/listing_shipping_services.json +58 -0
  331. data/doc/api/admin/shipping_services/removing_a_shipping_service.json +42 -0
  332. data/doc/api/admin/shipping_services/showing_a_shipping_service.json +44 -0
  333. data/doc/api/admin/shipping_services/updating_a_shipping_service.json +42 -0
  334. data/doc/api/admin/tax_categories/bulk_upserting_tax_categories.json +42 -0
  335. data/doc/api/admin/tax_categories/creating_a_tax_category.json +46 -0
  336. data/doc/api/admin/tax_categories/listing_tax_categories.json +55 -0
  337. data/doc/api/admin/tax_categories/removing_a_tax_category.json +42 -0
  338. data/doc/api/admin/tax_categories/showing_a_tax_category.json +44 -0
  339. data/doc/api/admin/tax_categories/updating_a_tax_categories.json +42 -0
  340. data/doc/api/admin/tax_rates/creating_a_tax_rate.json +46 -0
  341. data/doc/api/admin/tax_rates/listing_tax_rates.json +44 -0
  342. data/doc/api/admin/tax_rates/removing_a_tax_rate.json +42 -0
  343. data/doc/api/admin/tax_rates/updating_a_tax_rate.json +42 -0
  344. data/doc/api/admin/users/bulk_upserting_users.json +42 -0
  345. data/doc/api/admin/users/creating_a_user.json +46 -0
  346. data/doc/api/admin/users/listing_users.json +58 -0
  347. data/doc/api/admin/users/removing_a_user.json +42 -0
  348. data/doc/api/admin/users/showing_a_user.json +44 -0
  349. data/doc/api/admin/users/updating_a_user.json +42 -0
  350. data/doc/api/admin/variants/creating_a_product_variant.json +46 -0
  351. data/doc/api/admin/variants/listing_product_variants.json +44 -0
  352. data/doc/api/admin/variants/removing_a_product_variant.json +42 -0
  353. data/doc/api/admin/variants/updating_a_product_variant.json +42 -0
  354. data/doc/api/storefront/accounts/creating_an_account.json +51 -0
  355. data/doc/api/storefront/accounts/getting_account_details.json +50 -0
  356. data/doc/api/storefront/accounts/updating_an_account.json +52 -0
  357. data/doc/api/storefront/analytics/saving_a_category_view.json +39 -0
  358. data/doc/api/storefront/analytics/saving_a_product_view.json +39 -0
  359. data/doc/api/storefront/analytics/saving_a_search.json +39 -0
  360. data/doc/api/storefront/analytics/saving_a_search_abandonment.json +38 -0
  361. data/doc/api/storefront/analytics/saving_filters.json +38 -0
  362. data/doc/api/storefront/assets/showing_an_asset.json +50 -0
  363. data/doc/api/storefront/authentication/creating_an_authentication_token.json +51 -0
  364. data/doc/api/storefront/authentication/refreshing_an_authentication_token.json +52 -0
  365. data/doc/api/storefront/authentication/using_an_authentication_token.json +51 -0
  366. data/doc/api/storefront/cart/adding_a_promo_code.json +52 -0
  367. data/doc/api/storefront/cart/adding_an_item.json +52 -0
  368. data/doc/api/storefront/cart/creating_a_new_cart_for_a_user.json +52 -0
  369. data/doc/api/storefront/cart/creating_a_new_guest_cart.json +51 -0
  370. data/doc/api/storefront/cart/delete_an_item.json +52 -0
  371. data/doc/api/storefront/cart/listing_user_s_carts.json +51 -0
  372. data/doc/api/storefront/cart/showing_cart.json +51 -0
  373. data/doc/api/storefront/cart/updating_an_item.json +52 -0
  374. data/doc/api/storefront/categories/showing_a_category.json +64 -0
  375. data/doc/api/storefront/categories/showing_a_listing_of_categories.json +55 -0
  376. data/doc/api/storefront/checkout/completing_a_checkout.json +51 -0
  377. data/doc/api/storefront/checkout/showing_a_checkout.json +50 -0
  378. data/doc/api/storefront/checkout/updating_a_checkout.json +51 -0
  379. data/doc/api/storefront/contacts/creating_a_contact.json +51 -0
  380. data/doc/api/storefront/email_signups/creating_an_email_signup.json +51 -0
  381. data/doc/api/storefront/email_signups/showing_an_email_signup_content.json +50 -0
  382. data/doc/api/storefront/index.json +527 -0
  383. data/doc/api/storefront/menus/listing_menus.json +51 -0
  384. data/doc/api/storefront/menus/showing_a_menu.json +51 -0
  385. data/doc/api/storefront/orders/listing_the_user_s_orders.json +51 -0
  386. data/doc/api/storefront/orders/showing_an_order.json +51 -0
  387. data/doc/api/storefront/pages/showing_a_page.json +51 -0
  388. data/doc/api/storefront/password_resets/sending_a_forgot_password_email.json +50 -0
  389. data/doc/api/storefront/personalized_recommendations/showing_recommendations_with_a_session_id.json +55 -0
  390. data/doc/api/storefront/personalized_recommendations/showing_recommendations_with_authentication.json +51 -0
  391. data/doc/api/storefront/products/showing_a_product.json +51 -0
  392. data/doc/api/storefront/products/showing_a_product_with_a_specific_sku_selected.json +55 -0
  393. data/doc/api/storefront/recent_views/showing_recent_views_from_authentication.json +51 -0
  394. data/doc/api/storefront/recent_views/showing_recent_views_with_a_session_id.json +55 -0
  395. data/doc/api/storefront/recent_views/updating_recent_views_with_a_session_id.json +53 -0
  396. data/doc/api/storefront/recent_views/updating_recent_views_with_authentication.json +51 -0
  397. data/doc/api/storefront/saved_addresses/creating_a_saved_address.json +51 -0
  398. data/doc/api/storefront/saved_addresses/deleting_a_saved_address.json +48 -0
  399. data/doc/api/storefront/saved_addresses/listing_the_user_s_saved_addresses.json +51 -0
  400. data/doc/api/storefront/saved_addresses/showing_a_saved_address.json +50 -0
  401. data/doc/api/storefront/saved_addresses/updating_a_saved_address.json +51 -0
  402. data/doc/api/storefront/saved_credit_cards/creating_a_saved_credit_card.json +51 -0
  403. data/doc/api/storefront/saved_credit_cards/deleting_a_saved_credit_card.json +48 -0
  404. data/doc/api/storefront/saved_credit_cards/listing_the_user_s_saved_credit_cards.json +51 -0
  405. data/doc/api/storefront/saved_credit_cards/showing_a_saved_credit_card.json +50 -0
  406. data/doc/api/storefront/saved_credit_cards/updating_a_saved_credit_card.json +51 -0
  407. data/doc/api/storefront/searches/showing_search_autocomplete_suggestions.json +52 -0
  408. data/doc/api/storefront/searches/showing_search_results.json +69 -0
  409. data/doc/api/storefront/system_content/showing_system_content.json +51 -0
  410. data/doc/api/storefront/system_content/showing_the_home_page.json +51 -0
  411. data/doc/api/storefront/taxons/showing_a_taxon.json +51 -0
  412. data/doc/api/storefront/validation_errors/checkout_validation_errors.json +51 -0
  413. data/doc/api/storefront/validation_errors/general_validation_errors.json +45 -0
  414. data/lib/workarea/api/curl.rb +86 -0
  415. data/lib/workarea/api/documentation.rb +61 -0
  416. data/lib/workarea/api/documentation_test.rb +210 -0
  417. data/lib/workarea/api/engine.rb +8 -0
  418. data/lib/workarea/api/version.rb +5 -0
  419. data/lib/workarea/api.rb +18 -0
  420. data/storefront/.gitignore +12 -0
  421. data/storefront/README.md +58 -0
  422. data/storefront/Rakefile +10 -0
  423. data/storefront/app/controllers/workarea/api/storefront/accounts_controller.rb +31 -0
  424. data/storefront/app/controllers/workarea/api/storefront/analytics_controller.rb +41 -0
  425. data/storefront/app/controllers/workarea/api/storefront/application_controller.rb +65 -0
  426. data/storefront/app/controllers/workarea/api/storefront/assets_controller.rb +11 -0
  427. data/storefront/app/controllers/workarea/api/storefront/authentication.rb +30 -0
  428. data/storefront/app/controllers/workarea/api/storefront/authentication_tokens_controller.rb +50 -0
  429. data/storefront/app/controllers/workarea/api/storefront/cart_items_controller.rb +100 -0
  430. data/storefront/app/controllers/workarea/api/storefront/carts_controller.rb +47 -0
  431. data/storefront/app/controllers/workarea/api/storefront/categories_controller.rb +25 -0
  432. data/storefront/app/controllers/workarea/api/storefront/checkouts_controller.rb +117 -0
  433. data/storefront/app/controllers/workarea/api/storefront/contacts_controller.rb +20 -0
  434. data/storefront/app/controllers/workarea/api/storefront/current_checkout.rb +60 -0
  435. data/storefront/app/controllers/workarea/api/storefront/email_signups_controller.rb +15 -0
  436. data/storefront/app/controllers/workarea/api/storefront/menus_controller.rb +19 -0
  437. data/storefront/app/controllers/workarea/api/storefront/orders_controller.rb +32 -0
  438. data/storefront/app/controllers/workarea/api/storefront/pages_controller.rb +14 -0
  439. data/storefront/app/controllers/workarea/api/storefront/password_resets_controller.rb +17 -0
  440. data/storefront/app/controllers/workarea/api/storefront/products_controller.rb +17 -0
  441. data/storefront/app/controllers/workarea/api/storefront/recent_views_controller.rb +46 -0
  442. data/storefront/app/controllers/workarea/api/storefront/recommendations_controller.rb +22 -0
  443. data/storefront/app/controllers/workarea/api/storefront/saved_addresses_controller.rb +38 -0
  444. data/storefront/app/controllers/workarea/api/storefront/saved_credit_cards_controller.rb +54 -0
  445. data/storefront/app/controllers/workarea/api/storefront/searches_controller.rb +29 -0
  446. data/storefront/app/controllers/workarea/api/storefront/system_content_controller.rb +16 -0
  447. data/storefront/app/controllers/workarea/api/storefront/taxons_controller.rb +20 -0
  448. data/storefront/app/controllers/workarea/api/storefront/user_activity.rb +36 -0
  449. data/storefront/app/controllers/workarea/storefront/application_controller.decorator +12 -0
  450. data/storefront/app/helpers/workarea/api/storefront/application_helper.rb +15 -0
  451. data/storefront/app/helpers/workarea/api/storefront/checkouts_helper.rb +11 -0
  452. data/storefront/app/helpers/workarea/api/storefront/content_blocks_helper.rb +38 -0
  453. data/storefront/app/models/workarea/catalog/category.decorator +7 -0
  454. data/storefront/app/models/workarea/user/authentication_token.rb +33 -0
  455. data/storefront/app/models/workarea/user.decorator +8 -0
  456. data/storefront/app/view_models/workarea/api/storefront/search_suggestion_view_model.rb +21 -0
  457. data/storefront/app/views/workarea/api/storefront/accounts/_account.json.jbuilder +7 -0
  458. data/storefront/app/views/workarea/api/storefront/accounts/create.json.jbuilder +7 -0
  459. data/storefront/app/views/workarea/api/storefront/accounts/show.json.jbuilder +1 -0
  460. data/storefront/app/views/workarea/api/storefront/assets/show.json.jbuilder +4 -0
  461. data/storefront/app/views/workarea/api/storefront/authentication_tokens/_authentication_token.json.jbuilder +2 -0
  462. data/storefront/app/views/workarea/api/storefront/authentication_tokens/create.json.jbuilder +1 -0
  463. data/storefront/app/views/workarea/api/storefront/authentication_tokens/update.json.jbuilder +1 -0
  464. data/storefront/app/views/workarea/api/storefront/cart_items/item.json.jbuilder +9 -0
  465. data/storefront/app/views/workarea/api/storefront/carts/index.json.jbuilder +4 -0
  466. data/storefront/app/views/workarea/api/storefront/carts/show.json.jbuilder +1 -0
  467. data/storefront/app/views/workarea/api/storefront/categories/_category.json.jbuilder +4 -0
  468. data/storefront/app/views/workarea/api/storefront/categories/index.json.jbuilder +3 -0
  469. data/storefront/app/views/workarea/api/storefront/categories/show.json.jbuilder +30 -0
  470. data/storefront/app/views/workarea/api/storefront/checkouts/_shipping_options.json.jbuilder +4 -0
  471. data/storefront/app/views/workarea/api/storefront/checkouts/show.json.jbuilder +17 -0
  472. data/storefront/app/views/workarea/api/storefront/checkouts/steps/_addresses.json.jbuilder +19 -0
  473. data/storefront/app/views/workarea/api/storefront/checkouts/steps/_payment.json.jbuilder +9 -0
  474. data/storefront/app/views/workarea/api/storefront/checkouts/steps/_shipping.json.jbuilder +9 -0
  475. data/storefront/app/views/workarea/api/storefront/content_blocks/_block.json.jbuilder +7 -0
  476. data/storefront/app/views/workarea/api/storefront/email_signups/create.json.jbuilder +2 -0
  477. data/storefront/app/views/workarea/api/storefront/email_signups/show.json.jbuilder +4 -0
  478. data/storefront/app/views/workarea/api/storefront/facets/_range.json.jbuilder +8 -0
  479. data/storefront/app/views/workarea/api/storefront/facets/_terms.json.jbuilder +8 -0
  480. data/storefront/app/views/workarea/api/storefront/fulfillments/_fulfillment.json.jbuilder +18 -0
  481. data/storefront/app/views/workarea/api/storefront/menus/_menu.json.jbuilder +11 -0
  482. data/storefront/app/views/workarea/api/storefront/menus/index.json.jbuilder +3 -0
  483. data/storefront/app/views/workarea/api/storefront/menus/show.json.jbuilder +1 -0
  484. data/storefront/app/views/workarea/api/storefront/orders/_item.json.jbuilder +26 -0
  485. data/storefront/app/views/workarea/api/storefront/orders/_order.json.jbuilder +42 -0
  486. data/storefront/app/views/workarea/api/storefront/orders/index.json.jbuilder +4 -0
  487. data/storefront/app/views/workarea/api/storefront/orders/show.json.jbuilder +7 -0
  488. data/storefront/app/views/workarea/api/storefront/orders/tenders/_credit_card.json.jbuilder +6 -0
  489. data/storefront/app/views/workarea/api/storefront/orders/tenders/_store_credit.json.jbuilder +2 -0
  490. data/storefront/app/views/workarea/api/storefront/pages/show.json.jbuilder +16 -0
  491. data/storefront/app/views/workarea/api/storefront/products/_image_urls.json.jbuilder +5 -0
  492. data/storefront/app/views/workarea/api/storefront/products/_product.json.jbuilder +41 -0
  493. data/storefront/app/views/workarea/api/storefront/products/show.json.jbuilder +9 -0
  494. data/storefront/app/views/workarea/api/storefront/recent_views/show.json.jbuilder +8 -0
  495. data/storefront/app/views/workarea/api/storefront/recommendations/show.json.jbuilder +3 -0
  496. data/storefront/app/views/workarea/api/storefront/saved_addresses/_saved_address.json.jbuilder +2 -0
  497. data/storefront/app/views/workarea/api/storefront/saved_addresses/index.json.jbuilder +4 -0
  498. data/storefront/app/views/workarea/api/storefront/saved_addresses/show.json.jbuilder +2 -0
  499. data/storefront/app/views/workarea/api/storefront/saved_credit_cards/_card.json.jbuilder +9 -0
  500. data/storefront/app/views/workarea/api/storefront/saved_credit_cards/index.json.jbuilder +4 -0
  501. data/storefront/app/views/workarea/api/storefront/saved_credit_cards/show.json.jbuilder +2 -0
  502. data/storefront/app/views/workarea/api/storefront/searches/index.json.jbuilder +1 -0
  503. data/storefront/app/views/workarea/api/storefront/searches/show.json.jbuilder +19 -0
  504. data/storefront/app/views/workarea/api/storefront/shared/_address.json.jbuilder +12 -0
  505. data/storefront/app/views/workarea/api/storefront/shared/_pagination.json.jbuilder +11 -0
  506. data/storefront/app/views/workarea/api/storefront/system_content/show.json.jbuilder +12 -0
  507. data/storefront/app/views/workarea/api/storefront/taxons/_taxon.json.jbuilder +10 -0
  508. data/storefront/app/views/workarea/api/storefront/taxons/show.json.jbuilder +7 -0
  509. data/storefront/app/workers/workarea/remove_authentication_tokens_on_password_changes.rb +19 -0
  510. data/storefront/bin/rails +18 -0
  511. data/storefront/config/initializers/config.rb +2 -0
  512. data/storefront/config/locales/en.yml +13 -0
  513. data/storefront/config/routes.rb +41 -0
  514. data/storefront/lib/workarea/api/storefront/engine.rb +10 -0
  515. data/storefront/lib/workarea/api/storefront.rb +15 -0
  516. data/storefront/test/documentation/workarea/api/storefront/accounts_documentation_test.rb +70 -0
  517. data/storefront/test/documentation/workarea/api/storefront/analytics_documentation_test.rb +51 -0
  518. data/storefront/test/documentation/workarea/api/storefront/assets_documentation_test.rb +32 -0
  519. data/storefront/test/documentation/workarea/api/storefront/authentication_documentation_test.rb +84 -0
  520. data/storefront/test/documentation/workarea/api/storefront/cart_items_documentation_test.rb +104 -0
  521. data/storefront/test/documentation/workarea/api/storefront/carts_documentation_test.rb +121 -0
  522. data/storefront/test/documentation/workarea/api/storefront/categories_documentation_test.rb +90 -0
  523. data/storefront/test/documentation/workarea/api/storefront/checkouts_documentation_test.rb +142 -0
  524. data/storefront/test/documentation/workarea/api/storefront/contacts_documentation_test.rb +39 -0
  525. data/storefront/test/documentation/workarea/api/storefront/email_signups_documentation_test.rb +53 -0
  526. data/storefront/test/documentation/workarea/api/storefront/menus_documentation_test.rb +67 -0
  527. data/storefront/test/documentation/workarea/api/storefront/orders_documentation_test.rb +127 -0
  528. data/storefront/test/documentation/workarea/api/storefront/pages_documentation_test.rb +66 -0
  529. data/storefront/test/documentation/workarea/api/storefront/password_resets_documentation_test.rb +30 -0
  530. data/storefront/test/documentation/workarea/api/storefront/products_documentation_test.rb +64 -0
  531. data/storefront/test/documentation/workarea/api/storefront/recent_views_documentation_test.rb +116 -0
  532. data/storefront/test/documentation/workarea/api/storefront/recommendations_documentation_test.rb +68 -0
  533. data/storefront/test/documentation/workarea/api/storefront/saved_addresses_documentation_test.rb +129 -0
  534. data/storefront/test/documentation/workarea/api/storefront/saved_credit_cards_documentation_test.rb +129 -0
  535. data/storefront/test/documentation/workarea/api/storefront/searches_documentation_test.rb +88 -0
  536. data/storefront/test/documentation/workarea/api/storefront/system_content_documentation_test.rb +66 -0
  537. data/storefront/test/documentation/workarea/api/storefront/taxons_documentation_test.rb +37 -0
  538. data/storefront/test/documentation/workarea/api/storefront/validation_documentation_test.rb +81 -0
  539. data/storefront/test/dummy/Rakefile +7 -0
  540. data/storefront/test/dummy/app/assets/config/manifest.js +4 -0
  541. data/storefront/test/dummy/app/assets/images/.keep +0 -0
  542. data/storefront/test/dummy/app/assets/javascripts/application.js +13 -0
  543. data/storefront/test/dummy/app/assets/stylesheets/application.css +15 -0
  544. data/storefront/test/dummy/app/controllers/application_controller.rb +3 -0
  545. data/storefront/test/dummy/app/controllers/concerns/.keep +0 -0
  546. data/storefront/test/dummy/app/helpers/application_helper.rb +2 -0
  547. data/storefront/test/dummy/app/jobs/application_job.rb +2 -0
  548. data/storefront/test/dummy/app/mailers/.keep +0 -0
  549. data/storefront/test/dummy/app/mailers/application_mailer.rb +4 -0
  550. data/storefront/test/dummy/app/models/.keep +0 -0
  551. data/storefront/test/dummy/app/models/concerns/.keep +0 -0
  552. data/storefront/test/dummy/app/views/layouts/application.html.erb +14 -0
  553. data/storefront/test/dummy/app/views/layouts/mailer.html.erb +13 -0
  554. data/storefront/test/dummy/app/views/layouts/mailer.text.erb +1 -0
  555. data/storefront/test/dummy/bin/bundle +3 -0
  556. data/storefront/test/dummy/bin/rails +4 -0
  557. data/storefront/test/dummy/bin/rake +4 -0
  558. data/storefront/test/dummy/bin/setup +34 -0
  559. data/storefront/test/dummy/bin/update +29 -0
  560. data/storefront/test/dummy/config/application.rb +25 -0
  561. data/storefront/test/dummy/config/boot.rb +5 -0
  562. data/storefront/test/dummy/config/cable.yml +9 -0
  563. data/storefront/test/dummy/config/environment.rb +5 -0
  564. data/storefront/test/dummy/config/environments/development.rb +55 -0
  565. data/storefront/test/dummy/config/environments/production.rb +86 -0
  566. data/storefront/test/dummy/config/environments/test.rb +43 -0
  567. data/storefront/test/dummy/config/initializers/application_controller_renderer.rb +6 -0
  568. data/storefront/test/dummy/config/initializers/assets.rb +11 -0
  569. data/storefront/test/dummy/config/initializers/backtrace_silencers.rb +7 -0
  570. data/storefront/test/dummy/config/initializers/cookies_serializer.rb +5 -0
  571. data/storefront/test/dummy/config/initializers/filter_parameter_logging.rb +4 -0
  572. data/storefront/test/dummy/config/initializers/inflections.rb +16 -0
  573. data/storefront/test/dummy/config/initializers/mime_types.rb +4 -0
  574. data/storefront/test/dummy/config/initializers/new_framework_defaults.rb +21 -0
  575. data/storefront/test/dummy/config/initializers/session_store.rb +3 -0
  576. data/storefront/test/dummy/config/initializers/workarea.rb +8 -0
  577. data/storefront/test/dummy/config/initializers/wrap_parameters.rb +14 -0
  578. data/storefront/test/dummy/config/locales/en.yml +23 -0
  579. data/storefront/test/dummy/config/puma.rb +47 -0
  580. data/storefront/test/dummy/config/routes.rb +6 -0
  581. data/storefront/test/dummy/config/secrets.yml +22 -0
  582. data/storefront/test/dummy/config/spring.rb +6 -0
  583. data/storefront/test/dummy/config.ru +4 -0
  584. data/storefront/test/dummy/db/seeds.rb +2 -0
  585. data/storefront/test/dummy/log/.keep +0 -0
  586. data/storefront/test/dummy/public/404.html +67 -0
  587. data/storefront/test/dummy/public/422.html +67 -0
  588. data/storefront/test/dummy/public/500.html +66 -0
  589. data/storefront/test/dummy/public/apple-touch-icon-precomposed.png +0 -0
  590. data/storefront/test/dummy/public/apple-touch-icon.png +0 -0
  591. data/storefront/test/dummy/public/favicon.ico +1 -0
  592. data/storefront/test/integration/workarea/api/storefront/accounts_integration_test.rb +49 -0
  593. data/storefront/test/integration/workarea/api/storefront/analytics_integration_test.rb +36 -0
  594. data/storefront/test/integration/workarea/api/storefront/assets_integration_test.rb +24 -0
  595. data/storefront/test/integration/workarea/api/storefront/authentication_integration_test.rb +50 -0
  596. data/storefront/test/integration/workarea/api/storefront/authentication_tokens_integration_test.rb +87 -0
  597. data/storefront/test/integration/workarea/api/storefront/cart_items_integration_test.rb +149 -0
  598. data/storefront/test/integration/workarea/api/storefront/carts_integration_test.rb +114 -0
  599. data/storefront/test/integration/workarea/api/storefront/categories_integration_test.rb +84 -0
  600. data/storefront/test/integration/workarea/api/storefront/checkouts_integration_test.rb +203 -0
  601. data/storefront/test/integration/workarea/api/storefront/contacts_integration_test.rb +28 -0
  602. data/storefront/test/integration/workarea/api/storefront/email_signups_integration_test.rb +35 -0
  603. data/storefront/test/integration/workarea/api/storefront/menus_integration_test.rb +53 -0
  604. data/storefront/test/integration/workarea/api/storefront/orders_integration_test.rb +115 -0
  605. data/storefront/test/integration/workarea/api/storefront/pages_integration_test.rb +57 -0
  606. data/storefront/test/integration/workarea/api/storefront/password_resets_integration_test.rb +20 -0
  607. data/storefront/test/integration/workarea/api/storefront/products_integration_test.rb +50 -0
  608. data/storefront/test/integration/workarea/api/storefront/recent_views_integration_test.rb +118 -0
  609. data/storefront/test/integration/workarea/api/storefront/recommendations_integration_test.rb +51 -0
  610. data/storefront/test/integration/workarea/api/storefront/saved_addresses_integration_test.rb +100 -0
  611. data/storefront/test/integration/workarea/api/storefront/saved_credit_cards_integration_test.rb +107 -0
  612. data/storefront/test/integration/workarea/api/storefront/searches_integration_test.rb +128 -0
  613. data/storefront/test/integration/workarea/api/storefront/system_content_integration_test.rb +35 -0
  614. data/storefront/test/integration/workarea/api/storefront/taxons_integration_test.rb +44 -0
  615. data/storefront/test/integration/workarea/api/storefront/user_carts_integration_test.rb +55 -0
  616. data/storefront/test/models/workarea/user/authentication_token_test.rb +30 -0
  617. data/storefront/test/support/authentication_test.rb +25 -0
  618. data/storefront/test/support/orders_test.rb +18 -0
  619. data/storefront/test/test_helper.rb +10 -0
  620. data/storefront/workarea-api-storefront.gemspec +18 -0
  621. data/workarea-api.gemspec +25 -0
  622. metadata +741 -0
@@ -0,0 +1,527 @@
1
+ {
2
+ "resources": [
3
+ {
4
+ "name": "Categories",
5
+ "examples": [
6
+ {
7
+ "description": "Showing a listing of categories",
8
+ "link": "storefront/categories/showing_a_listing_of_categories.json",
9
+ "groups": "all",
10
+ "route": "/api/storefront/categories",
11
+ "method": "GET"
12
+ },
13
+ {
14
+ "description": "Showing a category",
15
+ "link": "storefront/categories/showing_a_category.json",
16
+ "groups": "all",
17
+ "route": "/api/storefront/categories/:slug",
18
+ "method": "GET"
19
+ }
20
+ ]
21
+ },
22
+ {
23
+ "name": "Recent views",
24
+ "examples": [
25
+ {
26
+ "description": "Updating recent views with authentication",
27
+ "link": "storefront/recent_views/updating_recent_views_with_authentication.json",
28
+ "groups": "all",
29
+ "route": "/api/storefront/recent_views",
30
+ "method": "PATCH"
31
+ },
32
+ {
33
+ "description": "Showing recent views from authentication",
34
+ "link": "storefront/recent_views/showing_recent_views_from_authentication.json",
35
+ "groups": "all",
36
+ "route": "/api/storefront/recent_views",
37
+ "method": "GET"
38
+ },
39
+ {
40
+ "description": "Showing recent views with a session_id",
41
+ "link": "storefront/recent_views/showing_recent_views_with_a_session_id.json",
42
+ "groups": "all",
43
+ "route": "/api/storefront/recent_views",
44
+ "method": "GET"
45
+ },
46
+ {
47
+ "description": "Updating recent views with a session_id",
48
+ "link": "storefront/recent_views/updating_recent_views_with_a_session_id.json",
49
+ "groups": "all",
50
+ "route": "/api/storefront/recent_views",
51
+ "method": "PATCH"
52
+ }
53
+ ]
54
+ },
55
+ {
56
+ "name": "Checkout",
57
+ "examples": [
58
+ {
59
+ "description": "Updating a checkout",
60
+ "link": "storefront/checkout/updating_a_checkout.json",
61
+ "groups": "all",
62
+ "route": "/api/storefront/checkouts/:id",
63
+ "method": "PATCH"
64
+ },
65
+ {
66
+ "description": "Completing a checkout",
67
+ "link": "storefront/checkout/completing_a_checkout.json",
68
+ "groups": "all",
69
+ "route": "/api/storefront/checkouts/:id/complete",
70
+ "method": "POST"
71
+ },
72
+ {
73
+ "description": "Showing a checkout",
74
+ "link": "storefront/checkout/showing_a_checkout.json",
75
+ "groups": "all",
76
+ "route": "/api/storefront/checkouts/:id/reset",
77
+ "method": "GET"
78
+ }
79
+ ]
80
+ },
81
+ {
82
+ "name": "System Content",
83
+ "examples": [
84
+ {
85
+ "description": "Showing system content",
86
+ "link": "storefront/system_content/showing_system_content.json",
87
+ "groups": "all",
88
+ "route": "/api/storefront/system_content/:name",
89
+ "method": "GET"
90
+ },
91
+ {
92
+ "description": "Showing the home page",
93
+ "link": "storefront/system_content/showing_the_home_page.json",
94
+ "groups": "all",
95
+ "route": "/api/storefront/system_content/home_page",
96
+ "method": "GET"
97
+ }
98
+ ]
99
+ },
100
+ {
101
+ "name": "Email Signups",
102
+ "examples": [
103
+ {
104
+ "description": "Creating an email signup",
105
+ "link": "storefront/email_signups/creating_an_email_signup.json",
106
+ "groups": "all",
107
+ "route": "/api/storefront/email_signups",
108
+ "method": "POST"
109
+ },
110
+ {
111
+ "description": "Showing an email signup content",
112
+ "link": "storefront/email_signups/showing_an_email_signup_content.json",
113
+ "groups": "all",
114
+ "route": "/api/storefront/email_signups",
115
+ "method": "GET"
116
+ }
117
+ ]
118
+ },
119
+ {
120
+ "name": "Searches",
121
+ "examples": [
122
+ {
123
+ "description": "Showing search autocomplete suggestions",
124
+ "link": "storefront/searches/showing_search_autocomplete_suggestions.json",
125
+ "groups": "all",
126
+ "route": "/api/storefront/searches",
127
+ "method": "GET"
128
+ },
129
+ {
130
+ "description": "Showing search results",
131
+ "link": "storefront/searches/showing_search_results.json",
132
+ "groups": "all",
133
+ "route": "/api/storefront/search",
134
+ "method": "GET"
135
+ }
136
+ ]
137
+ },
138
+ {
139
+ "name": "Accounts",
140
+ "examples": [
141
+ {
142
+ "description": "Getting account details",
143
+ "link": "storefront/accounts/getting_account_details.json",
144
+ "groups": "all",
145
+ "route": "/api/storefront/account",
146
+ "method": "GET"
147
+ },
148
+ {
149
+ "description": "Creating an account",
150
+ "link": "storefront/accounts/creating_an_account.json",
151
+ "groups": "all",
152
+ "route": "/api/storefront/account",
153
+ "method": "POST"
154
+ },
155
+ {
156
+ "description": "Updating an account",
157
+ "link": "storefront/accounts/updating_an_account.json",
158
+ "groups": "all",
159
+ "route": "/api/storefront/account",
160
+ "method": "POST"
161
+ }
162
+ ]
163
+ },
164
+ {
165
+ "name": "Menus",
166
+ "examples": [
167
+ {
168
+ "description": "Showing a menu",
169
+ "link": "storefront/menus/showing_a_menu.json",
170
+ "groups": "all",
171
+ "route": "/api/storefront/menus/:id",
172
+ "method": "GET"
173
+ },
174
+ {
175
+ "description": "Listing menus",
176
+ "link": "storefront/menus/listing_menus.json",
177
+ "groups": "all",
178
+ "route": "/api/storefront/menus",
179
+ "method": "GET"
180
+ }
181
+ ]
182
+ },
183
+ {
184
+ "name": "Password Resets",
185
+ "examples": [
186
+ {
187
+ "description": "Sending a forgot password email",
188
+ "link": "storefront/password_resets/sending_a_forgot_password_email.json",
189
+ "groups": "all",
190
+ "route": "/api/storefront/password_resets",
191
+ "method": "POST"
192
+ }
193
+ ]
194
+ },
195
+ {
196
+ "name": "Authentication",
197
+ "examples": [
198
+ {
199
+ "description": "Creating an authentication token",
200
+ "link": "storefront/authentication/creating_an_authentication_token.json",
201
+ "groups": "all",
202
+ "route": "/api/storefront/authentication_tokens",
203
+ "method": "POST"
204
+ },
205
+ {
206
+ "description": "Refreshing an authentication token",
207
+ "link": "storefront/authentication/refreshing_an_authentication_token.json",
208
+ "groups": "all",
209
+ "route": "/api/storefront/authentication_tokens",
210
+ "method": "PATCH"
211
+ },
212
+ {
213
+ "description": "Using an authentication token",
214
+ "link": "storefront/authentication/using_an_authentication_token.json",
215
+ "groups": "all",
216
+ "route": "/api/storefront/account",
217
+ "method": "GET"
218
+ }
219
+ ]
220
+ },
221
+ {
222
+ "name": "Contacts",
223
+ "examples": [
224
+ {
225
+ "description": "Creating a contact",
226
+ "link": "storefront/contacts/creating_a_contact.json",
227
+ "groups": "all",
228
+ "route": "/api/storefront/contacts",
229
+ "method": "POST"
230
+ }
231
+ ]
232
+ },
233
+ {
234
+ "name": "Orders",
235
+ "examples": [
236
+ {
237
+ "description": "Showing an order",
238
+ "link": "storefront/orders/showing_an_order.json",
239
+ "groups": "all",
240
+ "route": "/api/storefront/orders/:id",
241
+ "method": "GET"
242
+ },
243
+ {
244
+ "description": "Listing the user's orders",
245
+ "link": "storefront/orders/listing_the_user_s_orders.json",
246
+ "groups": "all",
247
+ "route": "/api/storefront/orders",
248
+ "method": "GET"
249
+ }
250
+ ]
251
+ },
252
+ {
253
+ "name": "Pages",
254
+ "examples": [
255
+ {
256
+ "description": "Showing a page",
257
+ "link": "storefront/pages/showing_a_page.json",
258
+ "groups": "all",
259
+ "route": "/api/storefront/pages/:slug",
260
+ "method": "GET"
261
+ }
262
+ ]
263
+ },
264
+ {
265
+ "name": "Personalized Recommendations",
266
+ "examples": [
267
+ {
268
+ "description": "Showing recommendations with a session ID",
269
+ "link": "storefront/personalized_recommendations/showing_recommendations_with_a_session_id.json",
270
+ "groups": "all",
271
+ "route": "/api/storefront/recommendations",
272
+ "method": "GET"
273
+ },
274
+ {
275
+ "description": "Showing recommendations with authentication",
276
+ "link": "storefront/personalized_recommendations/showing_recommendations_with_authentication.json",
277
+ "groups": "all",
278
+ "route": "/api/storefront/recommendations",
279
+ "method": "GET"
280
+ }
281
+ ]
282
+ },
283
+ {
284
+ "name": "Saved Addresses",
285
+ "examples": [
286
+ {
287
+ "description": "Creating a saved address",
288
+ "link": "storefront/saved_addresses/creating_a_saved_address.json",
289
+ "groups": "all",
290
+ "route": "/api/storefront/saved_addresses",
291
+ "method": "POST"
292
+ },
293
+ {
294
+ "description": "Updating a saved address",
295
+ "link": "storefront/saved_addresses/updating_a_saved_address.json",
296
+ "groups": "all",
297
+ "route": "/api/storefront/saved_addresses/:id",
298
+ "method": "PATCH"
299
+ },
300
+ {
301
+ "description": "Listing the user's saved addresses",
302
+ "link": "storefront/saved_addresses/listing_the_user_s_saved_addresses.json",
303
+ "groups": "all",
304
+ "route": "/api/storefront/saved_addresses",
305
+ "method": "GET"
306
+ },
307
+ {
308
+ "description": "Showing a saved address",
309
+ "link": "storefront/saved_addresses/showing_a_saved_address.json",
310
+ "groups": "all",
311
+ "route": "/api/storefront/saved_addresses/:id",
312
+ "method": "GET"
313
+ },
314
+ {
315
+ "description": "Deleting a saved address",
316
+ "link": "storefront/saved_addresses/deleting_a_saved_address.json",
317
+ "groups": "all",
318
+ "route": "/api/storefront/saved_addresses/:id",
319
+ "method": "DELETE"
320
+ }
321
+ ]
322
+ },
323
+ {
324
+ "name": "Assets",
325
+ "examples": [
326
+ {
327
+ "description": "Showing an asset",
328
+ "link": "storefront/assets/showing_an_asset.json",
329
+ "groups": "all",
330
+ "route": "/api/storefront/assets/:id",
331
+ "method": "GET"
332
+ }
333
+ ]
334
+ },
335
+ {
336
+ "name": "Validation Errors",
337
+ "examples": [
338
+ {
339
+ "description": "Checkout validation errors",
340
+ "link": "storefront/validation_errors/checkout_validation_errors.json",
341
+ "groups": "all",
342
+ "route": "/api/storefront/checkouts/:id",
343
+ "method": "PATCH"
344
+ },
345
+ {
346
+ "description": "General validation errors",
347
+ "link": "storefront/validation_errors/general_validation_errors.json",
348
+ "groups": "all",
349
+ "route": "/api/storefront/account",
350
+ "method": "POST"
351
+ }
352
+ ]
353
+ },
354
+ {
355
+ "name": "Analytics",
356
+ "examples": [
357
+ {
358
+ "description": "Saving a search abandonment",
359
+ "link": "storefront/analytics/saving_a_search_abandonment.json",
360
+ "groups": "all",
361
+ "route": "/api/storefront/analytics/search_abandonment",
362
+ "method": "POST"
363
+ },
364
+ {
365
+ "description": "saving a category view",
366
+ "link": "storefront/analytics/saving_a_category_view.json",
367
+ "groups": "all",
368
+ "route": "/api/storefront/analytics/category_view/:category_id",
369
+ "method": "POST"
370
+ },
371
+ {
372
+ "description": "saving a product view",
373
+ "link": "storefront/analytics/saving_a_product_view.json",
374
+ "groups": "all",
375
+ "route": "/api/storefront/analytics/product_view/:product_id",
376
+ "method": "POST"
377
+ },
378
+ {
379
+ "description": "Saving a search",
380
+ "link": "storefront/analytics/saving_a_search.json",
381
+ "groups": "all",
382
+ "route": "/api/storefront/analytics/search",
383
+ "method": "POST"
384
+ },
385
+ {
386
+ "description": "Saving filters",
387
+ "link": "storefront/analytics/saving_filters.json",
388
+ "groups": "all",
389
+ "route": "/api/storefront/analytics/filters",
390
+ "method": "POST"
391
+ }
392
+ ]
393
+ },
394
+ {
395
+ "name": "Cart",
396
+ "examples": [
397
+ {
398
+ "description": "Creating a new cart for a user",
399
+ "link": "storefront/cart/creating_a_new_cart_for_a_user.json",
400
+ "groups": "all",
401
+ "route": "/api/storefront/carts",
402
+ "method": "POST"
403
+ },
404
+ {
405
+ "description": "Showing cart",
406
+ "link": "storefront/cart/showing_cart.json",
407
+ "groups": "all",
408
+ "route": "/api/storefront/carts/:id",
409
+ "method": "GET"
410
+ },
411
+ {
412
+ "description": "Listing user's carts",
413
+ "link": "storefront/cart/listing_user_s_carts.json",
414
+ "groups": "all",
415
+ "route": "/api/storefront/carts",
416
+ "method": "GET"
417
+ },
418
+ {
419
+ "description": "Adding a promo code",
420
+ "link": "storefront/cart/adding_a_promo_code.json",
421
+ "groups": "all",
422
+ "route": "/api/storefront/carts/:id/add_promo_code",
423
+ "method": "POST"
424
+ },
425
+ {
426
+ "description": "Delete an item",
427
+ "link": "storefront/cart/delete_an_item.json",
428
+ "groups": "all",
429
+ "route": "/api/storefront/carts/:cart_id/items/:id",
430
+ "method": "DELETE"
431
+ },
432
+ {
433
+ "description": "Creating a new guest cart",
434
+ "link": "storefront/cart/creating_a_new_guest_cart.json",
435
+ "groups": "all",
436
+ "route": "/api/storefront/carts",
437
+ "method": "POST"
438
+ },
439
+ {
440
+ "description": "Updating an item",
441
+ "link": "storefront/cart/updating_an_item.json",
442
+ "groups": "all",
443
+ "route": "/api/storefront/carts/:cart_id/items/:id",
444
+ "method": "PATCH"
445
+ },
446
+ {
447
+ "description": "Adding an item",
448
+ "link": "storefront/cart/adding_an_item.json",
449
+ "groups": "all",
450
+ "route": "/api/storefront/carts/:cart_id/items",
451
+ "method": "POST"
452
+ }
453
+ ]
454
+ },
455
+ {
456
+ "name": "Products",
457
+ "examples": [
458
+ {
459
+ "description": "Showing a product with a specific SKU selected",
460
+ "link": "storefront/products/showing_a_product_with_a_specific_sku_selected.json",
461
+ "groups": "all",
462
+ "route": "/api/storefront/products/:slug",
463
+ "method": "GET"
464
+ },
465
+ {
466
+ "description": "Showing a product",
467
+ "link": "storefront/products/showing_a_product.json",
468
+ "groups": "all",
469
+ "route": "/api/storefront/products/:slug",
470
+ "method": "GET"
471
+ }
472
+ ]
473
+ },
474
+ {
475
+ "name": "Saved Credit Cards",
476
+ "examples": [
477
+ {
478
+ "description": "Updating a saved credit card",
479
+ "link": "storefront/saved_credit_cards/updating_a_saved_credit_card.json",
480
+ "groups": "all",
481
+ "route": "/api/storefront/saved_credit_cards/:id",
482
+ "method": "PATCH"
483
+ },
484
+ {
485
+ "description": "Showing a saved credit card",
486
+ "link": "storefront/saved_credit_cards/showing_a_saved_credit_card.json",
487
+ "groups": "all",
488
+ "route": "/api/storefront/saved_credit_cards/:id",
489
+ "method": "GET"
490
+ },
491
+ {
492
+ "description": "Creating a saved credit card",
493
+ "link": "storefront/saved_credit_cards/creating_a_saved_credit_card.json",
494
+ "groups": "all",
495
+ "route": "/api/storefront/saved_credit_cards",
496
+ "method": "POST"
497
+ },
498
+ {
499
+ "description": "Deleting a saved credit card",
500
+ "link": "storefront/saved_credit_cards/deleting_a_saved_credit_card.json",
501
+ "groups": "all",
502
+ "route": "/api/storefront/saved_credit_cards/:id",
503
+ "method": "DELETE"
504
+ },
505
+ {
506
+ "description": "Listing the user's saved credit cards",
507
+ "link": "storefront/saved_credit_cards/listing_the_user_s_saved_credit_cards.json",
508
+ "groups": "all",
509
+ "route": "/api/storefront/saved_credit_cards",
510
+ "method": "GET"
511
+ }
512
+ ]
513
+ },
514
+ {
515
+ "name": "Taxons",
516
+ "examples": [
517
+ {
518
+ "description": "Showing a taxon",
519
+ "link": "storefront/taxons/showing_a_taxon.json",
520
+ "groups": "all",
521
+ "route": "/api/storefront/taxons/:id",
522
+ "method": "GET"
523
+ }
524
+ ]
525
+ }
526
+ ]
527
+ }
@@ -0,0 +1,51 @@
1
+ {
2
+ "parameters": [
3
+
4
+ ],
5
+ "response_fields": [
6
+
7
+ ],
8
+ "requests": [
9
+ {
10
+ "request_headers": {
11
+ },
12
+ "request_query_parameters": {
13
+ },
14
+ "response_headers": {
15
+ "X-Frame-Options": "SAMEORIGIN",
16
+ "X-XSS-Protection": "1; mode=block",
17
+ "X-Content-Type-Options": "nosniff",
18
+ "X-Download-Options": "noopen",
19
+ "X-Permitted-Cross-Domain-Policies": "none",
20
+ "Referrer-Policy": "strict-origin-when-cross-origin",
21
+ "Date": "Wed, 21 Aug 2019 21:51:25 GMT",
22
+ "Content-Type": "application/json; charset=utf-8",
23
+ "Access-Control-Allow-Origin": "*",
24
+ "Access-Control-Allow-Headers": "*",
25
+ "Access-Control-Allow-Methods": "GET, POST, PATCH, PUT, DELETE, OPTIONS",
26
+ "X-Requested-With": "",
27
+ "Vary": "X-Requested-With, X-Flash-Messages",
28
+ "Cache-Control": "no-cache, no-store, must-revalidate",
29
+ "ETag": "W/\"ce1a70f96858d1bd8110d3bf433a90d1\"",
30
+ "X-Request-Id": "60d379ab-2db5-403f-b348-4bea997434d5",
31
+ "X-Runtime": "0.052184",
32
+ "Expires": "0",
33
+ "Content-Length": "5185"
34
+ },
35
+ "request_method": "GET",
36
+ "request_path": "/api/storefront/menus",
37
+ "request_body": null,
38
+ "request_content_type": null,
39
+ "response_status": 200,
40
+ "response_status_text": "OK",
41
+ "response_body": "{\n \"menus\": [\n {\n \"id\": \"5d5dbcdcd4322a4b69d789d2\",\n \"name\": \"Men\",\n \"position\": 0,\n \"url\": \"/api/storefront/menus/5d5dbcdcd4322a4b69d789d2\",\n \"taxon_url\": \"http://example.com/men\",\n \"content_blocks\": [\n {\n \"id\": \"5d5dbcdcd4322a4b69d789d4\",\n \"type\": \"taxonomy\",\n \"area\": \"default\",\n \"data\": {\n \"start\": \"5d5dbcdcd4322a4b69d789d0\",\n \"header\": \"\",\n \"show_starting_taxon\": true,\n \"image\": \"\",\n \"image_alt\": \"\",\n \"image_link\": \"\",\n \"image_position\": \"\"\n },\n \"hidden_breakpoints\": [\n\n ],\n \"position\": 0,\n \"html\": \"<div class=\\\"content-block content-block--taxonomy\\\" id=\\\"content_block_5d5dbcdcd4322a4b69d789d4\\\" data-analytics=\\\"{&quot;event&quot;:&quot;contentBlockDisplay&quot;,&quot;payload&quot;:{&quot;id&quot;:&quot;5d5dbcdcd4322a4b69d789d4&quot;,&quot;type&quot;:&quot;taxonomy&quot;,&quot;position&quot;:0,&quot;data&quot;:{&quot;start&quot;:&quot;5d5dbcdcd4322a4b69d789d0&quot;,&quot;header&quot;:&quot;&quot;,&quot;show_starting_taxon&quot;:true,&quot;image&quot;:&quot;&quot;,&quot;image_alt&quot;:&quot;&quot;,&quot;image_link&quot;:&quot;&quot;,&quot;image_position&quot;:&quot;&quot;}}}\\\" data-hidden-block-css-content=\\\"Block hidden at this breakpoint\\\"><div class='taxonomy-content-block'>\\n<div class='taxonomy-content-block__container taxonomy-content-block__container--without-image'>\\n<ul class='taxonomy-content-block__menu'>\\n<li class='taxonomy-content-block__menu-item taxonomy-content-block__menu-item--start'>\\nSale\\n</li>\\n</ul>\\n</div>\\n</div>\\n</div>\\n\"\n }\n ]\n },\n {\n \"id\": \"5d5dbcdcd4322a4b69d789d8\",\n \"name\": \"Women\",\n \"position\": 1,\n \"url\": \"/api/storefront/menus/5d5dbcdcd4322a4b69d789d8\",\n \"taxon_url\": \"http://example.com/women\",\n \"content_blocks\": [\n {\n \"id\": \"5d5dbcdcd4322a4b69d789da\",\n \"type\": \"taxonomy\",\n \"area\": \"default\",\n \"data\": {\n \"start\": \"5d5dbcdcd4322a4b69d789d6\",\n \"header\": \"\",\n \"show_starting_taxon\": true,\n \"image\": \"\",\n \"image_alt\": \"\",\n \"image_link\": \"\",\n \"image_position\": \"\"\n },\n \"hidden_breakpoints\": [\n\n ],\n \"position\": 0,\n \"html\": \"<div class=\\\"content-block content-block--taxonomy\\\" id=\\\"content_block_5d5dbcdcd4322a4b69d789da\\\" data-analytics=\\\"{&quot;event&quot;:&quot;contentBlockDisplay&quot;,&quot;payload&quot;:{&quot;id&quot;:&quot;5d5dbcdcd4322a4b69d789da&quot;,&quot;type&quot;:&quot;taxonomy&quot;,&quot;position&quot;:0,&quot;data&quot;:{&quot;start&quot;:&quot;5d5dbcdcd4322a4b69d789d6&quot;,&quot;header&quot;:&quot;&quot;,&quot;show_starting_taxon&quot;:true,&quot;image&quot;:&quot;&quot;,&quot;image_alt&quot;:&quot;&quot;,&quot;image_link&quot;:&quot;&quot;,&quot;image_position&quot;:&quot;&quot;}}}\\\" data-hidden-block-css-content=\\\"Block hidden at this breakpoint\\\"><div class='taxonomy-content-block'>\\n<div class='taxonomy-content-block__container taxonomy-content-block__container--without-image'>\\n<ul class='taxonomy-content-block__menu'>\\n<li class='taxonomy-content-block__menu-item taxonomy-content-block__menu-item--start'>\\nSale\\n</li>\\n</ul>\\n</div>\\n</div>\\n</div>\\n\"\n }\n ]\n },\n {\n \"id\": \"5d5dbcddd4322a4b69d789de\",\n \"name\": \"Children\",\n \"position\": 2,\n \"url\": \"/api/storefront/menus/5d5dbcddd4322a4b69d789de\",\n \"taxon_url\": \"http://example.com/children\",\n \"content_blocks\": [\n {\n \"id\": \"5d5dbcddd4322a4b69d789e0\",\n \"type\": \"taxonomy\",\n \"area\": \"default\",\n \"data\": {\n \"start\": \"5d5dbcdcd4322a4b69d789dc\",\n \"header\": \"\",\n \"show_starting_taxon\": true,\n \"image\": \"\",\n \"image_alt\": \"\",\n \"image_link\": \"\",\n \"image_position\": \"\"\n },\n \"hidden_breakpoints\": [\n\n ],\n \"position\": 0,\n \"html\": \"<div class=\\\"content-block content-block--taxonomy\\\" id=\\\"content_block_5d5dbcddd4322a4b69d789e0\\\" data-analytics=\\\"{&quot;event&quot;:&quot;contentBlockDisplay&quot;,&quot;payload&quot;:{&quot;id&quot;:&quot;5d5dbcddd4322a4b69d789e0&quot;,&quot;type&quot;:&quot;taxonomy&quot;,&quot;position&quot;:0,&quot;data&quot;:{&quot;start&quot;:&quot;5d5dbcdcd4322a4b69d789dc&quot;,&quot;header&quot;:&quot;&quot;,&quot;show_starting_taxon&quot;:true,&quot;image&quot;:&quot;&quot;,&quot;image_alt&quot;:&quot;&quot;,&quot;image_link&quot;:&quot;&quot;,&quot;image_position&quot;:&quot;&quot;}}}\\\" data-hidden-block-css-content=\\\"Block hidden at this breakpoint\\\"><div class='taxonomy-content-block'>\\n<div class='taxonomy-content-block__container taxonomy-content-block__container--without-image'>\\n<ul class='taxonomy-content-block__menu'>\\n<li class='taxonomy-content-block__menu-item taxonomy-content-block__menu-item--start'>\\nSale\\n</li>\\n</ul>\\n</div>\\n</div>\\n</div>\\n\"\n }\n ]\n }\n ]\n}",
42
+ "response_content_type": "application/json",
43
+ "curl": "curl -g \"https://www.example.com/api/storefront/menus\" -X GET "
44
+ }
45
+ ],
46
+ "resource": "Menus",
47
+ "description": "Listing menus",
48
+ "route": "/api/storefront/menus",
49
+ "explanation": " In the base HTML storefront, menus are used as the primary top-level\n navigation entry points. Each menu has associated content (composed\n of content blocks) that represent the navigation to be display when\n that menu is selected (usually a hover or a click on a mobile\n device). Each menu points at a particular spot in the taxonomy.\n",
50
+ "http_method": "GET"
51
+ }
@@ -0,0 +1,51 @@
1
+ {
2
+ "parameters": [
3
+
4
+ ],
5
+ "response_fields": [
6
+
7
+ ],
8
+ "requests": [
9
+ {
10
+ "request_headers": {
11
+ },
12
+ "request_query_parameters": {
13
+ },
14
+ "response_headers": {
15
+ "X-Frame-Options": "SAMEORIGIN",
16
+ "X-XSS-Protection": "1; mode=block",
17
+ "X-Content-Type-Options": "nosniff",
18
+ "X-Download-Options": "noopen",
19
+ "X-Permitted-Cross-Domain-Policies": "none",
20
+ "Referrer-Policy": "strict-origin-when-cross-origin",
21
+ "Date": "Wed, 21 Aug 2019 21:51:25 GMT",
22
+ "Content-Type": "application/json; charset=utf-8",
23
+ "Access-Control-Allow-Origin": "*",
24
+ "Access-Control-Allow-Headers": "*",
25
+ "Access-Control-Allow-Methods": "GET, POST, PATCH, PUT, DELETE, OPTIONS",
26
+ "X-Requested-With": "",
27
+ "Vary": "X-Requested-With, X-Flash-Messages",
28
+ "Cache-Control": "no-cache, no-store, must-revalidate",
29
+ "ETag": "W/\"b335c3d987c8cfffce52ba5ef4f8ef55\"",
30
+ "X-Request-Id": "f8120cc3-8209-49f2-934b-8e05337afa4c",
31
+ "X-Runtime": "0.013205",
32
+ "Expires": "0",
33
+ "Content-Length": "1719"
34
+ },
35
+ "request_method": "GET",
36
+ "request_path": "/api/storefront/menus/5d5dbcddd4322a4b69d789e6",
37
+ "request_body": null,
38
+ "request_content_type": null,
39
+ "response_status": 200,
40
+ "response_status_text": "OK",
41
+ "response_body": "{\n \"id\": \"5d5dbcddd4322a4b69d789e6\",\n \"name\": \"Men\",\n \"position\": 0,\n \"url\": \"/api/storefront/menus/5d5dbcddd4322a4b69d789e6\",\n \"taxon_url\": \"http://example.com/men\",\n \"content_blocks\": [\n {\n \"id\": \"5d5dbcddd4322a4b69d789e8\",\n \"type\": \"taxonomy\",\n \"area\": \"default\",\n \"data\": {\n \"start\": \"5d5dbcddd4322a4b69d789e4\",\n \"header\": \"\",\n \"show_starting_taxon\": true,\n \"image\": \"\",\n \"image_alt\": \"\",\n \"image_link\": \"\",\n \"image_position\": \"\"\n },\n \"hidden_breakpoints\": [\n\n ],\n \"position\": 0,\n \"html\": \"<div class=\\\"content-block content-block--taxonomy\\\" id=\\\"content_block_5d5dbcddd4322a4b69d789e8\\\" data-analytics=\\\"{&quot;event&quot;:&quot;contentBlockDisplay&quot;,&quot;payload&quot;:{&quot;id&quot;:&quot;5d5dbcddd4322a4b69d789e8&quot;,&quot;type&quot;:&quot;taxonomy&quot;,&quot;position&quot;:0,&quot;data&quot;:{&quot;start&quot;:&quot;5d5dbcddd4322a4b69d789e4&quot;,&quot;header&quot;:&quot;&quot;,&quot;show_starting_taxon&quot;:true,&quot;image&quot;:&quot;&quot;,&quot;image_alt&quot;:&quot;&quot;,&quot;image_link&quot;:&quot;&quot;,&quot;image_position&quot;:&quot;&quot;}}}\\\" data-hidden-block-css-content=\\\"Block hidden at this breakpoint\\\"><div class='taxonomy-content-block'>\\n<div class='taxonomy-content-block__container taxonomy-content-block__container--without-image'>\\n<ul class='taxonomy-content-block__menu'>\\n<li class='taxonomy-content-block__menu-item taxonomy-content-block__menu-item--start'>\\nSale\\n</li>\\n</ul>\\n</div>\\n</div>\\n</div>\\n\"\n }\n ]\n}",
42
+ "response_content_type": "application/json",
43
+ "curl": "curl -g \"https://www.example.com/api/storefront/menus/5d5dbcddd4322a4b69d789e6\" -X GET "
44
+ }
45
+ ],
46
+ "resource": "Menus",
47
+ "description": "Showing a menu",
48
+ "route": "/api/storefront/menus/:id",
49
+ "explanation": " This endpoint will return all the data used to render a menu. This\n includes the corresponding content, as well a link to where the\n menu points at in the taxonomy.\n",
50
+ "http_method": "GET"
51
+ }