workarea-api 4.4.7 → 4.5.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (330) 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 +97 -7
  8. data/Gemfile +1 -2
  9. data/README.md +14 -1
  10. data/Rakefile +18 -8
  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/recommendation_settings_controller.rb +1 -1
  29. data/admin/app/controllers/workarea/api/admin/redirects_controller.rb +7 -0
  30. data/admin/app/controllers/workarea/api/admin/releases_controller.rb +7 -0
  31. data/admin/app/controllers/workarea/api/admin/shipping_services_controller.rb +7 -0
  32. data/admin/app/controllers/workarea/api/admin/shippings_controller.rb +7 -0
  33. data/admin/app/controllers/workarea/api/admin/swagger_controller.rb +33 -0
  34. data/admin/app/controllers/workarea/api/admin/tax_categories_controller.rb +2 -0
  35. data/admin/app/controllers/workarea/api/admin/users_controller.rb +28 -14
  36. data/admin/app/models/workarea/api/admin/date_filtering.rb +27 -0
  37. data/admin/lib/workarea/api/admin/engine.rb +11 -0
  38. data/admin/test/documentation/workarea/api/admin/email_signups_documentation_test.rb +14 -2
  39. data/admin/test/documentation/workarea/api/admin/global_functionality_documentation_test.rb +140 -0
  40. data/admin/test/documentation/workarea/api/admin/orders_documentation_test.rb +13 -6
  41. data/admin/test/documentation/workarea/api/admin/users_documentation_test.rb +14 -2
  42. data/admin/test/dummy/config/initializers/session_store.rb +3 -1
  43. data/admin/test/integration/workarea/api/admin/categories_integration_test.rb +32 -0
  44. data/admin/test/integration/workarea/api/admin/content_assets_integration_test.rb +32 -0
  45. data/admin/test/integration/workarea/api/admin/content_integration_test.rb +32 -0
  46. data/admin/test/integration/workarea/api/admin/discounts_integration_test.rb +32 -0
  47. data/admin/test/integration/workarea/api/admin/email_signups_integration_test.rb +38 -1
  48. data/admin/test/integration/workarea/api/admin/fulfillments_integration_test.rb +22 -0
  49. data/admin/test/integration/workarea/api/admin/inventory_skus_integration_test.rb +32 -0
  50. data/admin/test/integration/workarea/api/admin/navigation_menus_integration_test.rb +32 -0
  51. data/admin/test/integration/workarea/api/admin/navigation_taxons_integration_test.rb +32 -0
  52. data/admin/test/integration/workarea/api/admin/orders_integration_test.rb +41 -2
  53. data/admin/test/integration/workarea/api/admin/pages_integration_test.rb +32 -0
  54. data/admin/test/integration/workarea/api/admin/payment_profiles_integration_test.rb +32 -0
  55. data/admin/test/integration/workarea/api/admin/payment_transactions_integration_test.rb +32 -0
  56. data/admin/test/integration/workarea/api/admin/payments_integration_test.rb +32 -0
  57. data/admin/test/integration/workarea/api/admin/pricing_skus_integration_test.rb +32 -0
  58. data/admin/test/integration/workarea/api/admin/products_integration_test.rb +35 -0
  59. data/admin/test/integration/workarea/api/admin/promo_code_lists_integration_test.rb +31 -0
  60. data/admin/test/integration/workarea/api/admin/recommendation_settings_integration_test.rb +14 -0
  61. data/admin/test/integration/workarea/api/admin/redirects_integration_test.rb +31 -0
  62. data/admin/test/integration/workarea/api/admin/releases_integration_test.rb +31 -0
  63. data/admin/test/integration/workarea/api/admin/shipping_services_integration_test.rb +31 -0
  64. data/admin/test/integration/workarea/api/admin/shippings_integration_test.rb +31 -0
  65. data/admin/test/integration/workarea/api/admin/tax_categories_integration_test.rb +31 -0
  66. data/admin/test/integration/workarea/api/admin/users_integration_test.rb +44 -1
  67. data/admin/workarea-api-admin.gemspec +2 -2
  68. data/app/views/workarea/api/docs/nav.haml +12 -0
  69. data/doc/api/admin/categories/bulk_upserting_categories.json +8 -4
  70. data/doc/api/admin/categories/creating_a_category.json +11 -8
  71. data/doc/api/admin/categories/listing_categories.json +8 -5
  72. data/doc/api/admin/categories/removing_a_category.json +8 -4
  73. data/doc/api/admin/categories/showing_a_category.json +10 -7
  74. data/doc/api/admin/categories/updating_a_category.json +9 -5
  75. data/doc/api/admin/category_product_rules/creating_a_category_product_rule.json +11 -8
  76. data/doc/api/admin/category_product_rules/listing_category_product_rules.json +10 -7
  77. data/doc/api/admin/category_product_rules/removing_a_category_product_rule.json +8 -4
  78. data/doc/api/admin/category_product_rules/updating_a_category_product_rule.json +8 -4
  79. data/doc/api/admin/content/bulk_upserting_content.json +8 -4
  80. data/doc/api/admin/content/creating_content.json +11 -8
  81. data/doc/api/admin/content/listing_content.json +8 -5
  82. data/doc/api/admin/content/showing_content.json +10 -7
  83. data/doc/api/admin/content/updating_content.json +8 -4
  84. data/doc/api/admin/content_assets/bulk_upserting_content_assets.json +8 -4
  85. data/doc/api/admin/content_assets/creating_a_content_asset.json +11 -8
  86. data/doc/api/admin/content_assets/listing_content_assets.json +8 -5
  87. data/doc/api/admin/content_assets/removing_a_content_asset.json +8 -4
  88. data/doc/api/admin/content_assets/showing_a_content_asset.json +10 -7
  89. data/doc/api/admin/content_assets/updating_a_content_asset.json +9 -5
  90. data/doc/api/admin/discounts/creating_a_discount.json +11 -8
  91. data/doc/api/admin/discounts/listing_discounts.json +8 -5
  92. data/doc/api/admin/discounts/removing_a_discount.json +8 -4
  93. data/doc/api/admin/discounts/showing_a_discount.json +10 -7
  94. data/doc/api/admin/discounts/updating_discounts.json +8 -4
  95. data/doc/api/admin/email_signups/listing_email_signups.json +7 -4
  96. data/doc/api/admin/email_signups/showing_an_email_signup.json +10 -12
  97. data/doc/api/admin/email_signups/showing_an_email_signup_by_email.json +47 -0
  98. data/doc/api/admin/email_signups/showing_an_email_signup_by_id.json +47 -0
  99. data/doc/api/admin/fulfillment/listing_fulfillments.json +7 -4
  100. data/doc/api/admin/fulfillment/marking_items_as_canceled.json +9 -6
  101. data/doc/api/admin/fulfillment/marking_items_as_shipped.json +9 -6
  102. data/doc/api/admin/fulfillment/showing_fulfillment.json +7 -4
  103. data/doc/api/admin/global_functionality/dealing_with_locales.json +86 -0
  104. data/doc/api/admin/global_functionality/filtering_by_created_at_time_stamp.json +56 -0
  105. data/doc/api/admin/global_functionality/filtering_by_updated_time_stamp.json +56 -0
  106. data/doc/api/admin/global_functionality/paging_results.json +51 -0
  107. data/doc/api/admin/global_functionality/retrieving_addtional_pages_of_results.json +51 -0
  108. data/doc/api/admin/global_functionality/sorting_results.json +56 -0
  109. data/doc/api/admin/index.json +653 -578
  110. data/doc/api/admin/inventory_skus/bulk_upserting_inventory_skus.json +8 -4
  111. data/doc/api/admin/inventory_skus/creating_an_inventory_sku.json +9 -6
  112. data/doc/api/admin/inventory_skus/listing_inventory_skus.json +7 -4
  113. data/doc/api/admin/inventory_skus/removing_an_inventory_sku.json +6 -2
  114. data/doc/api/admin/inventory_skus/showing_an_inventory_sku.json +7 -4
  115. data/doc/api/admin/inventory_skus/updating_an_inventory_sku.json +6 -2
  116. data/doc/api/admin/navigation_menus/creating_a_menu.json +11 -8
  117. data/doc/api/admin/navigation_menus/listing_menus.json +8 -5
  118. data/doc/api/admin/navigation_menus/removing_a_navigation_menu.json +8 -4
  119. data/doc/api/admin/navigation_menus/showing_a_navigation_menu.json +10 -7
  120. data/doc/api/admin/navigation_menus/updating_a_navigation_menus.json +8 -4
  121. data/doc/api/admin/navigation_taxonomy/bulk_upserting_navigation_taxons.json +8 -4
  122. data/doc/api/admin/navigation_taxonomy/creating_a_taxon.json +10 -7
  123. data/doc/api/admin/navigation_taxonomy/listing_taxons.json +7 -4
  124. data/doc/api/admin/navigation_taxonomy/removing_a_navigation_taxon.json +8 -4
  125. data/doc/api/admin/navigation_taxonomy/showing_a_navigation_taxon.json +9 -6
  126. data/doc/api/admin/navigation_taxonomy/updating_a_navigation_taxons.json +8 -4
  127. data/doc/api/admin/orders/listing_orders.json +8 -5
  128. data/doc/api/admin/orders/showing_an_order.json +8 -5
  129. data/doc/api/admin/orders/viewing_orders_by_date_range.json +17 -9
  130. data/doc/api/admin/pages/bulk_upserting_pages.json +8 -4
  131. data/doc/api/admin/pages/creating_a_page.json +11 -8
  132. data/doc/api/admin/pages/listing_pages.json +8 -5
  133. data/doc/api/admin/pages/removing_a_page.json +8 -4
  134. data/doc/api/admin/pages/showing_a_page.json +10 -7
  135. data/doc/api/admin/pages/updating_a_page.json +9 -5
  136. data/doc/api/admin/payment_profiles/bulk_upserting_payment_profiles.json +8 -4
  137. data/doc/api/admin/payment_profiles/creating_a_payment_profile.json +10 -7
  138. data/doc/api/admin/payment_profiles/listing_payment_profiles.json +7 -4
  139. data/doc/api/admin/payment_profiles/removing_a_payment_profile.json +8 -4
  140. data/doc/api/admin/payment_profiles/showing_a_payment_profile.json +9 -6
  141. data/doc/api/admin/payment_profiles/updating_a_payment_profiles.json +8 -4
  142. data/doc/api/admin/payment_transactions/listing_payment_transactions.json +7 -4
  143. data/doc/api/admin/payment_transactions/showing_a_payment_transaction.json +9 -6
  144. data/doc/api/admin/payments/listing_payments.json +7 -4
  145. data/doc/api/admin/payments/showing_an_payment.json +7 -4
  146. data/doc/api/admin/prices/creating_a_pricing_sku_price.json +8 -5
  147. data/doc/api/admin/prices/listing_pricing_sku_prices.json +8 -5
  148. data/doc/api/admin/prices/removing_a_pricing_sku_price.json +8 -4
  149. data/doc/api/admin/prices/updating_a_pricing_sku_price.json +8 -4
  150. data/doc/api/admin/pricing_skus/bulk_upserting_pricing_skus.json +8 -4
  151. data/doc/api/admin/pricing_skus/creating_an_pricing_sku.json +10 -7
  152. data/doc/api/admin/pricing_skus/listing_pricing_skus.json +8 -5
  153. data/doc/api/admin/pricing_skus/removing_an_pricing_sku.json +6 -2
  154. data/doc/api/admin/pricing_skus/showing_an_pricing_sku.json +8 -5
  155. data/doc/api/admin/pricing_skus/updating_an_pricing_sku.json +6 -2
  156. data/doc/api/admin/product_images/creating_a_product_image_from_base64.json +11 -8
  157. data/doc/api/admin/product_images/creating_a_product_image_from_url.json +11 -8
  158. data/doc/api/admin/product_images/listing_product_images.json +10 -7
  159. data/doc/api/admin/product_images/removing_a_product_image.json +8 -4
  160. data/doc/api/admin/product_images/updating_a_product_image.json +8 -4
  161. data/doc/api/admin/products/bulk_upserting_products.json +8 -4
  162. data/doc/api/admin/products/creating_a_product.json +11 -8
  163. data/doc/api/admin/products/listing_products.json +8 -5
  164. data/doc/api/admin/products/removing_a_product.json +8 -4
  165. data/doc/api/admin/products/showing_a_product.json +10 -7
  166. data/doc/api/admin/products/updating_a_product.json +9 -5
  167. data/doc/api/admin/promo_code_lists/bulk_upserting_promo_code_lists.json +8 -4
  168. data/doc/api/admin/promo_code_lists/creating_a_promo_code_list.json +10 -7
  169. data/doc/api/admin/promo_code_lists/listing_promo_code_lists.json +7 -4
  170. data/doc/api/admin/promo_code_lists/removing_a_promo_code_list.json +8 -4
  171. data/doc/api/admin/promo_code_lists/showing_a_promo_code_list.json +9 -6
  172. data/doc/api/admin/promo_code_lists/updating_a_promo_code_list.json +8 -4
  173. data/doc/api/admin/recommendation_settings/showing_recommendation_settings.json +9 -6
  174. data/doc/api/admin/recommendation_settings/updating_recommendation_settings.json +8 -4
  175. data/doc/api/admin/redirects/bulk_upserting_redirects.json +8 -4
  176. data/doc/api/admin/redirects/creating_a_redirect.json +10 -7
  177. data/doc/api/admin/redirects/listing_redirects.json +7 -4
  178. data/doc/api/admin/redirects/removing_a_redirect.json +8 -4
  179. data/doc/api/admin/redirects/showing_a_redirect.json +9 -6
  180. data/doc/api/admin/redirects/updating_a_redirects.json +8 -4
  181. data/doc/api/admin/release_changes/adding_changes_to_a_release.json +10 -6
  182. data/doc/api/admin/releases/bulk_upserting_releases.json +8 -4
  183. data/doc/api/admin/releases/creating_a_release.json +11 -8
  184. data/doc/api/admin/releases/listing_releases.json +8 -5
  185. data/doc/api/admin/releases/removing_a_release.json +8 -4
  186. data/doc/api/admin/releases/showing_a_release.json +10 -7
  187. data/doc/api/admin/releases/updating_a_release.json +9 -5
  188. data/doc/api/admin/saved_addresses/creating_a_saved_address.json +10 -7
  189. data/doc/api/admin/saved_addresses/listing_saved_address.json +9 -6
  190. data/doc/api/admin/saved_addresses/removing_a_saved_address.json +8 -4
  191. data/doc/api/admin/saved_addresses/updating_a_saved_address.json +8 -4
  192. data/doc/api/admin/saved_credit_cards/creating_a_saved_credit_card.json +11 -8
  193. data/doc/api/admin/saved_credit_cards/listing_saved_credit_cards.json +9 -6
  194. data/doc/api/admin/saved_credit_cards/removing_a_saved_credit_card.json +8 -4
  195. data/doc/api/admin/saved_credit_cards/updating_a_saved_credit_card.json +8 -4
  196. data/doc/api/admin/shipping/listing_shipments.json +7 -4
  197. data/doc/api/admin/shipping/showing_a_shipment.json +9 -6
  198. data/doc/api/admin/shipping_rates/creating_a_shipping_rate.json +10 -7
  199. data/doc/api/admin/shipping_rates/listing_shipping_rates.json +9 -6
  200. data/doc/api/admin/shipping_rates/removing_a_shipping_rate.json +8 -4
  201. data/doc/api/admin/shipping_rates/updating_a_shipping_rate.json +8 -4
  202. data/doc/api/admin/shipping_services/bulk_upserting_shipping_services.json +8 -4
  203. data/doc/api/admin/shipping_services/creating_a_shipping_service.json +10 -7
  204. data/doc/api/admin/shipping_services/listing_shipping_services.json +7 -4
  205. data/doc/api/admin/shipping_services/removing_a_shipping_service.json +8 -4
  206. data/doc/api/admin/shipping_services/showing_a_shipping_service.json +10 -7
  207. data/doc/api/admin/shipping_services/updating_a_shipping_service.json +9 -5
  208. data/doc/api/admin/tax_categories/bulk_upserting_tax_categories.json +8 -4
  209. data/doc/api/admin/tax_categories/creating_a_tax_category.json +10 -7
  210. data/doc/api/admin/tax_categories/listing_tax_categories.json +8 -5
  211. data/doc/api/admin/tax_categories/removing_a_tax_category.json +8 -4
  212. data/doc/api/admin/tax_categories/showing_a_tax_category.json +10 -7
  213. data/doc/api/admin/tax_categories/updating_a_tax_categories.json +8 -4
  214. data/doc/api/admin/tax_rates/creating_a_tax_rate.json +12 -9
  215. data/doc/api/admin/tax_rates/listing_tax_rates.json +10 -7
  216. data/doc/api/admin/tax_rates/removing_a_tax_rate.json +8 -4
  217. data/doc/api/admin/tax_rates/updating_a_tax_rate.json +8 -4
  218. data/doc/api/admin/users/bulk_upserting_users.json +8 -4
  219. data/doc/api/admin/users/creating_a_user.json +11 -8
  220. data/doc/api/admin/users/listing_users.json +8 -5
  221. data/doc/api/admin/users/removing_a_user.json +8 -4
  222. data/doc/api/admin/users/showing_a_user.json +10 -12
  223. data/doc/api/admin/users/showing_a_user_by_email.json +47 -0
  224. data/doc/api/admin/users/showing_a_user_by_id.json +47 -0
  225. data/doc/api/admin/users/updating_a_user.json +9 -5
  226. data/doc/api/admin/variants/creating_a_product_variant.json +11 -8
  227. data/doc/api/admin/variants/listing_product_variants.json +10 -7
  228. data/doc/api/admin/variants/removing_a_product_variant.json +8 -4
  229. data/doc/api/admin/variants/updating_a_product_variant.json +8 -4
  230. data/doc/api/storefront/accounts/creating_an_account.json +8 -7
  231. data/doc/api/storefront/accounts/getting_account_details.json +9 -8
  232. data/doc/api/storefront/accounts/updating_an_account.json +9 -8
  233. data/doc/api/storefront/analytics/saving_a_category_view.json +19 -6
  234. data/doc/api/storefront/analytics/saving_a_product_view.json +19 -6
  235. data/doc/api/storefront/analytics/saving_a_search.json +19 -6
  236. data/doc/api/storefront/assets/showing_an_asset.json +10 -9
  237. data/doc/api/storefront/authentication/creating_an_authentication_token.json +10 -9
  238. data/doc/api/storefront/authentication/refreshing_an_authentication_token.json +10 -9
  239. data/doc/api/storefront/authentication/using_an_authentication_token.json +11 -10
  240. data/doc/api/storefront/cart/adding_a_promo_code.json +11 -10
  241. data/doc/api/storefront/cart/adding_an_item.json +11 -10
  242. data/doc/api/storefront/cart/creating_a_new_cart_for_a_user.json +10 -9
  243. data/doc/api/storefront/cart/creating_a_new_guest_cart.json +8 -7
  244. data/doc/api/storefront/cart/delete_an_item.json +11 -10
  245. data/doc/api/storefront/cart/listing_user_s_carts.json +10 -9
  246. data/doc/api/storefront/cart/showing_cart.json +11 -10
  247. data/doc/api/storefront/cart/updating_an_item.json +11 -10
  248. data/doc/api/storefront/categories/showing_a_category.json +9 -8
  249. data/doc/api/storefront/categories/showing_a_listing_of_categories.json +9 -8
  250. data/doc/api/storefront/checkout/completing_a_checkout.json +11 -10
  251. data/doc/api/storefront/checkout/failure_to_update_a_checkout.json +52 -0
  252. data/doc/api/storefront/checkout/showing_a_checkout.json +11 -10
  253. data/doc/api/storefront/checkout/updating_a_checkout.json +10 -9
  254. data/doc/api/storefront/contacts/creating_a_contact.json +8 -7
  255. data/doc/api/storefront/email_signups/creating_an_email_signup.json +8 -7
  256. data/doc/api/storefront/email_signups/showing_an_email_signup_content.json +8 -7
  257. data/doc/api/storefront/index.json +269 -257
  258. data/doc/api/storefront/menus/listing_menus.json +9 -8
  259. data/doc/api/storefront/menus/showing_a_menu.json +11 -10
  260. data/doc/api/storefront/orders/listing_the_user_s_orders.json +10 -9
  261. data/doc/api/storefront/orders/showing_an_order.json +11 -10
  262. data/doc/api/storefront/pages/showing_a_page.json +9 -8
  263. data/doc/api/storefront/password_resets/sending_a_forgot_password_email.json +9 -7
  264. data/doc/api/storefront/personalized_recommendations/showing_recommendations_with_a_session_id.json +11 -11
  265. data/doc/api/storefront/personalized_recommendations/showing_recommendations_with_authentication.json +11 -10
  266. data/doc/api/storefront/products/showing_a_product.json +9 -8
  267. data/doc/api/storefront/products/showing_a_product_with_a_specific_sku_selected.json +9 -8
  268. data/doc/api/storefront/recent_views/showing_recent_views_from_authentication.json +11 -10
  269. data/doc/api/storefront/recent_views/showing_recent_views_with_a_session_id.json +12 -12
  270. data/doc/api/storefront/recent_views/updating_recent_views_with_a_session_id.json +7 -5
  271. data/doc/api/storefront/recent_views/updating_recent_views_with_authentication.json +9 -7
  272. data/doc/api/storefront/saved_addresses/creating_a_saved_address.json +8 -7
  273. data/doc/api/storefront/saved_addresses/deleting_a_saved_address.json +8 -6
  274. data/doc/api/storefront/saved_addresses/listing_the_user_s_saved_addresses.json +10 -9
  275. data/doc/api/storefront/saved_addresses/showing_a_saved_address.json +9 -8
  276. data/doc/api/storefront/saved_addresses/updating_a_saved_address.json +9 -8
  277. data/doc/api/storefront/saved_credit_cards/creating_a_saved_credit_card.json +9 -8
  278. data/doc/api/storefront/saved_credit_cards/deleting_a_saved_credit_card.json +8 -6
  279. data/doc/api/storefront/saved_credit_cards/listing_the_user_s_saved_credit_cards.json +10 -9
  280. data/doc/api/storefront/saved_credit_cards/showing_a_saved_credit_card.json +9 -8
  281. data/doc/api/storefront/saved_credit_cards/updating_a_saved_credit_card.json +10 -9
  282. data/doc/api/storefront/searches/showing_search_autocomplete_suggestions.json +10 -9
  283. data/doc/api/storefront/searches/showing_search_results.json +9 -8
  284. data/doc/api/storefront/segmentation/specifying_session_count_for_segmentation.json +93 -0
  285. data/doc/api/storefront/segmentation/using_session_ids_for_segmenting_non_authenticated_users.json +93 -0
  286. data/doc/api/storefront/system_content/showing_system_content.json +9 -8
  287. data/doc/api/storefront/system_content/showing_the_home_page.json +9 -8
  288. data/doc/api/storefront/taxons/showing_a_taxon.json +11 -10
  289. data/doc/api/storefront/validation_errors/checkout_validation_errors.json +12 -11
  290. data/doc/api/storefront/validation_errors/general_validation_errors.json +5 -4
  291. data/lib/tasks/docs.rake +20 -0
  292. data/lib/workarea/api/documentation_test.rb +10 -1
  293. data/lib/workarea/api/version.rb +1 -1
  294. data/storefront/app/controllers/workarea/api/storefront/analytics_controller.rb +31 -19
  295. data/storefront/app/controllers/workarea/api/storefront/application_controller.rb +15 -2
  296. data/storefront/app/controllers/workarea/api/storefront/authentication.rb +6 -9
  297. data/storefront/app/controllers/workarea/api/storefront/categories_controller.rb +3 -1
  298. data/storefront/app/controllers/workarea/api/storefront/checkouts_controller.rb +0 -1
  299. data/storefront/app/controllers/workarea/api/storefront/menus_controller.rb +3 -1
  300. data/storefront/app/controllers/workarea/api/storefront/pages_controller.rb +3 -1
  301. data/storefront/app/controllers/workarea/api/storefront/products_controller.rb +3 -1
  302. data/storefront/app/controllers/workarea/api/storefront/recent_views_controller.rb +13 -26
  303. data/storefront/app/controllers/workarea/api/storefront/recommendations_controller.rb +2 -8
  304. data/storefront/app/controllers/workarea/api/storefront/searches_controller.rb +0 -12
  305. data/storefront/app/views/workarea/api/storefront/categories/show.json.jbuilder +1 -1
  306. data/storefront/app/views/workarea/api/storefront/email_signups/show.json.jbuilder +1 -1
  307. data/storefront/app/views/workarea/api/storefront/menus/_menu.json.jbuilder +1 -1
  308. data/storefront/app/views/workarea/api/storefront/pages/show.json.jbuilder +1 -1
  309. data/storefront/app/views/workarea/api/storefront/recent_views/show.json.jbuilder +0 -1
  310. data/storefront/app/views/workarea/api/storefront/searches/show.json.jbuilder +1 -1
  311. data/storefront/app/views/workarea/api/storefront/system_content/show.json.jbuilder +1 -1
  312. data/storefront/config/initializers/config.rb +19 -0
  313. data/storefront/lib/workarea/api/storefront.rb +1 -0
  314. data/storefront/lib/workarea/api/storefront/visit.decorator +52 -0
  315. data/storefront/test/documentation/workarea/api/storefront/checkouts_documentation_test.rb +21 -0
  316. data/storefront/test/documentation/workarea/api/storefront/segmentation_documentation_test.rb +104 -0
  317. data/storefront/test/documentation/workarea/api/storefront/validation_documentation_test.rb +1 -1
  318. data/storefront/test/dummy/config/initializers/session_store.rb +3 -1
  319. data/storefront/test/integration/workarea/api/storefront/analytics_integration_test.rb +12 -7
  320. data/storefront/test/integration/workarea/api/storefront/recent_views_integration_test.rb +38 -33
  321. data/storefront/test/integration/workarea/api/storefront/recommendations_integration_test.rb +1 -1
  322. data/storefront/test/integration/workarea/api/storefront/searches_integration_test.rb +0 -36
  323. data/storefront/test/integration/workarea/api/storefront/segments_integration_test.rb +218 -0
  324. data/storefront/workarea-api-storefront.gemspec +2 -2
  325. data/workarea-api.gemspec +1 -1
  326. metadata +32 -13
  327. data/doc/api/storefront/analytics/saving_a_search_abandonment.json +0 -38
  328. data/doc/api/storefront/analytics/saving_filters.json +0 -38
  329. data/storefront/app/controllers/workarea/api/storefront/user_activity.rb +0 -36
  330. data/storefront/app/view_models/workarea/api/storefront/search_suggestion_view_model.rb +0 -21
