workarea-api 4.4.6 → 4.5.4

Sign up to get free protection for your applications and to get access to all the features.
Files changed (333) hide show
  1. checksums.yaml +4 -4
  2. data/.eslintrc.json +35 -0
  3. data/.github/workflows/ci.yml +35 -0
  4. data/.gitignore +1 -0
  5. data/.rubocop.yml +2 -0
  6. data/.stylelintrc.json +8 -0
  7. data/CHANGELOG.md +87 -7
  8. data/Gemfile +1 -2
  9. data/README.md +23 -16
  10. data/Rakefile +16 -6
  11. data/admin/LICENSE +52 -0
  12. data/admin/README.md +4 -7
  13. data/admin/app/controllers/workarea/api/admin/categories_controller.rb +6 -0
  14. data/admin/app/controllers/workarea/api/admin/content_assets_controller.rb +6 -0
  15. data/admin/app/controllers/workarea/api/admin/content_controller.rb +6 -0
  16. data/admin/app/controllers/workarea/api/admin/discounts_controller.rb +7 -0
  17. data/admin/app/controllers/workarea/api/admin/email_signups_controller.rb +20 -4
  18. data/admin/app/controllers/workarea/api/admin/fulfillments_controller.rb +6 -1
  19. data/admin/app/controllers/workarea/api/admin/inventory_skus_controller.rb +7 -0
  20. data/admin/app/controllers/workarea/api/admin/navigation_menus_controller.rb +7 -0
  21. data/admin/app/controllers/workarea/api/admin/navigation_taxons_controller.rb +7 -0
  22. data/admin/app/controllers/workarea/api/admin/orders_controller.rb +19 -1
  23. data/admin/app/controllers/workarea/api/admin/pages_controller.rb +7 -0
  24. data/admin/app/controllers/workarea/api/admin/payment_profiles_controller.rb +7 -0
  25. data/admin/app/controllers/workarea/api/admin/payment_transactions_controller.rb +7 -0
  26. data/admin/app/controllers/workarea/api/admin/payments_controller.rb +7 -0
  27. data/admin/app/controllers/workarea/api/admin/pricing_skus_controller.rb +7 -0
  28. data/admin/app/controllers/workarea/api/admin/products_controller.rb +11 -4
  29. data/admin/app/controllers/workarea/api/admin/promo_code_lists_controller.rb +7 -0
  30. data/admin/app/controllers/workarea/api/admin/recommendation_settings_controller.rb +1 -1
  31. data/admin/app/controllers/workarea/api/admin/redirects_controller.rb +7 -0
  32. data/admin/app/controllers/workarea/api/admin/releases_controller.rb +7 -0
  33. data/admin/app/controllers/workarea/api/admin/shipping_services_controller.rb +7 -0
  34. data/admin/app/controllers/workarea/api/admin/shippings_controller.rb +7 -0
  35. data/admin/app/controllers/workarea/api/admin/swagger_controller.rb +33 -0
  36. data/admin/app/controllers/workarea/api/admin/tax_categories_controller.rb +2 -0
  37. data/admin/app/controllers/workarea/api/admin/users_controller.rb +28 -14
  38. data/admin/app/models/workarea/api/admin/date_filtering.rb +27 -0
  39. data/admin/lib/workarea/api/admin/engine.rb +11 -0
  40. data/admin/test/documentation/workarea/api/admin/email_signups_documentation_test.rb +14 -2
  41. data/admin/test/documentation/workarea/api/admin/global_functionality_documentation_test.rb +140 -0
  42. data/admin/test/documentation/workarea/api/admin/orders_documentation_test.rb +13 -6
  43. data/admin/test/documentation/workarea/api/admin/users_documentation_test.rb +14 -2
  44. data/admin/test/dummy/config/initializers/session_store.rb +3 -1
  45. data/admin/test/integration/workarea/api/admin/categories_integration_test.rb +32 -0
  46. data/admin/test/integration/workarea/api/admin/content_assets_integration_test.rb +32 -0
  47. data/admin/test/integration/workarea/api/admin/content_integration_test.rb +32 -0
  48. data/admin/test/integration/workarea/api/admin/discounts_integration_test.rb +32 -0
  49. data/admin/test/integration/workarea/api/admin/email_signups_integration_test.rb +38 -1
  50. data/admin/test/integration/workarea/api/admin/fulfillments_integration_test.rb +22 -0
  51. data/admin/test/integration/workarea/api/admin/inventory_skus_integration_test.rb +32 -0
  52. data/admin/test/integration/workarea/api/admin/navigation_menus_integration_test.rb +32 -0
  53. data/admin/test/integration/workarea/api/admin/navigation_taxons_integration_test.rb +32 -0
  54. data/admin/test/integration/workarea/api/admin/orders_integration_test.rb +41 -2
  55. data/admin/test/integration/workarea/api/admin/pages_integration_test.rb +32 -0
  56. data/admin/test/integration/workarea/api/admin/payment_profiles_integration_test.rb +32 -0
  57. data/admin/test/integration/workarea/api/admin/payment_transactions_integration_test.rb +32 -0
  58. data/admin/test/integration/workarea/api/admin/payments_integration_test.rb +32 -0
  59. data/admin/test/integration/workarea/api/admin/pricing_skus_integration_test.rb +32 -0
  60. data/admin/test/integration/workarea/api/admin/products_integration_test.rb +35 -0
  61. data/admin/test/integration/workarea/api/admin/promo_code_lists_integration_test.rb +31 -0
  62. data/admin/test/integration/workarea/api/admin/recommendation_settings_integration_test.rb +14 -0
  63. data/admin/test/integration/workarea/api/admin/redirects_integration_test.rb +31 -0
  64. data/admin/test/integration/workarea/api/admin/releases_integration_test.rb +31 -0
  65. data/admin/test/integration/workarea/api/admin/shipping_services_integration_test.rb +31 -0
  66. data/admin/test/integration/workarea/api/admin/shippings_integration_test.rb +31 -0
  67. data/admin/test/integration/workarea/api/admin/tax_categories_integration_test.rb +31 -0
  68. data/admin/test/integration/workarea/api/admin/users_integration_test.rb +44 -1
  69. data/admin/workarea-api-admin.gemspec +7 -6
  70. data/app/views/workarea/api/docs/nav.haml +12 -0
  71. data/doc/api/admin/categories/bulk_upserting_categories.json +8 -4
  72. data/doc/api/admin/categories/creating_a_category.json +11 -8
  73. data/doc/api/admin/categories/listing_categories.json +8 -5
  74. data/doc/api/admin/categories/removing_a_category.json +8 -4
  75. data/doc/api/admin/categories/showing_a_category.json +10 -7
  76. data/doc/api/admin/categories/updating_a_category.json +9 -5
  77. data/doc/api/admin/category_product_rules/creating_a_category_product_rule.json +11 -8
  78. data/doc/api/admin/category_product_rules/listing_category_product_rules.json +10 -7
  79. data/doc/api/admin/category_product_rules/removing_a_category_product_rule.json +8 -4
  80. data/doc/api/admin/category_product_rules/updating_a_category_product_rule.json +8 -4
  81. data/doc/api/admin/content/bulk_upserting_content.json +8 -4
  82. data/doc/api/admin/content/creating_content.json +11 -8
  83. data/doc/api/admin/content/listing_content.json +8 -5
  84. data/doc/api/admin/content/showing_content.json +10 -7
  85. data/doc/api/admin/content/updating_content.json +8 -4
  86. data/doc/api/admin/content_assets/bulk_upserting_content_assets.json +8 -4
  87. data/doc/api/admin/content_assets/creating_a_content_asset.json +11 -8
  88. data/doc/api/admin/content_assets/listing_content_assets.json +8 -5
  89. data/doc/api/admin/content_assets/removing_a_content_asset.json +8 -4
  90. data/doc/api/admin/content_assets/showing_a_content_asset.json +10 -7
  91. data/doc/api/admin/content_assets/updating_a_content_asset.json +9 -5
  92. data/doc/api/admin/discounts/creating_a_discount.json +11 -8
  93. data/doc/api/admin/discounts/listing_discounts.json +8 -5
  94. data/doc/api/admin/discounts/removing_a_discount.json +8 -4
  95. data/doc/api/admin/discounts/showing_a_discount.json +10 -7
  96. data/doc/api/admin/discounts/updating_discounts.json +8 -4
  97. data/doc/api/admin/email_signups/listing_email_signups.json +7 -4
  98. data/doc/api/admin/email_signups/showing_an_email_signup.json +10 -12
  99. data/doc/api/admin/email_signups/showing_an_email_signup_by_email.json +47 -0
  100. data/doc/api/admin/email_signups/showing_an_email_signup_by_id.json +47 -0
  101. data/doc/api/admin/fulfillment/listing_fulfillments.json +7 -4
  102. data/doc/api/admin/fulfillment/marking_items_as_canceled.json +9 -6
  103. data/doc/api/admin/fulfillment/marking_items_as_shipped.json +9 -6
  104. data/doc/api/admin/fulfillment/showing_fulfillment.json +7 -4
  105. data/doc/api/admin/global_functionality/dealing_with_locales.json +86 -0
  106. data/doc/api/admin/global_functionality/filtering_by_created_at_time_stamp.json +56 -0
  107. data/doc/api/admin/global_functionality/filtering_by_updated_time_stamp.json +56 -0
  108. data/doc/api/admin/global_functionality/paging_results.json +51 -0
  109. data/doc/api/admin/global_functionality/retrieving_addtional_pages_of_results.json +51 -0
  110. data/doc/api/admin/global_functionality/sorting_results.json +56 -0
  111. data/doc/api/admin/index.json +653 -578
  112. data/doc/api/admin/inventory_skus/bulk_upserting_inventory_skus.json +8 -4
  113. data/doc/api/admin/inventory_skus/creating_an_inventory_sku.json +9 -6
  114. data/doc/api/admin/inventory_skus/listing_inventory_skus.json +7 -4
  115. data/doc/api/admin/inventory_skus/removing_an_inventory_sku.json +6 -2
  116. data/doc/api/admin/inventory_skus/showing_an_inventory_sku.json +7 -4
  117. data/doc/api/admin/inventory_skus/updating_an_inventory_sku.json +6 -2
  118. data/doc/api/admin/navigation_menus/creating_a_menu.json +11 -8
  119. data/doc/api/admin/navigation_menus/listing_menus.json +8 -5
  120. data/doc/api/admin/navigation_menus/removing_a_navigation_menu.json +8 -4
  121. data/doc/api/admin/navigation_menus/showing_a_navigation_menu.json +10 -7
  122. data/doc/api/admin/navigation_menus/updating_a_navigation_menus.json +8 -4
  123. data/doc/api/admin/navigation_taxonomy/bulk_upserting_navigation_taxons.json +8 -4
  124. data/doc/api/admin/navigation_taxonomy/creating_a_taxon.json +10 -7
  125. data/doc/api/admin/navigation_taxonomy/listing_taxons.json +7 -4
  126. data/doc/api/admin/navigation_taxonomy/removing_a_navigation_taxon.json +8 -4
  127. data/doc/api/admin/navigation_taxonomy/showing_a_navigation_taxon.json +9 -6
  128. data/doc/api/admin/navigation_taxonomy/updating_a_navigation_taxons.json +8 -4
  129. data/doc/api/admin/orders/listing_orders.json +8 -5
  130. data/doc/api/admin/orders/showing_an_order.json +8 -5
  131. data/doc/api/admin/orders/viewing_orders_by_date_range.json +17 -9
  132. data/doc/api/admin/pages/bulk_upserting_pages.json +8 -4
  133. data/doc/api/admin/pages/creating_a_page.json +11 -8
  134. data/doc/api/admin/pages/listing_pages.json +8 -5
  135. data/doc/api/admin/pages/removing_a_page.json +8 -4
  136. data/doc/api/admin/pages/showing_a_page.json +10 -7
  137. data/doc/api/admin/pages/updating_a_page.json +9 -5
  138. data/doc/api/admin/payment_profiles/bulk_upserting_payment_profiles.json +8 -4
  139. data/doc/api/admin/payment_profiles/creating_a_payment_profile.json +10 -7
  140. data/doc/api/admin/payment_profiles/listing_payment_profiles.json +7 -4
  141. data/doc/api/admin/payment_profiles/removing_a_payment_profile.json +8 -4
  142. data/doc/api/admin/payment_profiles/showing_a_payment_profile.json +9 -6
  143. data/doc/api/admin/payment_profiles/updating_a_payment_profiles.json +8 -4
  144. data/doc/api/admin/payment_transactions/listing_payment_transactions.json +7 -4
  145. data/doc/api/admin/payment_transactions/showing_a_payment_transaction.json +9 -6
  146. data/doc/api/admin/payments/listing_payments.json +7 -4
  147. data/doc/api/admin/payments/showing_an_payment.json +7 -4
  148. data/doc/api/admin/prices/creating_a_pricing_sku_price.json +8 -5
  149. data/doc/api/admin/prices/listing_pricing_sku_prices.json +8 -5
  150. data/doc/api/admin/prices/removing_a_pricing_sku_price.json +8 -4
  151. data/doc/api/admin/prices/updating_a_pricing_sku_price.json +8 -4
  152. data/doc/api/admin/pricing_skus/bulk_upserting_pricing_skus.json +8 -4
  153. data/doc/api/admin/pricing_skus/creating_an_pricing_sku.json +10 -7
  154. data/doc/api/admin/pricing_skus/listing_pricing_skus.json +8 -5
  155. data/doc/api/admin/pricing_skus/removing_an_pricing_sku.json +6 -2
  156. data/doc/api/admin/pricing_skus/showing_an_pricing_sku.json +8 -5
  157. data/doc/api/admin/pricing_skus/updating_an_pricing_sku.json +6 -2
  158. data/doc/api/admin/product_images/creating_a_product_image_from_base64.json +11 -8
  159. data/doc/api/admin/product_images/creating_a_product_image_from_url.json +11 -8
  160. data/doc/api/admin/product_images/listing_product_images.json +10 -7
  161. data/doc/api/admin/product_images/removing_a_product_image.json +8 -4
  162. data/doc/api/admin/product_images/updating_a_product_image.json +8 -4
  163. data/doc/api/admin/products/bulk_upserting_products.json +8 -4
  164. data/doc/api/admin/products/creating_a_product.json +11 -8
  165. data/doc/api/admin/products/listing_products.json +8 -5
  166. data/doc/api/admin/products/removing_a_product.json +8 -4
  167. data/doc/api/admin/products/showing_a_product.json +10 -7
  168. data/doc/api/admin/products/updating_a_product.json +9 -5
  169. data/doc/api/admin/promo_code_lists/bulk_upserting_promo_code_lists.json +8 -4
  170. data/doc/api/admin/promo_code_lists/creating_a_promo_code_list.json +10 -7
  171. data/doc/api/admin/promo_code_lists/listing_promo_code_lists.json +7 -4
  172. data/doc/api/admin/promo_code_lists/removing_a_promo_code_list.json +8 -4
  173. data/doc/api/admin/promo_code_lists/showing_a_promo_code_list.json +9 -6
  174. data/doc/api/admin/promo_code_lists/updating_a_promo_code_list.json +8 -4
  175. data/doc/api/admin/recommendation_settings/showing_recommendation_settings.json +9 -6
  176. data/doc/api/admin/recommendation_settings/updating_recommendation_settings.json +8 -4
  177. data/doc/api/admin/redirects/bulk_upserting_redirects.json +8 -4
  178. data/doc/api/admin/redirects/creating_a_redirect.json +10 -7
  179. data/doc/api/admin/redirects/listing_redirects.json +7 -4
  180. data/doc/api/admin/redirects/removing_a_redirect.json +8 -4
  181. data/doc/api/admin/redirects/showing_a_redirect.json +9 -6
  182. data/doc/api/admin/redirects/updating_a_redirects.json +8 -4
  183. data/doc/api/admin/release_changes/adding_changes_to_a_release.json +11 -7
  184. data/doc/api/admin/releases/bulk_upserting_releases.json +8 -4
  185. data/doc/api/admin/releases/creating_a_release.json +11 -8
  186. data/doc/api/admin/releases/listing_releases.json +8 -5
  187. data/doc/api/admin/releases/removing_a_release.json +8 -4
  188. data/doc/api/admin/releases/showing_a_release.json +10 -7
  189. data/doc/api/admin/releases/updating_a_release.json +9 -5
  190. data/doc/api/admin/saved_addresses/creating_a_saved_address.json +10 -7
  191. data/doc/api/admin/saved_addresses/listing_saved_address.json +9 -6
  192. data/doc/api/admin/saved_addresses/removing_a_saved_address.json +8 -4
  193. data/doc/api/admin/saved_addresses/updating_a_saved_address.json +8 -4
  194. data/doc/api/admin/saved_credit_cards/creating_a_saved_credit_card.json +11 -8
  195. data/doc/api/admin/saved_credit_cards/listing_saved_credit_cards.json +9 -6
  196. data/doc/api/admin/saved_credit_cards/removing_a_saved_credit_card.json +8 -4
  197. data/doc/api/admin/saved_credit_cards/updating_a_saved_credit_card.json +8 -4
  198. data/doc/api/admin/shipping/listing_shipments.json +7 -4
  199. data/doc/api/admin/shipping/showing_a_shipment.json +9 -6
  200. data/doc/api/admin/shipping_rates/creating_a_shipping_rate.json +10 -7
  201. data/doc/api/admin/shipping_rates/listing_shipping_rates.json +9 -6
  202. data/doc/api/admin/shipping_rates/removing_a_shipping_rate.json +8 -4
  203. data/doc/api/admin/shipping_rates/updating_a_shipping_rate.json +8 -4
  204. data/doc/api/admin/shipping_services/bulk_upserting_shipping_services.json +8 -4
  205. data/doc/api/admin/shipping_services/creating_a_shipping_service.json +10 -7
  206. data/doc/api/admin/shipping_services/listing_shipping_services.json +7 -4
  207. data/doc/api/admin/shipping_services/removing_a_shipping_service.json +8 -4
  208. data/doc/api/admin/shipping_services/showing_a_shipping_service.json +9 -6
  209. data/doc/api/admin/shipping_services/updating_a_shipping_service.json +9 -5
  210. data/doc/api/admin/tax_categories/bulk_upserting_tax_categories.json +8 -4
  211. data/doc/api/admin/tax_categories/creating_a_tax_category.json +10 -7
  212. data/doc/api/admin/tax_categories/listing_tax_categories.json +7 -4
  213. data/doc/api/admin/tax_categories/removing_a_tax_category.json +8 -4
  214. data/doc/api/admin/tax_categories/showing_a_tax_category.json +9 -6
  215. data/doc/api/admin/tax_categories/updating_a_tax_categories.json +8 -4
  216. data/doc/api/admin/tax_rates/creating_a_tax_rate.json +12 -9
  217. data/doc/api/admin/tax_rates/listing_tax_rates.json +10 -7
  218. data/doc/api/admin/tax_rates/removing_a_tax_rate.json +8 -4
  219. data/doc/api/admin/tax_rates/updating_a_tax_rate.json +8 -4
  220. data/doc/api/admin/users/bulk_upserting_users.json +8 -4
  221. data/doc/api/admin/users/creating_a_user.json +11 -8
  222. data/doc/api/admin/users/listing_users.json +8 -5
  223. data/doc/api/admin/users/removing_a_user.json +8 -4
  224. data/doc/api/admin/users/showing_a_user.json +10 -12
  225. data/doc/api/admin/users/showing_a_user_by_email.json +47 -0
  226. data/doc/api/admin/users/showing_a_user_by_id.json +47 -0
  227. data/doc/api/admin/users/updating_a_user.json +9 -5
  228. data/doc/api/admin/variants/creating_a_product_variant.json +11 -8
  229. data/doc/api/admin/variants/listing_product_variants.json +10 -7
  230. data/doc/api/admin/variants/removing_a_product_variant.json +8 -4
  231. data/doc/api/admin/variants/updating_a_product_variant.json +8 -4
  232. data/doc/api/storefront/accounts/creating_an_account.json +7 -6
  233. data/doc/api/storefront/accounts/getting_account_details.json +9 -8
  234. data/doc/api/storefront/accounts/updating_an_account.json +9 -8
  235. data/doc/api/storefront/analytics/saving_a_category_view.json +18 -5
  236. data/doc/api/storefront/analytics/saving_a_product_view.json +18 -5
  237. data/doc/api/storefront/analytics/saving_a_search.json +18 -5
  238. data/doc/api/storefront/assets/showing_an_asset.json +9 -8
  239. data/doc/api/storefront/authentication/creating_an_authentication_token.json +9 -8
  240. data/doc/api/storefront/authentication/refreshing_an_authentication_token.json +9 -8
  241. data/doc/api/storefront/authentication/using_an_authentication_token.json +9 -8
  242. data/doc/api/storefront/cart/adding_a_promo_code.json +10 -9
  243. data/doc/api/storefront/cart/adding_an_item.json +10 -9
  244. data/doc/api/storefront/cart/creating_a_new_cart_for_a_user.json +9 -8
  245. data/doc/api/storefront/cart/creating_a_new_guest_cart.json +7 -6
  246. data/doc/api/storefront/cart/delete_an_item.json +10 -9
  247. data/doc/api/storefront/cart/listing_user_s_carts.json +9 -8
  248. data/doc/api/storefront/cart/showing_cart.json +10 -9
  249. data/doc/api/storefront/cart/updating_an_item.json +10 -9
  250. data/doc/api/storefront/categories/showing_a_category.json +8 -7
  251. data/doc/api/storefront/categories/showing_a_listing_of_categories.json +8 -7
  252. data/doc/api/storefront/checkout/completing_a_checkout.json +9 -8
  253. data/doc/api/storefront/checkout/showing_a_checkout.json +10 -9
  254. data/doc/api/storefront/checkout/updating_a_checkout.json +9 -8
  255. data/doc/api/storefront/contacts/creating_a_contact.json +7 -6
  256. data/doc/api/storefront/email_signups/creating_an_email_signup.json +7 -6
  257. data/doc/api/storefront/email_signups/showing_an_email_signup_content.json +7 -6
  258. data/doc/api/storefront/index.json +263 -258
  259. data/doc/api/storefront/menus/listing_menus.json +8 -7
  260. data/doc/api/storefront/menus/showing_a_menu.json +10 -9
  261. data/doc/api/storefront/orders/listing_the_user_s_orders.json +9 -8
  262. data/doc/api/storefront/orders/showing_an_order.json +10 -9
  263. data/doc/api/storefront/pages/showing_a_page.json +8 -7
  264. data/doc/api/storefront/password_resets/sending_a_forgot_password_email.json +8 -6
  265. data/doc/api/storefront/personalized_recommendations/showing_recommendations_with_a_session_id.json +11 -11
  266. data/doc/api/storefront/personalized_recommendations/showing_recommendations_with_authentication.json +9 -8
  267. data/doc/api/storefront/products/showing_a_product.json +8 -7
  268. data/doc/api/storefront/products/showing_a_product_with_a_specific_sku_selected.json +8 -7
  269. data/doc/api/storefront/recent_views/showing_recent_views_from_authentication.json +10 -9
  270. data/doc/api/storefront/recent_views/showing_recent_views_with_a_session_id.json +11 -11
  271. data/doc/api/storefront/recent_views/updating_recent_views_with_a_session_id.json +6 -4
  272. data/doc/api/storefront/recent_views/updating_recent_views_with_authentication.json +8 -6
  273. data/doc/api/storefront/saved_addresses/creating_a_saved_address.json +8 -7
  274. data/doc/api/storefront/saved_addresses/deleting_a_saved_address.json +8 -6
  275. data/doc/api/storefront/saved_addresses/listing_the_user_s_saved_addresses.json +9 -8
  276. data/doc/api/storefront/saved_addresses/showing_a_saved_address.json +9 -8
  277. data/doc/api/storefront/saved_addresses/updating_a_saved_address.json +9 -8
  278. data/doc/api/storefront/saved_credit_cards/creating_a_saved_credit_card.json +8 -7
  279. data/doc/api/storefront/saved_credit_cards/deleting_a_saved_credit_card.json +8 -6
  280. data/doc/api/storefront/saved_credit_cards/listing_the_user_s_saved_credit_cards.json +9 -8
  281. data/doc/api/storefront/saved_credit_cards/showing_a_saved_credit_card.json +9 -8
  282. data/doc/api/storefront/saved_credit_cards/updating_a_saved_credit_card.json +9 -8
  283. data/doc/api/storefront/searches/showing_search_autocomplete_suggestions.json +9 -8
  284. data/doc/api/storefront/searches/showing_search_results.json +8 -7
  285. data/doc/api/storefront/segmentation/specifying_session_count_for_segmentation.json +93 -0
  286. data/doc/api/storefront/segmentation/using_session_ids_for_segmenting_non_authenticated_users.json +93 -0
  287. data/doc/api/storefront/system_content/showing_system_content.json +8 -7
  288. data/doc/api/storefront/system_content/showing_the_home_page.json +8 -7
  289. data/doc/api/storefront/taxons/showing_a_taxon.json +10 -9
  290. data/doc/api/storefront/validation_errors/checkout_validation_errors.json +9 -8
  291. data/doc/api/storefront/validation_errors/general_validation_errors.json +4 -3
  292. data/lib/tasks/docs.rake +20 -0
  293. data/lib/workarea/api/documentation_test.rb +10 -1
  294. data/lib/workarea/api/version.rb +1 -1
  295. data/storefront/LICENSE +52 -0
  296. data/storefront/README.md +4 -7
  297. data/storefront/app/controllers/workarea/api/storefront/analytics_controller.rb +31 -19
  298. data/storefront/app/controllers/workarea/api/storefront/application_controller.rb +15 -2
  299. data/storefront/app/controllers/workarea/api/storefront/authentication.rb +6 -9
  300. data/storefront/app/controllers/workarea/api/storefront/categories_controller.rb +3 -1
  301. data/storefront/app/controllers/workarea/api/storefront/checkouts_controller.rb +0 -1
  302. data/storefront/app/controllers/workarea/api/storefront/menus_controller.rb +3 -1
  303. data/storefront/app/controllers/workarea/api/storefront/pages_controller.rb +3 -1
  304. data/storefront/app/controllers/workarea/api/storefront/products_controller.rb +3 -1
  305. data/storefront/app/controllers/workarea/api/storefront/recent_views_controller.rb +13 -26
  306. data/storefront/app/controllers/workarea/api/storefront/recommendations_controller.rb +2 -8
  307. data/storefront/app/controllers/workarea/api/storefront/searches_controller.rb +0 -12
  308. data/storefront/app/views/workarea/api/storefront/categories/show.json.jbuilder +1 -1
  309. data/storefront/app/views/workarea/api/storefront/email_signups/show.json.jbuilder +1 -1
  310. data/storefront/app/views/workarea/api/storefront/menus/_menu.json.jbuilder +1 -1
  311. data/storefront/app/views/workarea/api/storefront/pages/show.json.jbuilder +1 -1
  312. data/storefront/app/views/workarea/api/storefront/recent_views/show.json.jbuilder +0 -1
  313. data/storefront/app/views/workarea/api/storefront/searches/show.json.jbuilder +1 -1
  314. data/storefront/app/views/workarea/api/storefront/system_content/show.json.jbuilder +1 -1
  315. data/storefront/config/initializers/config.rb +19 -0
  316. data/storefront/lib/workarea/api/storefront.rb +1 -0
  317. data/storefront/lib/workarea/api/storefront/visit.decorator +52 -0
  318. data/storefront/test/documentation/workarea/api/storefront/checkouts_documentation_test.rb +21 -0
  319. data/storefront/test/documentation/workarea/api/storefront/segmentation_documentation_test.rb +104 -0
  320. data/storefront/test/documentation/workarea/api/storefront/validation_documentation_test.rb +1 -1
  321. data/storefront/test/dummy/config/initializers/session_store.rb +3 -1
  322. data/storefront/test/integration/workarea/api/storefront/analytics_integration_test.rb +12 -7
  323. data/storefront/test/integration/workarea/api/storefront/recent_views_integration_test.rb +38 -33
  324. data/storefront/test/integration/workarea/api/storefront/recommendations_integration_test.rb +1 -1
  325. data/storefront/test/integration/workarea/api/storefront/searches_integration_test.rb +0 -36
  326. data/storefront/test/integration/workarea/api/storefront/segments_integration_test.rb +218 -0
  327. data/storefront/workarea-api-storefront.gemspec +8 -7
  328. data/workarea-api.gemspec +4 -4
  329. metadata +38 -17
  330. data/doc/api/storefront/analytics/saving_a_search_abandonment.json +0 -38
  331. data/doc/api/storefront/analytics/saving_filters.json +0 -38
  332. data/storefront/app/controllers/workarea/api/storefront/user_activity.rb +0 -36
  333. data/storefront/app/view_models/workarea/api/storefront/search_suggestion_view_model.rb +0 -21
