workarea-api 4.4.7 → 4.5.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (311) 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 +15 -11
  8. data/Gemfile +3 -2
  9. data/README.md +13 -0
  10. data/Rakefile +14 -5
  11. data/admin/app/controllers/workarea/api/admin/categories_controller.rb +6 -0
  12. data/admin/app/controllers/workarea/api/admin/content_assets_controller.rb +6 -0
  13. data/admin/app/controllers/workarea/api/admin/content_controller.rb +6 -0
  14. data/admin/app/controllers/workarea/api/admin/discounts_controller.rb +7 -0
  15. data/admin/app/controllers/workarea/api/admin/email_signups_controller.rb +20 -4
  16. data/admin/app/controllers/workarea/api/admin/fulfillments_controller.rb +6 -1
  17. data/admin/app/controllers/workarea/api/admin/inventory_skus_controller.rb +7 -0
  18. data/admin/app/controllers/workarea/api/admin/navigation_menus_controller.rb +7 -0
  19. data/admin/app/controllers/workarea/api/admin/navigation_taxons_controller.rb +7 -0
  20. data/admin/app/controllers/workarea/api/admin/orders_controller.rb +19 -1
  21. data/admin/app/controllers/workarea/api/admin/pages_controller.rb +7 -0
  22. data/admin/app/controllers/workarea/api/admin/payment_profiles_controller.rb +7 -0
  23. data/admin/app/controllers/workarea/api/admin/payment_transactions_controller.rb +7 -0
  24. data/admin/app/controllers/workarea/api/admin/payments_controller.rb +7 -0
  25. data/admin/app/controllers/workarea/api/admin/pricing_skus_controller.rb +7 -0
  26. data/admin/app/controllers/workarea/api/admin/products_controller.rb +11 -4
  27. data/admin/app/controllers/workarea/api/admin/promo_code_lists_controller.rb +7 -0
  28. data/admin/app/controllers/workarea/api/admin/redirects_controller.rb +7 -0
  29. data/admin/app/controllers/workarea/api/admin/releases_controller.rb +7 -0
  30. data/admin/app/controllers/workarea/api/admin/shipping_services_controller.rb +7 -0
  31. data/admin/app/controllers/workarea/api/admin/shippings_controller.rb +7 -0
  32. data/admin/app/controllers/workarea/api/admin/swagger_controller.rb +33 -0
  33. data/admin/app/controllers/workarea/api/admin/tax_categories_controller.rb +2 -0
  34. data/admin/app/controllers/workarea/api/admin/users_controller.rb +28 -14
  35. data/admin/app/models/workarea/api/admin/date_filtering.rb +27 -0
  36. data/admin/lib/workarea/api/admin/engine.rb +11 -0
  37. data/admin/test/documentation/workarea/api/admin/email_signups_documentation_test.rb +14 -2
  38. data/admin/test/documentation/workarea/api/admin/global_functionality_documentation_test.rb +140 -0
  39. data/admin/test/documentation/workarea/api/admin/orders_documentation_test.rb +13 -6
  40. data/admin/test/documentation/workarea/api/admin/users_documentation_test.rb +14 -2
  41. data/admin/test/dummy/config/initializers/session_store.rb +3 -1
  42. data/admin/test/integration/workarea/api/admin/categories_integration_test.rb +32 -0
  43. data/admin/test/integration/workarea/api/admin/content_assets_integration_test.rb +32 -0
  44. data/admin/test/integration/workarea/api/admin/content_integration_test.rb +32 -0
  45. data/admin/test/integration/workarea/api/admin/discounts_integration_test.rb +32 -0
  46. data/admin/test/integration/workarea/api/admin/email_signups_integration_test.rb +38 -1
  47. data/admin/test/integration/workarea/api/admin/fulfillments_integration_test.rb +22 -0
  48. data/admin/test/integration/workarea/api/admin/inventory_skus_integration_test.rb +32 -0
  49. data/admin/test/integration/workarea/api/admin/navigation_menus_integration_test.rb +32 -0
  50. data/admin/test/integration/workarea/api/admin/navigation_taxons_integration_test.rb +32 -0
  51. data/admin/test/integration/workarea/api/admin/orders_integration_test.rb +41 -2
  52. data/admin/test/integration/workarea/api/admin/pages_integration_test.rb +32 -0
  53. data/admin/test/integration/workarea/api/admin/payment_profiles_integration_test.rb +32 -0
  54. data/admin/test/integration/workarea/api/admin/payment_transactions_integration_test.rb +32 -0
  55. data/admin/test/integration/workarea/api/admin/payments_integration_test.rb +32 -0
  56. data/admin/test/integration/workarea/api/admin/pricing_skus_integration_test.rb +32 -0
  57. data/admin/test/integration/workarea/api/admin/products_integration_test.rb +35 -0
  58. data/admin/test/integration/workarea/api/admin/promo_code_lists_integration_test.rb +31 -0
  59. data/admin/test/integration/workarea/api/admin/redirects_integration_test.rb +31 -0
  60. data/admin/test/integration/workarea/api/admin/releases_integration_test.rb +31 -0
  61. data/admin/test/integration/workarea/api/admin/shipping_services_integration_test.rb +31 -0
  62. data/admin/test/integration/workarea/api/admin/shippings_integration_test.rb +31 -0
  63. data/admin/test/integration/workarea/api/admin/tax_categories_integration_test.rb +31 -0
  64. data/admin/test/integration/workarea/api/admin/users_integration_test.rb +44 -1
  65. data/app/views/workarea/api/docs/nav.haml +12 -0
  66. data/doc/api/admin/categories/bulk_upserting_categories.json +8 -4
  67. data/doc/api/admin/categories/creating_a_category.json +11 -8
  68. data/doc/api/admin/categories/listing_categories.json +8 -5
  69. data/doc/api/admin/categories/removing_a_category.json +8 -4
  70. data/doc/api/admin/categories/showing_a_category.json +10 -7
  71. data/doc/api/admin/categories/updating_a_category.json +9 -5
  72. data/doc/api/admin/category_product_rules/creating_a_category_product_rule.json +11 -8
  73. data/doc/api/admin/category_product_rules/listing_category_product_rules.json +10 -7
  74. data/doc/api/admin/category_product_rules/removing_a_category_product_rule.json +8 -4
  75. data/doc/api/admin/category_product_rules/updating_a_category_product_rule.json +8 -4
  76. data/doc/api/admin/content/bulk_upserting_content.json +8 -4
  77. data/doc/api/admin/content/creating_content.json +11 -8
  78. data/doc/api/admin/content/listing_content.json +8 -5
  79. data/doc/api/admin/content/showing_content.json +10 -7
  80. data/doc/api/admin/content/updating_content.json +8 -4
  81. data/doc/api/admin/content_assets/bulk_upserting_content_assets.json +8 -4
  82. data/doc/api/admin/content_assets/creating_a_content_asset.json +11 -8
  83. data/doc/api/admin/content_assets/listing_content_assets.json +8 -5
  84. data/doc/api/admin/content_assets/removing_a_content_asset.json +8 -4
  85. data/doc/api/admin/content_assets/showing_a_content_asset.json +10 -7
  86. data/doc/api/admin/content_assets/updating_a_content_asset.json +9 -5
  87. data/doc/api/admin/discounts/creating_a_discount.json +11 -8
  88. data/doc/api/admin/discounts/listing_discounts.json +8 -5
  89. data/doc/api/admin/discounts/removing_a_discount.json +8 -4
  90. data/doc/api/admin/discounts/showing_a_discount.json +10 -7
  91. data/doc/api/admin/discounts/updating_discounts.json +8 -4
  92. data/doc/api/admin/email_signups/listing_email_signups.json +7 -4
  93. data/doc/api/admin/email_signups/showing_an_email_signup.json +10 -12
  94. data/doc/api/admin/fulfillment/listing_fulfillments.json +7 -4
  95. data/doc/api/admin/fulfillment/marking_items_as_canceled.json +9 -6
  96. data/doc/api/admin/fulfillment/marking_items_as_shipped.json +9 -6
  97. data/doc/api/admin/fulfillment/showing_fulfillment.json +7 -4
  98. data/doc/api/admin/index.json +653 -578
  99. data/doc/api/admin/inventory_skus/bulk_upserting_inventory_skus.json +8 -4
  100. data/doc/api/admin/inventory_skus/creating_an_inventory_sku.json +9 -6
  101. data/doc/api/admin/inventory_skus/listing_inventory_skus.json +7 -4
  102. data/doc/api/admin/inventory_skus/removing_an_inventory_sku.json +6 -2
  103. data/doc/api/admin/inventory_skus/showing_an_inventory_sku.json +7 -4
  104. data/doc/api/admin/inventory_skus/updating_an_inventory_sku.json +6 -2
  105. data/doc/api/admin/navigation_menus/creating_a_menu.json +11 -8
  106. data/doc/api/admin/navigation_menus/listing_menus.json +8 -5
  107. data/doc/api/admin/navigation_menus/removing_a_navigation_menu.json +8 -4
  108. data/doc/api/admin/navigation_menus/showing_a_navigation_menu.json +10 -7
  109. data/doc/api/admin/navigation_menus/updating_a_navigation_menus.json +8 -4
  110. data/doc/api/admin/navigation_taxonomy/bulk_upserting_navigation_taxons.json +8 -4
  111. data/doc/api/admin/navigation_taxonomy/creating_a_taxon.json +10 -7
  112. data/doc/api/admin/navigation_taxonomy/listing_taxons.json +7 -4
  113. data/doc/api/admin/navigation_taxonomy/removing_a_navigation_taxon.json +8 -4
  114. data/doc/api/admin/navigation_taxonomy/showing_a_navigation_taxon.json +9 -6
  115. data/doc/api/admin/navigation_taxonomy/updating_a_navigation_taxons.json +8 -4
  116. data/doc/api/admin/orders/listing_orders.json +8 -5
  117. data/doc/api/admin/orders/showing_an_order.json +8 -5
  118. data/doc/api/admin/pages/bulk_upserting_pages.json +8 -4
  119. data/doc/api/admin/pages/creating_a_page.json +11 -8
  120. data/doc/api/admin/pages/listing_pages.json +8 -5
  121. data/doc/api/admin/pages/removing_a_page.json +8 -4
  122. data/doc/api/admin/pages/showing_a_page.json +10 -7
  123. data/doc/api/admin/pages/updating_a_page.json +9 -5
  124. data/doc/api/admin/payment_profiles/bulk_upserting_payment_profiles.json +8 -4
  125. data/doc/api/admin/payment_profiles/creating_a_payment_profile.json +10 -7
  126. data/doc/api/admin/payment_profiles/listing_payment_profiles.json +7 -4
  127. data/doc/api/admin/payment_profiles/removing_a_payment_profile.json +8 -4
  128. data/doc/api/admin/payment_profiles/showing_a_payment_profile.json +9 -6
  129. data/doc/api/admin/payment_profiles/updating_a_payment_profiles.json +8 -4
  130. data/doc/api/admin/payment_transactions/listing_payment_transactions.json +7 -4
  131. data/doc/api/admin/payment_transactions/showing_a_payment_transaction.json +9 -6
  132. data/doc/api/admin/payments/listing_payments.json +7 -4
  133. data/doc/api/admin/payments/showing_an_payment.json +7 -4
  134. data/doc/api/admin/prices/creating_a_pricing_sku_price.json +8 -5
  135. data/doc/api/admin/prices/listing_pricing_sku_prices.json +8 -5
  136. data/doc/api/admin/prices/removing_a_pricing_sku_price.json +8 -4
  137. data/doc/api/admin/prices/updating_a_pricing_sku_price.json +8 -4
  138. data/doc/api/admin/pricing_skus/bulk_upserting_pricing_skus.json +8 -4
  139. data/doc/api/admin/pricing_skus/creating_an_pricing_sku.json +10 -7
  140. data/doc/api/admin/pricing_skus/listing_pricing_skus.json +8 -5
  141. data/doc/api/admin/pricing_skus/removing_an_pricing_sku.json +6 -2
  142. data/doc/api/admin/pricing_skus/showing_an_pricing_sku.json +8 -5
  143. data/doc/api/admin/pricing_skus/updating_an_pricing_sku.json +6 -2
  144. data/doc/api/admin/product_images/creating_a_product_image_from_base64.json +11 -8
  145. data/doc/api/admin/product_images/creating_a_product_image_from_url.json +11 -8
  146. data/doc/api/admin/product_images/listing_product_images.json +10 -7
  147. data/doc/api/admin/product_images/removing_a_product_image.json +8 -4
  148. data/doc/api/admin/product_images/updating_a_product_image.json +8 -4
  149. data/doc/api/admin/products/bulk_upserting_products.json +8 -4
  150. data/doc/api/admin/products/creating_a_product.json +11 -8
  151. data/doc/api/admin/products/listing_products.json +8 -5
  152. data/doc/api/admin/products/removing_a_product.json +8 -4
  153. data/doc/api/admin/products/showing_a_product.json +10 -7
  154. data/doc/api/admin/products/updating_a_product.json +9 -5
  155. data/doc/api/admin/promo_code_lists/bulk_upserting_promo_code_lists.json +8 -4
  156. data/doc/api/admin/promo_code_lists/creating_a_promo_code_list.json +10 -7
  157. data/doc/api/admin/promo_code_lists/listing_promo_code_lists.json +7 -4
  158. data/doc/api/admin/promo_code_lists/removing_a_promo_code_list.json +8 -4
  159. data/doc/api/admin/promo_code_lists/showing_a_promo_code_list.json +9 -6
  160. data/doc/api/admin/promo_code_lists/updating_a_promo_code_list.json +8 -4
  161. data/doc/api/admin/recommendation_settings/showing_recommendation_settings.json +9 -6
  162. data/doc/api/admin/recommendation_settings/updating_recommendation_settings.json +8 -4
  163. data/doc/api/admin/redirects/bulk_upserting_redirects.json +8 -4
  164. data/doc/api/admin/redirects/creating_a_redirect.json +10 -7
  165. data/doc/api/admin/redirects/listing_redirects.json +7 -4
  166. data/doc/api/admin/redirects/removing_a_redirect.json +8 -4
  167. data/doc/api/admin/redirects/showing_a_redirect.json +9 -6
  168. data/doc/api/admin/redirects/updating_a_redirects.json +8 -4
  169. data/doc/api/admin/release_changes/adding_changes_to_a_release.json +10 -6
  170. data/doc/api/admin/releases/bulk_upserting_releases.json +8 -4
  171. data/doc/api/admin/releases/creating_a_release.json +11 -8
  172. data/doc/api/admin/releases/listing_releases.json +8 -5
  173. data/doc/api/admin/releases/removing_a_release.json +8 -4
  174. data/doc/api/admin/releases/showing_a_release.json +10 -7
  175. data/doc/api/admin/releases/updating_a_release.json +9 -5
  176. data/doc/api/admin/saved_addresses/creating_a_saved_address.json +10 -7
  177. data/doc/api/admin/saved_addresses/listing_saved_address.json +9 -6
  178. data/doc/api/admin/saved_addresses/removing_a_saved_address.json +8 -4
  179. data/doc/api/admin/saved_addresses/updating_a_saved_address.json +8 -4
  180. data/doc/api/admin/saved_credit_cards/creating_a_saved_credit_card.json +11 -8
  181. data/doc/api/admin/saved_credit_cards/listing_saved_credit_cards.json +9 -6
  182. data/doc/api/admin/saved_credit_cards/removing_a_saved_credit_card.json +8 -4
  183. data/doc/api/admin/saved_credit_cards/updating_a_saved_credit_card.json +8 -4
  184. data/doc/api/admin/shipping/listing_shipments.json +7 -4
  185. data/doc/api/admin/shipping/showing_a_shipment.json +9 -6
  186. data/doc/api/admin/shipping_rates/creating_a_shipping_rate.json +10 -7
  187. data/doc/api/admin/shipping_rates/listing_shipping_rates.json +9 -6
  188. data/doc/api/admin/shipping_rates/removing_a_shipping_rate.json +8 -4
  189. data/doc/api/admin/shipping_rates/updating_a_shipping_rate.json +8 -4
  190. data/doc/api/admin/shipping_services/bulk_upserting_shipping_services.json +8 -4
  191. data/doc/api/admin/shipping_services/creating_a_shipping_service.json +10 -7
  192. data/doc/api/admin/shipping_services/listing_shipping_services.json +7 -4
  193. data/doc/api/admin/shipping_services/removing_a_shipping_service.json +8 -4
  194. data/doc/api/admin/shipping_services/showing_a_shipping_service.json +9 -6
  195. data/doc/api/admin/shipping_services/updating_a_shipping_service.json +9 -5
  196. data/doc/api/admin/tax_categories/bulk_upserting_tax_categories.json +8 -4
  197. data/doc/api/admin/tax_categories/creating_a_tax_category.json +10 -7
  198. data/doc/api/admin/tax_categories/listing_tax_categories.json +7 -4
  199. data/doc/api/admin/tax_categories/removing_a_tax_category.json +8 -4
  200. data/doc/api/admin/tax_categories/showing_a_tax_category.json +9 -6
  201. data/doc/api/admin/tax_categories/updating_a_tax_categories.json +8 -4
  202. data/doc/api/admin/tax_rates/creating_a_tax_rate.json +12 -9
  203. data/doc/api/admin/tax_rates/listing_tax_rates.json +10 -7
  204. data/doc/api/admin/tax_rates/removing_a_tax_rate.json +8 -4
  205. data/doc/api/admin/tax_rates/updating_a_tax_rate.json +8 -4
  206. data/doc/api/admin/users/bulk_upserting_users.json +8 -4
  207. data/doc/api/admin/users/creating_a_user.json +11 -8
  208. data/doc/api/admin/users/listing_users.json +8 -5
  209. data/doc/api/admin/users/removing_a_user.json +8 -4
  210. data/doc/api/admin/users/showing_a_user.json +10 -12
  211. data/doc/api/admin/users/updating_a_user.json +9 -5
  212. data/doc/api/admin/variants/creating_a_product_variant.json +11 -8
  213. data/doc/api/admin/variants/listing_product_variants.json +10 -7
  214. data/doc/api/admin/variants/removing_a_product_variant.json +8 -4
  215. data/doc/api/admin/variants/updating_a_product_variant.json +8 -4
  216. data/doc/api/storefront/accounts/creating_an_account.json +8 -7
  217. data/doc/api/storefront/accounts/getting_account_details.json +9 -8
  218. data/doc/api/storefront/accounts/updating_an_account.json +9 -8
  219. data/doc/api/storefront/analytics/saving_a_category_view.json +19 -6
  220. data/doc/api/storefront/analytics/saving_a_product_view.json +19 -6
  221. data/doc/api/storefront/analytics/saving_a_search.json +19 -6
  222. data/doc/api/storefront/assets/showing_an_asset.json +10 -9
  223. data/doc/api/storefront/authentication/creating_an_authentication_token.json +10 -9
  224. data/doc/api/storefront/authentication/refreshing_an_authentication_token.json +10 -9
  225. data/doc/api/storefront/authentication/using_an_authentication_token.json +11 -10
  226. data/doc/api/storefront/cart/adding_a_promo_code.json +11 -10
  227. data/doc/api/storefront/cart/adding_an_item.json +11 -10
  228. data/doc/api/storefront/cart/creating_a_new_cart_for_a_user.json +10 -9
  229. data/doc/api/storefront/cart/creating_a_new_guest_cart.json +8 -7
  230. data/doc/api/storefront/cart/delete_an_item.json +11 -10
  231. data/doc/api/storefront/cart/listing_user_s_carts.json +10 -9
  232. data/doc/api/storefront/cart/showing_cart.json +11 -10
  233. data/doc/api/storefront/cart/updating_an_item.json +11 -10
  234. data/doc/api/storefront/categories/showing_a_category.json +9 -8
  235. data/doc/api/storefront/categories/showing_a_listing_of_categories.json +9 -8
  236. data/doc/api/storefront/checkout/completing_a_checkout.json +10 -9
  237. data/doc/api/storefront/checkout/showing_a_checkout.json +11 -10
  238. data/doc/api/storefront/checkout/updating_a_checkout.json +10 -9
  239. data/doc/api/storefront/contacts/creating_a_contact.json +8 -7
  240. data/doc/api/storefront/email_signups/creating_an_email_signup.json +8 -7
  241. data/doc/api/storefront/email_signups/showing_an_email_signup_content.json +8 -7
  242. data/doc/api/storefront/index.json +263 -258
  243. data/doc/api/storefront/menus/listing_menus.json +9 -8
  244. data/doc/api/storefront/menus/showing_a_menu.json +11 -10
  245. data/doc/api/storefront/orders/listing_the_user_s_orders.json +10 -9
  246. data/doc/api/storefront/orders/showing_an_order.json +11 -10
  247. data/doc/api/storefront/pages/showing_a_page.json +9 -8
  248. data/doc/api/storefront/password_resets/sending_a_forgot_password_email.json +9 -7
  249. data/doc/api/storefront/personalized_recommendations/showing_recommendations_with_a_session_id.json +12 -12
  250. data/doc/api/storefront/personalized_recommendations/showing_recommendations_with_authentication.json +11 -10
  251. data/doc/api/storefront/products/showing_a_product.json +9 -8
  252. data/doc/api/storefront/products/showing_a_product_with_a_specific_sku_selected.json +9 -8
  253. data/doc/api/storefront/recent_views/showing_recent_views_from_authentication.json +11 -10
  254. data/doc/api/storefront/recent_views/showing_recent_views_with_a_session_id.json +12 -12
  255. data/doc/api/storefront/recent_views/updating_recent_views_with_a_session_id.json +7 -5
  256. data/doc/api/storefront/recent_views/updating_recent_views_with_authentication.json +9 -7
  257. data/doc/api/storefront/saved_addresses/creating_a_saved_address.json +8 -7
  258. data/doc/api/storefront/saved_addresses/deleting_a_saved_address.json +8 -6
  259. data/doc/api/storefront/saved_addresses/listing_the_user_s_saved_addresses.json +10 -9
  260. data/doc/api/storefront/saved_addresses/showing_a_saved_address.json +9 -8
  261. data/doc/api/storefront/saved_addresses/updating_a_saved_address.json +9 -8
  262. data/doc/api/storefront/saved_credit_cards/creating_a_saved_credit_card.json +8 -7
  263. data/doc/api/storefront/saved_credit_cards/deleting_a_saved_credit_card.json +8 -6
  264. data/doc/api/storefront/saved_credit_cards/listing_the_user_s_saved_credit_cards.json +10 -9
  265. data/doc/api/storefront/saved_credit_cards/showing_a_saved_credit_card.json +9 -8
  266. data/doc/api/storefront/saved_credit_cards/updating_a_saved_credit_card.json +9 -8
  267. data/doc/api/storefront/searches/showing_search_autocomplete_suggestions.json +10 -9
  268. data/doc/api/storefront/searches/showing_search_results.json +9 -8
  269. data/doc/api/storefront/segmentation/specifying_session_count_for_segmentation.json +93 -0
  270. data/doc/api/storefront/segmentation/using_session_ids_for_segmenting_non_authenticated_users.json +93 -0
  271. data/doc/api/storefront/system_content/showing_system_content.json +9 -8
  272. data/doc/api/storefront/system_content/showing_the_home_page.json +9 -8
  273. data/doc/api/storefront/taxons/showing_a_taxon.json +11 -10
  274. data/doc/api/storefront/validation_errors/checkout_validation_errors.json +10 -9
  275. data/doc/api/storefront/validation_errors/general_validation_errors.json +5 -4
  276. data/lib/workarea/api/documentation_test.rb +10 -1
  277. data/lib/workarea/api/version.rb +1 -1
  278. data/storefront/app/controllers/workarea/api/storefront/analytics_controller.rb +31 -19
  279. data/storefront/app/controllers/workarea/api/storefront/application_controller.rb +15 -2
  280. data/storefront/app/controllers/workarea/api/storefront/authentication.rb +6 -9
  281. data/storefront/app/controllers/workarea/api/storefront/categories_controller.rb +3 -1
  282. data/storefront/app/controllers/workarea/api/storefront/checkouts_controller.rb +0 -1
  283. data/storefront/app/controllers/workarea/api/storefront/menus_controller.rb +3 -1
  284. data/storefront/app/controllers/workarea/api/storefront/pages_controller.rb +3 -1
  285. data/storefront/app/controllers/workarea/api/storefront/products_controller.rb +3 -1
  286. data/storefront/app/controllers/workarea/api/storefront/recent_views_controller.rb +13 -26
  287. data/storefront/app/controllers/workarea/api/storefront/recommendations_controller.rb +2 -8
  288. data/storefront/app/controllers/workarea/api/storefront/searches_controller.rb +0 -12
  289. data/storefront/app/views/workarea/api/storefront/categories/show.json.jbuilder +1 -1
  290. data/storefront/app/views/workarea/api/storefront/email_signups/show.json.jbuilder +1 -1
  291. data/storefront/app/views/workarea/api/storefront/menus/_menu.json.jbuilder +1 -1
  292. data/storefront/app/views/workarea/api/storefront/pages/show.json.jbuilder +1 -1
  293. data/storefront/app/views/workarea/api/storefront/recent_views/show.json.jbuilder +0 -1
  294. data/storefront/app/views/workarea/api/storefront/searches/show.json.jbuilder +1 -1
  295. data/storefront/app/views/workarea/api/storefront/system_content/show.json.jbuilder +1 -1
  296. data/storefront/config/initializers/config.rb +19 -0
  297. data/storefront/lib/workarea/api/storefront/visit.decorator +52 -0
  298. data/storefront/lib/workarea/api/storefront.rb +1 -0
  299. data/storefront/test/documentation/workarea/api/storefront/segmentation_documentation_test.rb +104 -0
  300. data/storefront/test/dummy/config/initializers/session_store.rb +3 -1
  301. data/storefront/test/integration/workarea/api/storefront/analytics_integration_test.rb +12 -7
  302. data/storefront/test/integration/workarea/api/storefront/recent_views_integration_test.rb +38 -33
  303. data/storefront/test/integration/workarea/api/storefront/recommendations_integration_test.rb +1 -1
  304. data/storefront/test/integration/workarea/api/storefront/searches_integration_test.rb +0 -36
  305. data/storefront/test/integration/workarea/api/storefront/segments_integration_test.rb +218 -0
  306. metadata +18 -12
  307. data/doc/api/admin/orders/viewing_orders_by_date_range.json +0 -68
  308. data/doc/api/storefront/analytics/saving_a_search_abandonment.json +0 -38
  309. data/doc/api/storefront/analytics/saving_filters.json +0 -38
  310. data/storefront/app/controllers/workarea/api/storefront/user_activity.rb +0 -36
  311. 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/\"f450e6bbed16875fe3c684da0efe644c\"",
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": "75a39e38-3b5b-43e1-8725-6cbb633d1729",
31
- "X-Runtime": "0.009484",
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\": \"5d5ecba1d4322a04dfbf7be3\",\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
- "http_method": "POST",
50
- "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",
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/\"0751e079ab614d2b7c3d88d04ee2dfc7\"",
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": "f49c7cf8-b415-46c3-a61c-62745596c4c5",
30
- "X-Runtime": "0.008116",
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\": \"5d5ecba1d4322a04dfbf7be6\",\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_5d5ecba1d4322a04dfbf7be6\\\" data-analytics=\\\"{&quot;event&quot;:&quot;contentBlockDisplay&quot;,&quot;payload&quot;:{&quot;id&quot;:&quot;5d5ecba1d4322a04dfbf7be6&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
- "http_method": "GET",
49
- "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",
50
+ "http_method": "GET"
50
51
  }