@@ -36,6 +36,11 @@ module Workarea
36
36
  key :default, 'desc'
37
37
  end
38
38
 
39
+ parameter :updated_at_starts_at
40
+ parameter :updated_at_ends_at
41
+ parameter :created_at_starts_at
42
+ parameter :created_at_ends_at
43
+
39
44
  response 200 do
40
45
  key :description, 'Fulfillments'
41
46
  schema do
@@ -54,9 +59,9 @@ module Workarea
54
59
  def index
55
60
  @fulfillments = Fulfillment
56
61
  .all
62
+ .by_updated_at(starts_at: params[:updated_at_starts_at], ends_at: params[:updated_at_ends_at])
57
63
  .order_by(sort_field => sort_direction)
58
64
  .page(params[:page])
59
-
60
65
  respond_with fulfillments: @fulfillments
61
66
  end
62
67
 
@@ -36,6 +36,11 @@ module Workarea
36
36
  key :default, 'desc'
37
37
  end
38
38
 
39
+ parameter :updated_at_starts_at
40
+ parameter :updated_at_ends_at
41
+ parameter :created_at_starts_at
42
+ parameter :created_at_ends_at
43
+
39
44
  response 200 do
40
45
  key :description, 'Inventory SKUs'
41
46
  schema do
@@ -97,6 +102,8 @@ module Workarea
97
102
  def index