@@ -24,11 +24,12 @@
24
24
  "Access-Control-Allow-Headers": "*",
25
25
  "Access-Control-Allow-Methods": "GET, POST, PATCH, PUT, DELETE, OPTIONS",
26
26
  "X-Requested-With": "",
27
- "Vary": "X-Requested-With, X-Flash-Messages",
28
- "ETag": "W/\"76880827332a021ed329f2d9accad414\"",
27
+ "Vary": "X-Requested-With, X-Workarea-Segments",
28
+ "Last-Modified": "Wed, 27 Nov 2019 00:50:56 GMT",
29
29
  "Cache-Control": "no-cache, no-store, must-revalidate",
30
- "X-Request-Id": "5aeaea80-91ae-4792-817c-c62039897f8e",
31
- "X-Runtime": "0.027782",
30
+ "X-Request-Id": "494b0407-edc8-4eda-87ed-f4d8cab1f372",
31
+ "X-Runtime": "0.057435",
32
+ "X-Workarea-Segments": "",
32
33
  "Expires": "0",
33
34
  "Content-Length": "228"
34
35
  },
@@ -38,7 +39,7 @@
38
39
  "request_content_type": "application/json",
39
40
  "response_status": 200,
40
41
  "response_status_text": "OK",
41
- "response_body": "{\n \"inquiry\": {\n \"_id\": \"5d5dbcd7d4322a4b69d789ab\",\n \"created_at\": \"2019-08-21T21:51:19.702Z\",\n \"email\": \"email@example.com\",\n \"message\": \"Message\",\n \"name\": \"Name\",\n \"order_id\": \"OrderID\",\n \"subject\": \"orders\",\n \"updated_at\": \"2019-08-21T21:51:19.702Z\"\n }\n}",
42
+ "response_body": "{\n \"inquiry\": {\n \"_id\": \"5dddc8701241596aa5204883\",\n \"created_at\": \"2019-11-27T00:50:56.027Z\",\n \"email\": \"email@example.com\",\n \"message\": \"Message\",\n \"name\": \"Name\",\n \"order_id\": \"OrderID\",\n \"subject\": \"orders\",\n \"updated_at\": \"2019-11-27T00:50:56.027Z\"\n }\n}",
42
43
  "response_content_type": "application/json",