98
103
  @inventory_skus = Inventory::Sku
99
104
  .all
105
+ .by_updated_at(starts_at: params[:updated_at_starts_at], ends_at: params[:updated_at_ends_at])
106
+ .by_created_at(starts_at: params[:created_at_starts_at], ends_at: params[:created_at_ends_at])
100
107
  .order_by(sort_field => sort_direction)
101
108
  .page(params[:page])
102
109
 
@@ -36,6 +36,11 @@ module Workarea
36
36
  key :default, 'desc'
37
37
  end
38
38
 
39
+ parameter :updated_at_starts_at
40
+ parameter :updated_at_ends_at
41
+ parameter :created_at_starts_at
42
+ parameter :created_at_ends_at
43
+
39
44
  response 200 do
40
45
  key :description, 'Navigation Menus'
41
46
  schema do
@@ -97,6 +102,8 @@ module Workarea
97
102
  def index
98
103
  @navigation_menus = Navigation::Menu
99
104
  .all
105
+ .by_updated_at(starts_at: params[:updated_at_starts_at], ends_at: params[:updated_at_ends_at])
106
+ .by_created_at(starts_at: params[:created_at_starts_at], ends_at: params[:created_at_ends_at])
100
107
  .order_by(sort_field => sort_direction)
101
108
  .page(params[:page])
102
109
 
@@ -36,6 +36,11 @@ module Workarea
36
36
  key :default, 'desc'
37
37
  end
38
38
 
39
+ parameter :updated_at_starts_at
40
+ parameter :updated_at_ends_at
41
+ parameter :created_at_starts_at
42
+ parameter :created_at_ends_at
43
+
39
44
  response 200 do
40
45
  key :description, 'Navigation taxons'
41
46
  schema do
@@ -97,6 +102,8 @@ module Workarea
97
102
  def index
98
103
  @navigation_taxons = Navigation::Taxon
99
104
  .all
105
+ .by_updated_at(starts_at: params[:updated_at_starts_at], ends_at: params[:updated_at_ends_at])
106
+ .by_created_at(starts_at: params[:created_at_starts_at], ends_at: params[:created_at_ends_at])
100
107
  .order_by(sort_field => sort_direction)
101
108
  .page(params[:page])
102
109
 
@@ -47,6 +47,18 @@ module Workarea
47
47
  key :type, :string
48
48
  key :format, 'date-time'
49
49
  end
50
+ parameter do
51
+ key :name, :email
52
+ key :in, :query
53
+ key :description, 'Email address associated to the orders'
54
+ key :required, false
55
+ key :type, :integer
56
+ end
57
+
58
+ parameter :updated_at_starts_at
59
+ parameter :updated_at_ends_at
60
+ parameter :created_at_starts_at
61
+ parameter :created_at_ends_at
50
62
 