43
44
  "curl": "curl \"https://www.example.com/api/storefront/contacts\" -d '{\"name\":\"Name\",\"email\":\"email@example.com\",\"order_id\":\"OrderID\",\"subject\":\"orders\",\"message\":\"Message\"}' -X POST \\\n\t-H \"Content-Type: application/json\""
44
45
  }
@@ -46,6 +47,6 @@
46
47
  "resource": "Contacts",
47
48
  "description": "Creating a contact",
48
49
  "route": "/api/storefront/contacts",
49
- "explanation": " This endpoints creates a customer service inquiry on behalf of the\n customer, and will send an email to the address in\n Workarea.config.email_to\n",
50
+ "explanation": "<p>This endpoints creates a customer service inquiry on behalf of the<br>\ncustomer, and will send an email to the address in<br>\nWorkarea.config.email_to</p>\n",
50
51
  "http_method": "POST"
51
52
  }
@@ -24,11 +24,12 @@
24
24
  "Access-Control-Allow-Headers": "*",
25
25
  "Access-Control-Allow-Methods": "GET, POST, PATCH, PUT, DELETE, OPTIONS",
26
26
  "X-Requested-With": "",
27
- "Vary": "X-Requested-With, X-Flash-Messages",
28
- "ETag": "W/\"32291d1d507a8f6b0b38211a17edd5ab\"",
27
+ "Vary": "X-Requested-With, X-Workarea-Segments",
28
+ "Last-Modified": "Wed, 27 Nov 2019 00:49:17 GMT",
29
29
  "Cache-Control": "no-cache, no-store, must-revalidate",
30
- "X-Request-Id": "b391b107-687a-4ab2-9b62-92697a27ada3",
31
- "X-Runtime": "0.006754",
30
+ "X-Request-Id": "8479964a-90ec-4708-96af-56ae68f23f94",
31
+ "X-Runtime": "0.012033",
32
+ "X-Workarea-Segments": "",
32
33
  "Expires": "0",
33
34
  "Content-Length": "61"
34
35
  },
@@ -38,7 +39,7 @@
38
39
  "request_content_type": "application/json",
39
40
  "response_status": 200,
40
41
  "response_status_text": "OK",
41
- "response_body": "{\n \"id\": \"5d5dbdc5d4322a4b69d7959c\",\n \"email\": \"email@example.com\"\n}",
42
+ "response_body": "{\n \"id\": \"5dddc80d1241596aa52044ec\",\n \"email\": \"email@example.com\"\n}",
42
43
  "response_content_type": "application/json",
43
44
  "curl": "curl \"https://www.example.com/api/storefront/email_signups\" -d '{\"email\":\"email@example.com\"}' -X POST \\\n\t-H \"Content-Type: application/json\""
44
45
  }
@@ -46,6 +47,6 @@
46
47
  "resource": "Email Signups",
47
48
  "description": "Creating an email signup",
48
49
  "route": "/api/storefront/email_signups",