51
63
  response 200 do
52
64
  key :description, 'Orders'
@@ -66,6 +78,10 @@ module Workarea
66
78
  def index
67
79
  criteria = Order.all
68
80
 
81
+ if params[:email].present?
82
+ criteria = criteria.where(email: params[:email])
83
+ end
84
+
69
85
  if params[:placed_at_greater_than].present?
70
86
  # TODO Workarea v4, rename to placed_at_starts_at
71
87
  criteria = criteria.where(:placed_at.gte => params[:placed_at_greater_than])
@@ -73,11 +89,13 @@ module Workarea
73
89
 
74
90
  if params[:placed_at_less_than].present?
75
91
  # TODO Workarea v4, rename to placed_at_ends_at
76
- criteria = criteria.where(:placed_at.lt => params[:placed_at_less_than])
92
+ criteria = criteria.where(:placed_at.lte => params[:placed_at_less_than])
77
93
  end
78
94
 
79
95
  @orders =
80
96
  criteria
97
+ .by_updated_at(starts_at: params[:updated_at_starts_at], ends_at: params[:updated_at_ends_at])
98
+ .by_created_at(starts_at: params[:created_at_starts_at], ends_at: params[:created_at_ends_at])
81
99
  .order_by(sort_field => sort_direction)
82
100
  .page(params[:page].presence || 1)