49
- "explanation": " Use this endpoint to create an email signup. This will usually be\n forwarded to an Email Service Provider, but Workarea will keep a\n record of it just in case.\n",
50
+ "explanation": "<p>Use this endpoint to create an email signup. This will usually be<br>\nforwarded to an Email Service Provider, but Workarea will keep a<br>\nrecord of it just in case.</p>\n",
50
51
  "http_method": "POST"
51
52
  }
@@ -23,11 +23,12 @@
23
23
  "Access-Control-Allow-Headers": "*",
24
24
  "Access-Control-Allow-Methods": "GET, POST, PATCH, PUT, DELETE, OPTIONS",
25
25
  "X-Requested-With": "",
26
- "Vary": "X-Requested-With, X-Flash-Messages",
27
- "ETag": "W/\"96ed7403230af7f94fa75ae4616e8d73\"",
26
+ "Vary": "X-Requested-With, X-Workarea-Segments",
27
+ "Last-Modified": "Wed, 27 Nov 2019 00:49:18 GMT",
28
28
  "Cache-Control": "no-cache, no-store, must-revalidate",
29
- "X-Request-Id": "2c53a37f-32d4-412c-af96-1e50dd316d36",
30
- "X-Runtime": "0.007337",
29
+ "X-Request-Id": "841174c6-b2cd-4b93-a98f-4e8dd70beeb5",
30
+ "X-Runtime": "0.007996",
31
+ "X-Workarea-Segments": "",
31
32
  "Expires": "0",
32
33
  "Content-Length": "900"
33
34
  },
@@ -37,7 +38,7 @@
37
38
  "request_content_type": null,
38
39
  "response_status": 200,
39
40
  "response_status_text": "OK",
40
- "response_body": "{\n \"title\": \"Sign up for our email list\",\n \"content_blocks\": [\n {\n \"id\": \"5d5dbdc5d4322a4b69d7959f\",\n \"type\": \"text\",\n \"area\": \"default\",\n \"data\": {\n \"text\": \"Here is some administrated content\"\n },\n \"hidden_breakpoints\": [\n\n ],\n \"position\": 0,\n \"html\": \"<div class=\\\"content-block content-block--text\\\" id=\\\"content_block_5d5dbdc5d4322a4b69d7959f\\\" data-analytics=\\\"{&quot;event&quot;:&quot;contentBlockDisplay&quot;,&quot;payload&quot;:{&quot;id&quot;:&quot;5d5dbdc5d4322a4b69d7959f&quot;,&quot;type&quot;:&quot;text&quot;,&quot;position&quot;:0,&quot;data&quot;:{&quot;text&quot;:&quot;Here is some administrated content&quot;}}}\\\" data-hidden-block-css-content=\\\"Block hidden at this breakpoint\\\"><div class='text-content-block'>Here is some administrated content</div>\\n</div>\\n\"\n }\n ]\n}",
41
+ "response_body": "{\n \"title\": \"Sign up for our email list\",\n \"content_blocks\": [\n {\n \"id\": \"5dddc80e1241596aa52044ef\",\n \"type\": \"text\",\n \"area\": \"default\",\n \"data\": {\n \"text\": \"Here is some administrated content\"\n },\n \"hidden_breakpoints\": [\n\n ],\n \"position\": 0,\n \"html\": \"<div class=\\\"content-block content-block--text\\\" id=\\\"content_block_5dddc80e1241596aa52044ef\\\" data-analytics=\\\"{&quot;event&quot;:&quot;contentBlockDisplay&quot;,&quot;payload&quot;:{&quot;id&quot;:&quot;5dddc80e1241596aa52044ef&quot;,&quot;type&quot;:&quot;text&quot;,&quot;position&quot;:0,&quot;data&quot;:{&quot;text&quot;:&quot;Here is some administrated content&quot;}}}\\\" data-hidden-block-css-content=\\\"Block hidden at this breakpoint\\\"><div class='text-content-block'>Here is some administrated content</div>\\n</div>\\n\"\n }\n ]\n}",
41
42
  "response_content_type": "application/json",
42
43
  "curl": "curl -g \"https://www.example.com/api/storefront/email_signups\" -X GET "
43
44
  }
@@ -45,6 +46,6 @@
45
46
  "resource": "Email Signups",
46
47
  "description": "Showing an email signup content",
47
48
  "route": "/api/storefront/email_signups",
48
- "explanation": " This endpoint will return all relevant data for showing an email\n sign up form.\n",
49
+ "explanation": "<p>This endpoint will return all relevant data for showing an email<br>\nsign up form.</p>\n",
49
50
  "http_method": "GET"
50
51
  }
@@ -1,232 +1,248 @@
1
1
  {
2
2
  "resources": [
3
3
  {
4
- "name": "Categories",
4
+ "name": "Accounts",
5
5
  "examples": [
6
6
  {
7
- "description": "Showing a listing of categories",
8
- "link": "storefront/categories/showing_a_listing_of_categories.json",
7
+ "description": "Creating an account",
8
+ "link": "storefront/accounts/creating_an_account.json",
9
9
  "groups": "all",
10
- "route": "/api/storefront/categories",
11
- "method": "GET"
10
+ "route": "/api/storefront/account",
11
+ "method": "POST"
12
12
  },
13
13
  {
14
- "description": "Showing a category",
15
- "link": "storefront/categories/showing_a_category.json",
14
+ "description": "Getting account details",
15
+ "link": "storefront/accounts/getting_account_details.json",
16
16
  "groups": "all",
17
- "route": "/api/storefront/categories/:slug",
17
+ "route": "/api/storefront/account",
18
18
  "method": "GET"
19
+ },
20
+ {
21
+ "description": "Updating an account",
22
+ "link": "storefront/accounts/updating_an_account.json",
23
+ "groups": "all",
24
+ "route": "/api/storefront/account",
25
+ "method": "POST"
19
26
  }
20
27
  ]
21
28
  },
22
29
  {
23
- "name": "Recent views",
30
+ "name": "Analytics",
24
31
  "examples": [
25
32
  {
26
- "description": "Updating recent views with authentication",
27
- "link": "storefront/recent_views/updating_recent_views_with_authentication.json",
33
+ "description": "Saving a search",
34
+ "link": "storefront/analytics/saving_a_search.json",
28
35
  "groups": "all",
29
- "route": "/api/storefront/recent_views",
30
- "method": "PATCH"
36
+ "route": "/api/storefront/analytics/search",
37
+ "method": "POST"
31
38
  },
32
39
  {
33
- "description": "Showing recent views from authentication",
34
- "link": "storefront/recent_views/showing_recent_views_from_authentication.json",
40
+ "description": "saving a category view",
41
+ "link": "storefront/analytics/saving_a_category_view.json",
35
42
  "groups": "all",
36
- "route": "/api/storefront/recent_views",
37
- "method": "GET"
43
+ "route": "/api/storefront/analytics/category_view/:category_id",
44
+ "method": "POST"
38
45
  },
39
46
  {
40
- "description": "Showing recent views with a session_id",
41
- "link": "storefront/recent_views/showing_recent_views_with_a_session_id.json",
47
+ "description": "saving a product view",
48
+ "link": "storefront/analytics/saving_a_product_view.json",
42
49
  "groups": "all",
43
- "route": "/api/storefront/recent_views",
44
- "method": "GET"
45
- },
50
+ "route": "/api/storefront/analytics/product_view/:product_id",
51
+ "method": "POST"
52
+ }
53
+ ]
54
+ },
55
+ {
56
+ "name": "Assets",
57
+ "examples": [
46
58
  {
47
- "description": "Updating recent views with a session_id",
48
- "link": "storefront/recent_views/updating_recent_views_with_a_session_id.json",
59
+ "description": "Showing an asset",
60
+ "link": "storefront/assets/showing_an_asset.json",
49
61
  "groups": "all",
50
- "route": "/api/storefront/recent_views",
51
- "method": "PATCH"
62
+ "route": "/api/storefront/assets/:id",
63
+ "method": "GET"
52
64
  }
53
65
  ]
54
66
  },
55
67
  {
56
- "name": "Checkout",
68
+ "name": "Authentication",
57
69
  "examples": [
58
70
  {
59
- "description": "Updating a checkout",
60
- "link": "storefront/checkout/updating_a_checkout.json",
71
+ "description": "Creating an authentication token",
72
+ "link": "storefront/authentication/creating_an_authentication_token.json",
61
73
  "groups": "all",
62
- "route": "/api/storefront/checkouts/:id",
63
- "method": "PATCH"
74
+ "route": "/api/storefront/authentication_tokens",
75
+ "method": "POST"
64
76
  },
65
77
  {
66
- "description": "Completing a checkout",
67
- "link": "storefront/checkout/completing_a_checkout.json",
78
+ "description": "Refreshing an authentication token",
79
+ "link": "storefront/authentication/refreshing_an_authentication_token.json",
68
80
  "groups": "all",
69
- "route": "/api/storefront/checkouts/:id/complete",
70
- "method": "POST"
81
+ "route": "/api/storefront/authentication_tokens",
82
+ "method": "PATCH"
71
83
  },
72
84
  {
73
- "description": "Showing a checkout",
74
- "link": "storefront/checkout/showing_a_checkout.json",
85
+ "description": "Using an authentication token",
86
+ "link": "storefront/authentication/using_an_authentication_token.json",
75
87
  "groups": "all",
76
- "route": "/api/storefront/checkouts/:id/reset",
88
+ "route": "/api/storefront/account",
77
89
  "method": "GET"
78
90
  }
79
91
  ]
80
92
  },
81
93
  {
82
- "name": "System Content",
94
+ "name": "Cart",
83
95
  "examples": [
84
96
  {
85
- "description": "Showing system content",
86
- "link": "storefront/system_content/showing_system_content.json",
97
+ "description": "Adding a promo code",
98
+ "link": "storefront/cart/adding_a_promo_code.json",
87
99
  "groups": "all",
88
- "route": "/api/storefront/system_content/:name",
89
- "method": "GET"
100
+ "route": "/api/storefront/carts/:id/add_promo_code",
101
+ "method": "POST"
90
102
  },
91
103
  {
92
- "description": "Showing the home page",
93
- "link": "storefront/system_content/showing_the_home_page.json",
104
+ "description": "Adding an item",
105
+ "link": "storefront/cart/adding_an_item.json",
94
106
  "groups": "all",
95
- "route": "/api/storefront/system_content/home_page",
96
- "method": "GET"
97
- }
98
- ]
99
- },
100
- {
101
- "name": "Email Signups",
102
- "examples": [
107
+ "route": "/api/storefront/carts/:cart_id/items",
108
+ "method": "POST"
109
+ },
103
110
  {
104
- "description": "Creating an email signup",
105
- "link": "storefront/email_signups/creating_an_email_signup.json",
111
+ "description": "Creating a new cart for a user",
112
+ "link": "storefront/cart/creating_a_new_cart_for_a_user.json",
106
113
  "groups": "all",
107
- "route": "/api/storefront/email_signups",
114
+ "route": "/api/storefront/carts",
108
115
  "method": "POST"
109
116
  },
110
117
  {
111
- "description": "Showing an email signup content",
112
- "link": "storefront/email_signups/showing_an_email_signup_content.json",
118
+ "description": "Creating a new guest cart",
119
+ "link": "storefront/cart/creating_a_new_guest_cart.json",
113
120
  "groups": "all",
114
- "route": "/api/storefront/email_signups",
115
- "method": "GET"
116
- }
117
- ]
118
- },
119
- {
120
- "name": "Searches",
121
- "examples": [
121
+ "route": "/api/storefront/carts",
122
+ "method": "POST"
123
+ },
122
124
  {
123
- "description": "Showing search autocomplete suggestions",
124
- "link": "storefront/searches/showing_search_autocomplete_suggestions.json",
125
+ "description": "Delete an item",
126
+ "link": "storefront/cart/delete_an_item.json",
125
127
  "groups": "all",
126
- "route": "/api/storefront/searches",
128
+ "route": "/api/storefront/carts/:cart_id/items/:id",
129
+ "method": "DELETE"
130
+ },
131
+ {
132
+ "description": "Listing user's carts",
133
+ "link": "storefront/cart/listing_user_s_carts.json",
134
+ "groups": "all",
135
+ "route": "/api/storefront/carts",
127
136
  "method": "GET"
128
137
  },
129
138
  {
130
- "description": "Showing search results",
131
- "link": "storefront/searches/showing_search_results.json",
139
+ "description": "Showing cart",
140
+ "link": "storefront/cart/showing_cart.json",
132
141
  "groups": "all",
133
- "route": "/api/storefront/search",
142
+ "route": "/api/storefront/carts/:id",
134
143
  "method": "GET"
144
+ },
145
+ {
146
+ "description": "Updating an item",
147
+ "link": "storefront/cart/updating_an_item.json",
148
+ "groups": "all",
149
+ "route": "/api/storefront/carts/:cart_id/items/:id",
150
+ "method": "PATCH"
135
151
  }
136
152
  ]
137
153
  },
138
154
  {
139
- "name": "Accounts",
155
+ "name": "Categories",
140
156
  "examples": [
141
157
  {
142
- "description": "Getting account details",
143
- "link": "storefront/accounts/getting_account_details.json",
158
+ "description": "Showing a category",
159
+ "link": "storefront/categories/showing_a_category.json",
144
160
  "groups": "all",
145
- "route": "/api/storefront/account",
161
+ "route": "/api/storefront/categories/:slug",
146
162
  "method": "GET"
147
163
  },
148
164
  {
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",
165
+ "description": "Showing a listing of categories",
166
+ "link": "storefront/categories/showing_a_listing_of_categories.json",
158
167
  "groups": "all",
159
- "route": "/api/storefront/account",
160
- "method": "POST"
168
+ "route": "/api/storefront/categories",
169
+ "method": "GET"
161
170
  }
162
171
  ]
163
172
  },