83
101
 
@@ -36,6 +36,11 @@ module Workarea
36
36
  key :default, 'desc'
37
37
  end
38
38
 
39
+ parameter :updated_at_starts_at
40
+ parameter :updated_at_ends_at
41
+ parameter :created_at_starts_at
42
+ parameter :created_at_ends_at
43
+
39
44
  response 200 do
40
45
  key :description, 'Pages'
41
46
  schema do
@@ -97,6 +102,8 @@ module Workarea
97
102
  def index
98
103
  @pages = Content::Page
99
104
  .all
105
+ .by_updated_at(starts_at: params[:updated_at_starts_at], ends_at: params[:updated_at_ends_at])
106
+ .by_created_at(starts_at: params[:created_at_starts_at], ends_at: params[:created_at_ends_at])
100
107
  .order_by(sort_field => sort_direction)
101
108
  .page(params[:page])
102
109
 
@@ -36,6 +36,11 @@ module Workarea
36
36
  key :default, 'desc'
37
37
  end
38
38
 
39
+ parameter :updated_at_starts_at
40
+ parameter :updated_at_ends_at
41
+ parameter :created_at_starts_at
42
+ parameter :created_at_ends_at
43
+
39
44
  response 200 do
40
45
  key :description, 'Payment profiles'
41
46
  schema do
@@ -97,6 +102,8 @@ module Workarea
97
102
  def index
98
103
  @payment_profiles = Payment::Profile
99
104
  .all
105
+ .by_updated_at(starts_at: params[:updated_at_starts_at], ends_at: params[:updated_at_ends_at])
106
+ .by_created_at(starts_at: params[:created_at_starts_at], ends_at: params[:created_at_ends_at])
100
107
  .order_by(sort_field => sort_direction)
101
108
  .page(params[:page])
102
109
 
@@ -34,6 +34,11 @@ module Workarea
34
34
  key :default, 'desc'
35
35
  end
36
36
 
37
+ parameter :updated_at_starts_at
38
+ parameter :updated_at_ends_at
39
+ parameter :created_at_starts_at
40
+ parameter :created_at_ends_at
41
+
37
42
  response 200 do
38
43
  key :description, 'Payment transactions'
39
44
  schema do
@@ -52,6 +57,8 @@ module Workarea
52
57
  def index
53
58
  @transactions = Payment::Transaction
54
59
  .all
60
+ .by_updated_at(starts_at: params[:updated_at_starts_at], ends_at: params[:updated_at_ends_at])
61
+ .by_created_at(starts_at: params[:created_at_starts_at], ends_at: params[:created_at_ends_at])
55
62
  .order_by(sort_field => sort_direction)
56
63
  .page(params[:page])
57
64
 
@@ -34,6 +34,11 @@ module Workarea
34
34
  key :default, 'desc'
35
35
  end
36
36
 
37
+ parameter :updated_at_starts_at
38
+ parameter :updated_at_ends_at
39
+ parameter :created_at_starts_at
40
+ parameter :created_at_ends_at
41
+
37
42
  response 200 do
38
43
  key :description, 'Payments'
39
44
  schema do
@@ -52,6 +57,8 @@ module Workarea
52
57
  def index
53
58
  @payments = Payment
54
59
  .all
60
+ .by_updated_at(starts_at: params[:updated_at_starts_at], ends_at: params[:updated_at_ends_at])
61
+ .by_created_at(starts_at: params[:created_at_starts_at], ends_at: params[:created_at_ends_at])
55
62
  .order_by(sort_field => sort_direction)
56
63
  .page(params[:page])
57
64
 
@@ -36,6 +36,11 @@ module Workarea
36
36
  key :default, 'desc'
37
37
  end
38
38
 
39
+ parameter :updated_at_starts_at
40
+ parameter :updated_at_ends_at
41
+ parameter :created_at_starts_at
42
+ parameter :created_at_ends_at
43
+
39
44
  response 200 do
40
45
  key :description, 'Pricing SKUs'
41
46
  schema do
@@ -97,6 +102,8 @@ module Workarea
97
102
  def index
98
103
  @pricing_skus = Pricing::Sku
99
104
  .all
105
+ .by_updated_at(starts_at: params[:updated_at_starts_at], ends_at: params[:updated_at_ends_at])
106
+ .by_created_at(starts_at: params[:created_at_starts_at], ends_at: params[:created_at_ends_at])
100
107
  .order_by(sort_field => sort_direction)
101
108
  .page(params[:page])
102
109
 
@@ -36,6 +36,11 @@ module Workarea
36
36
  key :default, 'desc'
37
37
  end
38
38
 
39
+ parameter :updated_at_starts_at
40
+ parameter :updated_at_ends_at
41
+ parameter :created_at_starts_at
42
+ parameter :created_at_ends_at
43
+
39
44
  response 200 do
40
45
  key :description, 'Products'
41
46
  schema do
@@ -95,10 +100,12 @@ module Workarea
95
100
  end
96
101
 
97
102
  def index
98
- @products = Catalog::Product
99
- .all
100
- .order_by(sort_field => sort_direction)
101
- .page(params[:page])
103
+ @products =
104
+ Catalog::Product.all
105
+ .by_updated_at(starts_at: params[:updated_at_starts_at], ends_at: params[:updated_at_ends_at])
106
+ .by_created_at(starts_at: params[:created_at_starts_at], ends_at: params[:created_at_ends_at])
107
+ .order_by(sort_field => sort_direction)
108
+ .page(params[:page])
102
109
 
103
110
  respond_with products: @products
104
111
  end
@@ -36,6 +36,11 @@ module Workarea
36
36
  key :default, 'desc'
37
37
  end
38
38
 
39
+ parameter :updated_at_starts_at
40
+ parameter :updated_at_ends_at
41
+ parameter :created_at_starts_at
42
+ parameter :created_at_ends_at
43
+
39
44
  response 200 do
40
45
  key :description, 'Promo code lists'
41
46
  schema do
@@ -97,6 +102,8 @@ module Workarea
97
102
  def index
98
103
  @promo_code_lists = Pricing::Discount::CodeList
99
104
  .all
105
+ .by_updated_at(starts_at: params[:updated_at_starts_at], ends_at: params[:updated_at_ends_at])
106
+ .by_created_at(starts_at: params[:created_at_starts_at], ends_at: params[:created_at_ends_at])
100
107
  .order_by(sort_field => sort_direction)
101
108
  .page(params[:page])
102
109
 
@@ -114,7 +114,7 @@ module Workarea
114
114
  private
115
115
 
116
116
  def find_recommendation_settings
117
- @recommendation_settings = Recommendation::Settings.find(params[:product_id])
117
+ @recommendation_settings = Recommendation::Settings.find_or_initialize_by(id: params[:product_id])
118
118
  end
119
119
  end
120
120
  end
@@ -36,6 +36,11 @@ module Workarea
36
36
  key :default, 'desc'
37
37
  end
38
38
 
39
+ parameter :updated_at_starts_at
40
+ parameter :updated_at_ends_at
41
+ parameter :created_at_starts_at
42
+ parameter :created_at_ends_at
43
+
39
44
  response 200 do
40
45
  key :description, 'Redirects'
41
46
  schema do
@@ -97,6 +102,8 @@ module Workarea
97
102
  def index
98
103
  @redirects = Navigation::Redirect
99
104
  .all
105
+ .by_updated_at(starts_at: params[:updated_at_starts_at], ends_at: params[:updated_at_ends_at])
106
+ .by_created_at(starts_at: params[:created_at_starts_at], ends_at: params[:created_at_ends_at])
100
107
  .order_by(sort_field => sort_direction)
101
108
  .page(params[:page])
102
109
 
@@ -36,6 +36,11 @@ module Workarea
36
36
  key :default, 'desc'
37
37
  end
38
38
 
39
+ parameter :updated_at_starts_at
40
+ parameter :updated_at_ends_at
41
+ parameter :created_at_starts_at
42
+ parameter :created_at_ends_at
43
+
39
44
  response 200 do
40
45
  key :description, 'Releases'
41
46
  schema do
@@ -97,6 +102,8 @@ module Workarea
97
102
  def index
98
103
  @releases = Release
99
104
  .all
105
+ .by_updated_at(starts_at: params[:updated_at_starts_at], ends_at: params[:updated_at_ends_at])
106
+ .by_created_at(starts_at: params[:created_at_starts_at], ends_at: params[:created_at_ends_at])
100
107
  .order_by(sort_field => sort_direction)
101
108
  .page(params[:page])
102
109
  respond_with releases: @releases
@@ -36,6 +36,11 @@ module Workarea
36
36
  key :default, 'desc'
37
37
  end
38
38
 
39
+ parameter :updated_at_starts_at
40
+ parameter :updated_at_ends_at
41
+ parameter :created_at_starts_at
42
+ parameter :created_at_ends_at
43
+
39
44
  response 200 do
40
45
  key :description, 'Shipping services'
41
46
  schema do
@@ -97,6 +102,8 @@ module Workarea
97
102
  def index
98
103
  @shipping_services = Shipping::Service
99
104
  .all
105
+ .by_updated_at(starts_at: params[:updated_at_starts_at], ends_at: params[:updated_at_ends_at])
106
+ .by_created_at(starts_at: params[:created_at_starts_at], ends_at: params[:created_at_ends_at])
100
107
  .order_by(sort_field => sort_direction)
101
108
  .page(params[:page])