164
173
  {
165
- "name": "Menus",
174
+ "name": "Checkout",
166
175
  "examples": [
167
176
  {
168
- "description": "Showing a menu",
169
- "link": "storefront/menus/showing_a_menu.json",
177
+ "description": "Completing a checkout",
178
+ "link": "storefront/checkout/completing_a_checkout.json",
170
179
  "groups": "all",
171
- "route": "/api/storefront/menus/:id",
172
- "method": "GET"
180
+ "route": "/api/storefront/checkouts/:id/complete",
181
+ "method": "POST"
173
182
  },
174
183
  {
175
- "description": "Listing menus",
176
- "link": "storefront/menus/listing_menus.json",
184
+ "description": "Showing a checkout",
185
+ "link": "storefront/checkout/showing_a_checkout.json",
177
186
  "groups": "all",
178
- "route": "/api/storefront/menus",
187
+ "route": "/api/storefront/checkouts/:id",
179
188
  "method": "GET"
189
+ },
190
+ {
191
+ "description": "Updating a checkout",
192
+ "link": "storefront/checkout/updating_a_checkout.json",
193
+ "groups": "all",
194
+ "route": "/api/storefront/checkouts/:id",
195
+ "method": "PATCH"
180
196
  }
181
197
  ]
182
198
  },
183
199
  {
184
- "name": "Password Resets",
200
+ "name": "Contacts",
185
201
  "examples": [
186
202
  {
187
- "description": "Sending a forgot password email",
188
- "link": "storefront/password_resets/sending_a_forgot_password_email.json",
203
+ "description": "Creating a contact",
204
+ "link": "storefront/contacts/creating_a_contact.json",
189
205
  "groups": "all",
190
- "route": "/api/storefront/password_resets",
206
+ "route": "/api/storefront/contacts",
191
207
  "method": "POST"
192
208
  }
193
209
  ]
194
210
  },
195
211
  {
196
- "name": "Authentication",
212
+ "name": "Email Signups",
197
213
  "examples": [
198
214
  {
199
- "description": "Creating an authentication token",
200
- "link": "storefront/authentication/creating_an_authentication_token.json",
215
+ "description": "Creating an email signup",
216
+ "link": "storefront/email_signups/creating_an_email_signup.json",
201
217
  "groups": "all",
202
- "route": "/api/storefront/authentication_tokens",
218
+ "route": "/api/storefront/email_signups",
203
219
  "method": "POST"
204
220
  },
205
221
  {
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",
222
+ "description": "Showing an email signup content",
223
+ "link": "storefront/email_signups/showing_an_email_signup_content.json",
215
224
  "groups": "all",
216
- "route": "/api/storefront/account",
225
+ "route": "/api/storefront/email_signups",
217
226
  "method": "GET"
218
227
  }
219
228
  ]
220
229
  },
221
230
  {
222
- "name": "Contacts",
231
+ "name": "Menus",
223
232
  "examples": [
224
233
  {
225
- "description": "Creating a contact",
226
- "link": "storefront/contacts/creating_a_contact.json",
234
+ "description": "Listing menus",
235
+ "link": "storefront/menus/listing_menus.json",
227
236
  "groups": "all",
228
- "route": "/api/storefront/contacts",
229
- "method": "POST"
237
+ "route": "/api/storefront/menus",
238
+ "method": "GET"
239
+ },
240
+ {
241
+ "description": "Showing a menu",
242
+ "link": "storefront/menus/showing_a_menu.json",
243
+ "groups": "all",
244
+ "route": "/api/storefront/menus/:id",
245
+ "method": "GET"
230
246
  }
231
247
  ]
232
248
  },
@@ -234,17 +250,17 @@
234
250
  "name": "Orders",
235
251
  "examples": [
236
252
  {
237
- "description": "Showing an order",
238
- "link": "storefront/orders/showing_an_order.json",
253
+ "description": "Listing the user's orders",
254
+ "link": "storefront/orders/listing_the_user_s_orders.json",
239
255
  "groups": "all",
240
- "route": "/api/storefront/orders/:id",
256
+ "route": "/api/storefront/orders",
241
257
  "method": "GET"
242
258
  },
243
259
  {
244
- "description": "Listing the user's orders",
245
- "link": "storefront/orders/listing_the_user_s_orders.json",
260
+ "description": "Showing an order",
261
+ "link": "storefront/orders/showing_an_order.json",
246
262
  "groups": "all",
247
- "route": "/api/storefront/orders",
263
+ "route": "/api/storefront/orders/:id",
248
264
  "method": "GET"
249
265
  }
250
266
  ]
@@ -261,6 +277,18 @@
261
277
  }
262
278
  ]
263
279
  },
280
+ {
281
+ "name": "Password Resets",
282
+ "examples": [
283
+ {
284
+ "description": "Sending a forgot password email",
285
+ "link": "storefront/password_resets/sending_a_forgot_password_email.json",
286
+ "groups": "all",
287
+ "route": "/api/storefront/password_resets",
288
+ "method": "POST"
289
+ }
290
+ ]
291
+ },
264
292
  {
265
293
  "name": "Personalized Recommendations",
266
294
  "examples": [
@@ -281,232 +309,190 @@
281
309
  ]
282
310
  },
283
311
  {
284
- "name": "Saved Addresses",
312
+ "name": "Products",
285
313
  "examples": [
286
314
  {
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",
315
+ "description": "Showing a product",
316
+ "link": "storefront/products/showing_a_product.json",
303
317
  "groups": "all",
304
- "route": "/api/storefront/saved_addresses",
318
+ "route": "/api/storefront/products/:slug",
305
319
  "method": "GET"
306
320
  },
307
321
  {
308
- "description": "Showing a saved address",
309
- "link": "storefront/saved_addresses/showing_a_saved_address.json",
322
+ "description": "Showing a product with a specific SKU selected",
323
+ "link": "storefront/products/showing_a_product_with_a_specific_sku_selected.json",
310
324
  "groups": "all",
311
- "route": "/api/storefront/saved_addresses/:id",
325
+ "route": "/api/storefront/products/:slug",
312
326
  "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
327
  }
321
328
  ]
322
329
  },
323
330
  {
324
- "name": "Assets",
331
+ "name": "Recent views",
325
332
  "examples": [
326
333
  {
327
- "description": "Showing an asset",
328
- "link": "storefront/assets/showing_an_asset.json",
334
+ "description": "Showing recent views from authentication",
335
+ "link": "storefront/recent_views/showing_recent_views_from_authentication.json",
329
336
  "groups": "all",
330
- "route": "/api/storefront/assets/:id",
337
+ "route": "/api/storefront/recent_views",
331
338
  "method": "GET"
332
- }
333
- ]
334
- },
335
- {
336
- "name": "Validation Errors",
337
- "examples": [
339
+ },
338
340
  {
339
- "description": "Checkout validation errors",
340
- "link": "storefront/validation_errors/checkout_validation_errors.json",
341
+ "description": "Showing recent views with a session_id",
342
+ "link": "storefront/recent_views/showing_recent_views_with_a_session_id.json",
341
343
  "groups": "all",
342
- "route": "/api/storefront/checkouts/:id",
344
+ "route": "/api/storefront/recent_views",
345
+ "method": "GET"
346
+ },
347
+ {
348
+ "description": "Updating recent views with a session_id",
349
+ "link": "storefront/recent_views/updating_recent_views_with_a_session_id.json",
350
+ "groups": "all",
351
+ "route": "/api/storefront/recent_views",
343
352
  "method": "PATCH"
344
353
  },
345
354
  {
346
- "description": "General validation errors",
347
- "link": "storefront/validation_errors/general_validation_errors.json",
355
+ "description": "Updating recent views with authentication",
356
+ "link": "storefront/recent_views/updating_recent_views_with_authentication.json",
348
357
  "groups": "all",
349
- "route": "/api/storefront/account",
350
- "method": "POST"
358
+ "route": "/api/storefront/recent_views",
359
+ "method": "PATCH"
351
360
  }
352
361
  ]
353
362
  },