102
109
 
@@ -34,6 +34,11 @@ module Workarea
34
34
  key :default, 'desc'
35
35
  end
36
36
 
37
+ parameter :updated_at_starts_at
38
+ parameter :updated_at_ends_at
39
+ parameter :created_at_starts_at
40
+ parameter :created_at_ends_at
41
+
37
42
  response 200 do
38
43
  key :description, 'Shippings'
39
44
  schema do
@@ -52,6 +57,8 @@ module Workarea
52
57
  def index
53
58
  @shippings = Shipping
54
59
  .all
60
+ .by_updated_at(starts_at: params[:updated_at_starts_at], ends_at: params[:updated_at_ends_at])
61
+ .by_created_at(starts_at: params[:created_at_starts_at], ends_at: params[:created_at_ends_at])
55
62
  .order_by(sort_field => sort_direction)
56
63
  .page(params[:page])
57
64
 
@@ -25,6 +25,39 @@ module Workarea
25
25
  key :consumes, ['application/json']
26
26
  key :produces, ['application/json']
27
27
 
28
+ # define update_at params for re-use later
29
+ parameter :updated_at_starts_at do
30
+ key :name, :updated_at_starts_at
31
+ key :in, :query
32
+ key :description, 'Starting datetime for filtering on last updated'
33
+ key :type, :string
34
+ key :format, 'date-time'
35
+ end
36
+
37
+ parameter :updated_at_ends_at do
38
+ key :name, :updated_at_ends_at
39
+ key :in, :query
40
+ key :description, 'Ending datetime for filtering on last updated'
41
+ key :type, :string
42
+ key :format, 'date-time'
43
+ end
44
+
45
+ parameter :created_at_starts_at do
46
+ key :name, :created_at_starts_at
47
+ key :in, :query
48
+ key :description, 'Starting datetime for filtering on creation date'
49
+ key :type, :string
50
+ key :format, 'date-time'
51
+ end
52
+
53
+ parameter :created_at_ends_at do
54
+ key :name, :created_at_ends_at
55
+ key :in, :query
56
+ key :description, 'Ending datetime for filtering on creation date'
57
+ key :type, :string
58
+ key :format, 'date-time'
59
+ end
60
+
28
61
  security_definition :BasicAuth do
29
62
  key :type, :basic
30
63
  end
@@ -72,6 +72,8 @@ module Workarea
72
72
  def index
73
73
  @tax_categories = Tax::Category
74
74
  .all
75
+ .by_updated_at(starts_at: params[:updated_at_starts_at], ends_at: params[:updated_at_ends_at])
76
+ .by_created_at(starts_at: params[:created_at_starts_at], ends_at: params[:created_at_ends_at])
75
77
  .order_by(sort_field => sort_direction)
76
78
  .page(params[:page])
77
79
 
@@ -36,6 +36,11 @@ module Workarea
36
36
  key :default, 'desc'
37
37
  end
38
38
 
39
+ parameter :updated_at_starts_at
40
+ parameter :updated_at_ends_at
41
+ parameter :created_at_starts_at
42
+ parameter :created_at_ends_at
43
+
39
44
  response 200 do
40
45
  key :description, 'User'
41
46
  schema do
@@ -94,12 +99,19 @@ module Workarea
94
99
  end
95
100
  end
96
101
 
97
-
98
102
  def index
99
- @users = User
100
- .all
101
- .order_by(sort_field => sort_direction)
102
- .page(params[:page])
103
+ criteria = User.all
104
+
105
+ if params[:email].present?
106
+ criteria = criteria.where(email: params[:email])
107
+ end
108
+
109
+ @users =
110
+ criteria
111
+ .by_updated_at(starts_at: params[:updated_at_starts_at], ends_at: params[:updated_at_ends_at])
112
+ .by_created_at(starts_at: params[:created_at_starts_at], ends_at: params[:created_at_ends_at])
113
+ .order_by(sort_field => sort_direction)
114
+ .page(params[:page].presence || 1)
103
115
 
104
116
  respond_with users: @users.to_a.map { |u| api_attributes_for(u) }
105
117
  end
@@ -113,17 +125,17 @@ module Workarea
113
125
  )
114
126
  end
115
127
 
116
- swagger_path '/users/{id}' do
128
+ swagger_path '/users/{id_or_email}' do
117
129
  operation :get do
118
- key :summary, 'Show User by ID'
119
- key :description, 'Returns a user by ID'
130
+ key :summary, 'Show User by ID or Email'
131
+ key :description, 'Returns a user by ID or email address'
120
132
  key :operationId, 'showUser'
121
133
  key :produces, ['application/json']
122
134
 
123
135
  parameter do
124
- key :name, :id
136
+ key :name, :id_or_email
125
137
  key :in, :path
126
- key :description, 'user ID'
138
+ key :description, 'user ID or URL escaped email address'
127
139
  key :required, true
128
140
  key :type, :string
129
141
  end
@@ -145,9 +157,9 @@ module Workarea
145
157
  key :operationId, 'updateUser'
146
158
 
147
159
  parameter do
148
- key :name, :id
160
+ key :name, :id_or_email
149
161
  key :in, :path
150
- key :description, 'ID of user to update'
162
+ key :description, 'ID or email address of user to update'
151
163
  key :required, true
152
164
  key :type, :string
153
165
  end
@@ -203,9 +215,9 @@ module Workarea
203
215
  key :operationId, 'removeUser'
204
216
 
205
217
  parameter do
206
- key :name, :id
218
+ key :name, :id_or_email
207
219
  key :in, :path
208
- key :description, 'ID of user to remove'
220
+ key :description, 'ID or email address of user to remove'
209
221
  key :required, true
210
222
  key :type, :string
211
223
  end
@@ -285,6 +297,8 @@ module Workarea
285
297
 
286
298
  def find_user
287
299
  @user = User.find(params[:id])
300
+ rescue Mongoid::Errors::DocumentNotFound
301
+ @user = User.find_by(email: URI.unescape(params[:id]))
288
302
  end
289
303
 
290
304
  def api_attributes_for(user)