354
363
  {
355
- "name": "Analytics",
364
+ "name": "Saved Addresses",
356
365
  "examples": [
357
366
  {
358
- "description": "Saving a search abandonment",
359
- "link": "storefront/analytics/saving_a_search_abandonment.json",
367
+ "description": "Creating a saved address",
368
+ "link": "storefront/saved_addresses/creating_a_saved_address.json",
360
369
  "groups": "all",
361
- "route": "/api/storefront/analytics/search_abandonment",
370
+ "route": "/api/storefront/saved_addresses",
362
371
  "method": "POST"
363
372
  },
364
373
  {
365
- "description": "saving a category view",
366
- "link": "storefront/analytics/saving_a_category_view.json",
374
+ "description": "Deleting a saved address",
375
+ "link": "storefront/saved_addresses/deleting_a_saved_address.json",
367
376
  "groups": "all",
368
- "route": "/api/storefront/analytics/category_view/:category_id",
369
- "method": "POST"
377
+ "route": "/api/storefront/saved_addresses/:id",
378
+ "method": "DELETE"
370
379
  },
371
380
  {
372
- "description": "saving a product view",
373
- "link": "storefront/analytics/saving_a_product_view.json",
381
+ "description": "Listing the user's saved addresses",
382
+ "link": "storefront/saved_addresses/listing_the_user_s_saved_addresses.json",
374
383
  "groups": "all",
375
- "route": "/api/storefront/analytics/product_view/:product_id",
376
- "method": "POST"
384
+ "route": "/api/storefront/saved_addresses",
385
+ "method": "GET"
377
386
  },
378
387
  {
379
- "description": "Saving a search",
380
- "link": "storefront/analytics/saving_a_search.json",
388
+ "description": "Showing a saved address",
389
+ "link": "storefront/saved_addresses/showing_a_saved_address.json",
381
390
  "groups": "all",
382
- "route": "/api/storefront/analytics/search",
383
- "method": "POST"
391
+ "route": "/api/storefront/saved_addresses/:id",
392
+ "method": "GET"
384
393
  },
385
394
  {
386
- "description": "Saving filters",
387
- "link": "storefront/analytics/saving_filters.json",
395
+ "description": "Updating a saved address",
396
+ "link": "storefront/saved_addresses/updating_a_saved_address.json",
388
397
  "groups": "all",
389
- "route": "/api/storefront/analytics/filters",
390
- "method": "POST"
398
+ "route": "/api/storefront/saved_addresses/:id",
399
+ "method": "PATCH"
391
400
  }
392
401
  ]
393
402
  },
394
403
  {
395
- "name": "Cart",
404
+ "name": "Saved Credit Cards",
396
405
  "examples": [
397
406
  {
398
- "description": "Creating a new cart for a user",
399
- "link": "storefront/cart/creating_a_new_cart_for_a_user.json",
407
+ "description": "Creating a saved credit card",
408
+ "link": "storefront/saved_credit_cards/creating_a_saved_credit_card.json",
400
409
  "groups": "all",
401
- "route": "/api/storefront/carts",
410
+ "route": "/api/storefront/saved_credit_cards",
402
411
  "method": "POST"
403
412
  },
404
413
  {
405
- "description": "Showing cart",
406
- "link": "storefront/cart/showing_cart.json",
414
+ "description": "Deleting a saved credit card",
415
+ "link": "storefront/saved_credit_cards/deleting_a_saved_credit_card.json",
407
416
  "groups": "all",
408
- "route": "/api/storefront/carts/:id",
409
- "method": "GET"
417
+ "route": "/api/storefront/saved_credit_cards/:id",
418
+ "method": "DELETE"
410
419
  },
411
420
  {
412
- "description": "Listing user's carts",
413
- "link": "storefront/cart/listing_user_s_carts.json",
421
+ "description": "Listing the user's saved credit cards",
422
+ "link": "storefront/saved_credit_cards/listing_the_user_s_saved_credit_cards.json",
414
423
  "groups": "all",
415
- "route": "/api/storefront/carts",
424
+ "route": "/api/storefront/saved_credit_cards",
416
425
  "method": "GET"
417
426
  },
418
427
  {
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",
428
+ "description": "Showing a saved credit card",
429
+ "link": "storefront/saved_credit_cards/showing_a_saved_credit_card.json",
435
430
  "groups": "all",
436
- "route": "/api/storefront/carts",
437
- "method": "POST"
431
+ "route": "/api/storefront/saved_credit_cards/:id",
432
+ "method": "GET"
438
433
  },
439
434
  {
440
- "description": "Updating an item",
441
- "link": "storefront/cart/updating_an_item.json",
435
+ "description": "Updating a saved credit card",
436
+ "link": "storefront/saved_credit_cards/updating_a_saved_credit_card.json",
442
437
  "groups": "all",
443
- "route": "/api/storefront/carts/:cart_id/items/:id",
438
+ "route": "/api/storefront/saved_credit_cards/:id",
444
439
  "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
440
  }
453
441
  ]
454
442
  },
455
443
  {
456
- "name": "Products",
444
+ "name": "Searches",
457
445
  "examples": [
458
446
  {
459
- "description": "Showing a product with a specific SKU selected",
460
- "link": "storefront/products/showing_a_product_with_a_specific_sku_selected.json",
447
+ "description": "Showing search autocomplete suggestions",
448
+ "link": "storefront/searches/showing_search_autocomplete_suggestions.json",
461
449
  "groups": "all",
462
- "route": "/api/storefront/products/:slug",
450
+ "route": "/api/storefront/searches",
463
451
  "method": "GET"
464
452
  },
465
453
  {
466
- "description": "Showing a product",
467
- "link": "storefront/products/showing_a_product.json",
454
+ "description": "Showing search results",
455
+ "link": "storefront/searches/showing_search_results.json",
468
456
  "groups": "all",
469
- "route": "/api/storefront/products/:slug",
457
+ "route": "/api/storefront/search",
470
458
  "method": "GET"
471
459
  }
472
460
  ]
473
461
  },
474
462
  {
475
- "name": "Saved Credit Cards",
463
+ "name": "Segmentation",
476
464
  "examples": [
477
465
  {
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",
466
+ "description": "Specifying session count for segmentation",
467
+ "link": "storefront/segmentation/specifying_session_count_for_segmentation.json",
487
468
  "groups": "all",
488
- "route": "/api/storefront/saved_credit_cards/:id",
469
+ "route": "/api/storefront/system_content/home_page",
489
470
  "method": "GET"
490
471
  },
491
472
  {
492
- "description": "Creating a saved credit card",
493
- "link": "storefront/saved_credit_cards/creating_a_saved_credit_card.json",
473
+ "description": "Using session IDs for segmenting non-authenticated users",
474
+ "link": "storefront/segmentation/using_session_ids_for_segmenting_non_authenticated_users.json",
494
475
  "groups": "all",
495
- "route": "/api/storefront/saved_credit_cards",
496
- "method": "POST"
497
- },
476
+ "route": "/api/storefront/system_content/home_page",
477
+ "method": "GET"
478
+ }
479
+ ]
480
+ },
481
+ {
482
+ "name": "System Content",
483
+ "examples": [
498
484
  {
499
- "description": "Deleting a saved credit card",
500
- "link": "storefront/saved_credit_cards/deleting_a_saved_credit_card.json",
485
+ "description": "Showing system content",
486
+ "link": "storefront/system_content/showing_system_content.json",
501
487
  "groups": "all",
502
- "route": "/api/storefront/saved_credit_cards/:id",
503
- "method": "DELETE"
488
+ "route": "/api/storefront/system_content/:name",
489
+ "method": "GET"
504
490
  },
505
491
  {
506
- "description": "Listing the user's saved credit cards",
507
- "link": "storefront/saved_credit_cards/listing_the_user_s_saved_credit_cards.json",
492
+ "description": "Showing the home page",
493
+ "link": "storefront/system_content/showing_the_home_page.json",
508
494
  "groups": "all",
509
- "route": "/api/storefront/saved_credit_cards",
495
+ "route": "/api/storefront/system_content/home_page",
510
496
  "method": "GET"
511
497
  }
512
498
  ]
@@ -522,6 +508,25 @@
522
508
  "method": "GET"
523
509
  }
524
510
  ]
511
+ },
512
+ {
513
+ "name": "Validation Errors",
514
+ "examples": [
515
+ {
516
+ "description": "Checkout validation errors",
517
+ "link": "storefront/validation_errors/checkout_validation_errors.json",
518
+ "groups": "all",
519
+ "route": "/api/storefront/checkouts/:id",
520
+ "method": "PATCH"
521
+ },
522
+ {
523
+ "description": "General validation errors",
524
+ "link": "storefront/validation_errors/general_validation_errors.json",
525
+ "groups": "all",
526
+ "route": "/api/storefront/account",
527
+ "method": "POST"
528
+ }
529
+ ]
525
530
  }
526
531
  ]
527
532
  }