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
@@ -13,7 +13,7 @@
13
13
  "request_headers": {
14
14
  },
15
15
  "request_query_parameters": {
16
- "session_id": "5d5dbce8d4322a4b69d78abe"
16
+ "session_id": "5dddc9381241596aa520535e"
17
17
  },
18
18
  "response_headers": {
19
19
  "X-Frame-Options": "SAMEORIGIN",
@@ -22,34 +22,34 @@
22
22
  "X-Download-Options": "noopen",
23
23
  "X-Permitted-Cross-Domain-Policies": "none",
24
24
  "Referrer-Policy": "strict-origin-when-cross-origin",
25
- "ETag": "W/\"c56862219af4b78d184d572cbad80055\"",
26
- "Last-Modified": "Wed, 21 Aug 2019 21:51:36 GMT",
27
25
  "Content-Type": "application/json; charset=utf-8",
28
26
  "Access-Control-Allow-Origin": "*",
29
27
  "Access-Control-Allow-Headers": "*",
30
28
  "Access-Control-Allow-Methods": "GET, POST, PATCH, PUT, DELETE, OPTIONS",
31
29
  "X-Requested-With": "",
32
- "Vary": "X-Requested-With, X-Flash-Messages",
30
+ "Vary": "X-Requested-With, X-Workarea-Segments",
31
+ "Last-Modified": "Wed, 27 Nov 2019 00:54:16 GMT",
33
32
  "Cache-Control": "no-cache, no-store, must-revalidate",
34
- "X-Request-Id": "66585531-d1a7-4360-b9b2-58754bd0a2f0",
35
- "X-Runtime": "0.016571",
33
+ "X-Request-Id": "a7c18061-996d-422a-984e-907c855d9eff",
34
+ "X-Runtime": "0.004423",
35
+ "X-Workarea-Segments": "",
36
36
  "Expires": "0",
37
- "Content-Length": "849"
37
+ "Content-Length": "63"
38
38
  },
39
39
  "request_method": "GET",
40
- "request_path": "/api/storefront/recent_views?session_id=5d5dbce8d4322a4b69d78abe",
40
+ "request_path": "/api/storefront/recent_views?session_id=5dddc9381241596aa520535e",
41
41
  "request_body": null,
42
42
  "request_content_type": null,
43
43
  "response_status": 200,
44
44
  "response_status_text": "OK",
45
- "response_body": "{\n \"id\": \"5d5dbce8d4322a4b69d78abe\",\n \"categories\": [\n {\n \"id\": \"5d5dbce8d4322a4b69d78abb\",\n \"name\": \"Shirts\",\n \"slug\": \"shirts\",\n \"url\": \"http://www.example.com/api/storefront/categories/shirts\"\n }\n ],\n \"products\": [\n {\n \"id\": \"0B136C73A7\",\n \"name\": \"Cool Shirt\",\n \"description\": null,\n \"slug\": \"cool-shirt\",\n \"browser_title\": \"Cool Shirt\",\n \"meta_description\": null,\n \"template\": \"generic\",\n \"customizations\": null,\n \"details\": {\n \"Material\": [\n \"Cotton\"\n ],\n \"Style\": [\n \"12345\"\n ]\n },\n \"digital\": false,\n \"filters\": {\n \"Material\": \"Cotton\",\n \"Style\": \"12345\"\n },\n \"purchasable\": true,\n \"inventory_status\": \"\",\n \"variants\": [\n {\n \"id\": \"5d5dbce8d4322a4b69d78aba\",\n \"name\": \"SKU\",\n \"sku\": \"SKU\",\n \"details\": {\n }\n }\n ],\n \"sell_min_price\": null,\n \"sell_max_price\": {\n \"cents\": 500.0,\n \"currency_iso\": \"USD\"\n },\n \"on_sale\": false,\n \"original_min_price\": {\n \"cents\": 500.0,\n \"currency_iso\": \"USD\"\n },\n \"original_max_price\": {\n \"cents\": 500.0,\n \"currency_iso\": \"USD\"\n },\n \"images\": [\n\n ]\n }\n ],\n \"searches\": [\n \"shirt\"\n ]\n}",
45
+ "response_body": "{\n \"id\": \"5dddc9381241596aa520535e\",\n \"categories\": [\n\n ],\n \"products\": [\n\n ]\n}",
46
46
  "response_content_type": "application/json",
47
- "curl": "curl -g \"https://www.example.com/api/storefront/recent_views?session_id=5d5dbce8d4322a4b69d78abe\" -X GET "
47
+ "curl": "curl -g \"https://www.example.com/api/storefront/recent_views?session_id=5dddc9381241596aa520535e\" -X GET "
48
48
  }
49
49
  ],
50
50
  "resource": "Recent views",
51
51
  "description": "Showing recent views with a session_id",
52
52
  "route": "/api/storefront/recent_views",
53
- "explanation": " Display recent views based on a session_id you've kept for an\n anonymous browser (as opposed to displaying them based on\n authentication).\n",
53
+ "explanation": "<p>Display recent views based on a session_id you&#39;ve kept for an<br>\nanonymous browser (as opposed to displaying them based on<br>\nauthentication).</p>\n",
54
54
  "http_method": "GET"
55
55
  }
@@ -27,10 +27,12 @@
27
27
  "Access-Control-Allow-Headers": "*",
28
28
  "Access-Control-Allow-Methods": "GET, POST, PATCH, PUT, DELETE, OPTIONS",
29
29
  "X-Requested-With": "",
30
- "Vary": "X-Requested-With, X-Flash-Messages",
30
+ "Vary": "X-Requested-With, X-Workarea-Segments",
31
+ "Last-Modified": "Wed, 27 Nov 2019 00:54:13 GMT",
31
32
  "Cache-Control": "no-cache, no-store, must-revalidate",
32
- "X-Request-Id": "470d504d-6590-44e5-9b6a-afb932922dd2",
33
- "X-Runtime": "0.005608",
33
+ "X-Request-Id": "b95d1d93-8257-49c6-9ade-bcd4f0646eff",
34
+ "X-Runtime": "0.003037",
35
+ "X-Workarea-Segments": "",
34
36
  "Expires": "0",
35
37
  "Content-Length": "0"
36
38
  },
@@ -48,6 +50,6 @@
48
50
  "resource": "Recent views",
49
51
  "description": "Updating recent views with a session_id",
50
52
  "route": "/api/storefront/recent_views",
51
- "explanation": " You can also use this endpoint to maintain a recent activity for an\n anonymous browser. Use a consistent session_id to maintain\n continuity.\n",
53
+ "explanation": "<p>You can also use this endpoint to maintain a recent activity for an<br>\nanonymous browser. Use a consistent session_id to maintain<br>\ncontinuity.</p>\n",
52
54
  "http_method": "PATCH"
53
55
  }
@@ -9,7 +9,7 @@
9
9
  {
10
10
  "request_headers": {
11
11
  "Content-Type": "application/json",
12
- "Authorization": "Token token=\"wAmyRLpRBAzCSAbG98ZwuibF\""
12
+ "Authorization": "Token token=\"VC55s1MMqjyXK9zz9xyZ558C\""
13
13
  },
14
14
  "request_query_parameters": {
15
15
  },
@@ -25,10 +25,12 @@
25
25
  "Access-Control-Allow-Headers": "*",
26
26
  "Access-Control-Allow-Methods": "GET, POST, PATCH, PUT, DELETE, OPTIONS",
27
27
  "X-Requested-With": "",
28
- "Vary": "X-Requested-With, X-Flash-Messages",
28
+ "Vary": "X-Requested-With, X-Workarea-Segments",
29
+ "Last-Modified": "Wed, 27 Nov 2019 00:54:15 GMT",
29
30
  "Cache-Control": "no-cache, no-store, must-revalidate",
30
- "X-Request-Id": "cbfdcebe-2696-431f-8771-d9ab02d0b00c",
31
- "X-Runtime": "0.010654",
31
+ "X-Request-Id": "fd993239-b60d-46ee-896f-095bfa4e6ff7",
32
+ "X-Runtime": "0.002988",
33
+ "X-Workarea-Segments": "",
32
34
  "Expires": "0",
33
35
  "Content-Length": "0"
34
36
  },
@@ -40,12 +42,12 @@
40
42
  "response_status_text": "OK",
41
43
  "response_body": null,
42
44
  "response_content_type": "application/json",
43
- "curl": "curl \"https://www.example.com/api/storefront/recent_views\" -d '{\"product_id\":\"367A8BB9B5\",\"category_id\":\"596e739b021823358aabe9df\",\"search\":\"shirts\"}' -X PATCH \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Token token=\\\"wAmyRLpRBAzCSAbG98ZwuibF\\\"\""
45
+ "curl": "curl \"https://www.example.com/api/storefront/recent_views\" -d '{\"product_id\":\"367A8BB9B5\",\"category_id\":\"596e739b021823358aabe9df\",\"search\":\"shirts\"}' -X PATCH \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Token token=\\\"VC55s1MMqjyXK9zz9xyZ558C\\\"\""
44
46
  }
45
47
  ],
46
48
  "resource": "Recent views",
47
49
  "description": "Updating recent views with authentication",
48
50
  "route": "/api/storefront/recent_views",
49
- "explanation": " Use this endpoint like this to keep a accurate list of recent\n activity by the authenticated customer. Each of the three resources\n being tracked (products, categories, searches) are optional.\n",
51
+ "explanation": "<p>Use this endpoint like this to keep a accurate list of recent<br>\nactivity by the authenticated customer. Each of the three resources<br>\nbeing tracked (products, categories, searches) are optional.</p>\n",
50
52
  "http_method": "PATCH"
51
53
  }
@@ -9,7 +9,7 @@
9
9
  {
10
10
  "request_headers": {
11
11
  "Content-Type": "application/json",
12
- "Authorization": "Token token=\"BkxY6WafBdkUicS6iWTHM9Wv\""
12
+ "Authorization": "Token token=\"XGGFUa8TYvjGGkU8Jh1soAe7\""
13
13
  },
14
14
  "request_query_parameters": {
15
15
  },
@@ -25,11 +25,12 @@
25
25
  "Access-Control-Allow-Headers": "*",
26
26
  "Access-Control-Allow-Methods": "GET, POST, PATCH, PUT, DELETE, OPTIONS",
27
27
  "X-Requested-With": "",
28
- "Vary": "X-Requested-With, X-Flash-Messages",
29
- "ETag": "W/\"0f319cb4600ea03c12f62c502fe9318d\"",
28
+ "Vary": "X-Requested-With, X-Workarea-Segments",
29
+ "Last-Modified": "Wed, 27 Nov 2019 00:55:53 GMT",
30
30
  "Cache-Control": "no-cache, no-store, must-revalidate",
31
- "X-Request-Id": "d404217d-6398-4f94-9c2f-6f5c3a1eb260",
32
- "X-Runtime": "0.067210",
31
+ "X-Request-Id": "f2f568bf-6e8f-45cf-92a0-69c7e14e8f26",
32
+ "X-Runtime": "0.067807",
33
+ "X-Workarea-Segments": "",
33
34
  "Expires": "0",
34
35
  "Content-Length": "377"
35
36
  },
@@ -39,9 +40,9 @@
39
40
  "request_content_type": "application/json",
40
41
  "response_status": 200,
41
42
  "response_status_text": "OK",
42
- "response_body": "{\n \"user_id\": \"5d5dbcebd4322a4b69d78ad3\",\n \"url\": \"http://www.example.com/api/storefront/saved_addresses/5d5dbcebd4322a4b69d78ad7\",\n \"id\": \"5d5dbcebd4322a4b69d78ad7\",\n \"first_name\": \"Susan\",\n \"last_name\": \"Baker\",\n \"company\": null,\n \"street\": \"4059 Mt Lee Dr.\",\n \"street_2\": null,\n \"city\": \"Hollywood\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"postal_code\": \"90068\",\n \"phone_number\": \"7545552390\",\n \"phone_extension\": null\n}",
43
+ "response_body": "{\n \"user_id\": \"5dddc9981241596aa52054f8\",\n \"url\": \"http://www.example.com/api/storefront/saved_addresses/5dddc9991241596aa52054fd\",\n \"id\": \"5dddc9991241596aa52054fd\",\n \"first_name\": \"Susan\",\n \"last_name\": \"Baker\",\n \"company\": null,\n \"street\": \"4059 Mt Lee Dr.\",\n \"street_2\": null,\n \"city\": \"Hollywood\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"postal_code\": \"90068\",\n \"phone_number\": \"7545552390\",\n \"phone_extension\": null\n}",
43
44
  "response_content_type": "application/json",
44
- "curl": "curl \"https://www.example.com/api/storefront/saved_addresses\" -d '{\"first_name\":\"Susan\",\"last_name\":\"Baker\",\"street\":\"4059 Mt Lee Dr.\",\"city\":\"Hollywood\",\"region\":\"CA\",\"country\":\"US\",\"postal_code\":\"90068\",\"phone_number\":\"7545552390\"}' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Token token=\\\"BkxY6WafBdkUicS6iWTHM9Wv\\\"\""
45
+ "curl": "curl \"https://www.example.com/api/storefront/saved_addresses\" -d '{\"first_name\":\"Susan\",\"last_name\":\"Baker\",\"street\":\"4059 Mt Lee Dr.\",\"city\":\"Hollywood\",\"region\":\"CA\",\"country\":\"US\",\"postal_code\":\"90068\",\"phone_number\":\"7545552390\"}' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Token token=\\\"XGGFUa8TYvjGGkU8Jh1soAe7\\\"\""
45
46
  }
46
47
  ],
47
48
  "resource": "Saved Addresses",
@@ -9,7 +9,7 @@
9
9
  {
10
10
  "request_headers": {
11
11
  "Content-Type": "application/x-www-form-urlencoded",
12
- "Authorization": "Token token=\"H8SfGLzxxUEmFkLrk6SxFBax\""
12
+ "Authorization": "Token token=\"yEtPcSZrtU9zArYsJCWKx2PS\""
13
13
  },
14
14
  "request_query_parameters": {
15
15
  },
@@ -24,21 +24,23 @@
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",
27
+ "Vary": "X-Requested-With, X-Workarea-Segments",
28
+ "Last-Modified": "Wed, 27 Nov 2019 00:55:54 GMT",
28
29
  "Cache-Control": "no-cache, no-store, must-revalidate",
29
- "X-Request-Id": "62736dc0-d9aa-49e8-bfba-a661f1d331d2",
30
- "X-Runtime": "0.006406",
30
+ "X-Request-Id": "18931618-0dea-4738-8bcb-6ec8a2906e64",
31
+ "X-Runtime": "0.003916",
32
+ "X-Workarea-Segments": "",
31
33
  "Expires": "0"
32
34
  },
33
35
  "request_method": "DELETE",
34
- "request_path": "/api/storefront/saved_addresses/5d5dbcead4322a4b69d78acc",
36
+ "request_path": "/api/storefront/saved_addresses/5dddc99a1241596aa5205503",
35
37
  "request_body": null,
36
38
  "request_content_type": "application/x-www-form-urlencoded",
37
39
  "response_status": 204,
38
40
  "response_status_text": "No Content",
39
41
  "response_body": null,
40
42
  "response_content_type": null,
41
- "curl": "curl \"https://www.example.com/api/storefront/saved_addresses/5d5dbcead4322a4b69d78acc\" -d '' -X DELETE \\\n\t-H \"Content-Type: application/x-www-form-urlencoded\" \\\n\t-H \"Authorization: Token token=\\\"H8SfGLzxxUEmFkLrk6SxFBax\\\"\""
43
+ "curl": "curl \"https://www.example.com/api/storefront/saved_addresses/5dddc99a1241596aa5205503\" -d '' -X DELETE \\\n\t-H \"Content-Type: application/x-www-form-urlencoded\" \\\n\t-H \"Authorization: Token token=\\\"yEtPcSZrtU9zArYsJCWKx2PS\\\"\""
42
44
  }
43
45
  ],
44
46
  "resource": "Saved Addresses",
@@ -8,7 +8,7 @@
8
8
  "requests": [
9
9
  {
10
10
  "request_headers": {
11
- "Authorization": "Token token=\"E4LQGbZn2hQhMhuR841d5npM\""
11
+ "Authorization": "Token token=\"BW7ohsfkRsxwHfUakVxZBJc1\""
12
12
  },
13
13
  "request_query_parameters": {
14
14
  },
@@ -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/\"554cbff71725a67122e8807dd5e5edd8\"",
27
+ "Vary": "X-Requested-With, X-Workarea-Segments",
28
+ "Last-Modified": "Wed, 27 Nov 2019 00:55:57 GMT",
29
29
  "Cache-Control": "no-cache, no-store, must-revalidate",
30
- "X-Request-Id": "a4767cc7-3617-44b4-89fb-9441540bcb9a",
31
- "X-Runtime": "0.006550",
30
+ "X-Request-Id": "abead827-d1a4-4a39-8d35-240a8dfb1fb3",
31
+ "X-Runtime": "0.003931",
32
+ "X-Workarea-Segments": "",
32
33
  "Expires": "0",
33
34
  "Content-Length": "734"
34
35
  },
@@ -38,14 +39,14 @@
38
39
  "request_content_type": null,
39
40
  "response_status": 200,
40
41
  "response_status_text": "OK",
41
- "response_body": "{\n \"user_id\": \"5d5dbcecd4322a4b69d78ade\",\n \"addresses\": [\n {\n \"url\": \"http://www.example.com/api/storefront/saved_addresses/5d5dbcecd4322a4b69d78ae1\",\n \"id\": \"5d5dbcecd4322a4b69d78ae1\",\n \"first_name\": \"Susan\",\n \"last_name\": \"Baker\",\n \"company\": null,\n \"street\": \"350 Fifth Avenue\",\n \"street_2\": null,\n \"city\": \"New York\",\n \"country\": \"US\",\n \"region\": \"NY\",\n \"postal_code\": \"10118\",\n \"phone_number\": \"6465552390\",\n \"phone_extension\": null\n },\n {\n \"url\": \"http://www.example.com/api/storefront/saved_addresses/5d5dbcedd4322a4b69d78ae2\",\n \"id\": \"5d5dbcedd4322a4b69d78ae2\",\n \"first_name\": \"Susan\",\n \"last_name\": \"Baker\",\n \"company\": null,\n \"street\": \"4059 Mt Lee Dr.\",\n \"street_2\": null,\n \"city\": \"Hollywood\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"postal_code\": \"90068\",\n \"phone_number\": \"7545552390\",\n \"phone_extension\": null\n }\n ]\n}",
42
+ "response_body": "{\n \"user_id\": \"5dddc99d1241596aa520550b\",\n \"addresses\": [\n {\n \"url\": \"http://www.example.com/api/storefront/saved_addresses/5dddc99d1241596aa520550f\",\n \"id\": \"5dddc99d1241596aa520550f\",\n \"first_name\": \"Susan\",\n \"last_name\": \"Baker\",\n \"company\": null,\n \"street\": \"350 Fifth Avenue\",\n \"street_2\": null,\n \"city\": \"New York\",\n \"country\": \"US\",\n \"region\": \"NY\",\n \"postal_code\": \"10118\",\n \"phone_number\": \"6465552390\",\n \"phone_extension\": null\n },\n {\n \"url\": \"http://www.example.com/api/storefront/saved_addresses/5dddc99d1241596aa5205510\",\n \"id\": \"5dddc99d1241596aa5205510\",\n \"first_name\": \"Susan\",\n \"last_name\": \"Baker\",\n \"company\": null,\n \"street\": \"4059 Mt Lee Dr.\",\n \"street_2\": null,\n \"city\": \"Hollywood\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"postal_code\": \"90068\",\n \"phone_number\": \"7545552390\",\n \"phone_extension\": null\n }\n ]\n}",
42
43
  "response_content_type": "application/json",
43
- "curl": "curl -g \"https://www.example.com/api/storefront/saved_addresses\" -X GET \\\n\t-H \"Authorization: Token token=\\\"E4LQGbZn2hQhMhuR841d5npM\\\"\""
44
+ "curl": "curl -g \"https://www.example.com/api/storefront/saved_addresses\" -X GET \\\n\t-H \"Authorization: Token token=\\\"BW7ohsfkRsxwHfUakVxZBJc1\\\"\""
44
45
  }
45
46
  ],
46
47
  "resource": "Saved Addresses",
47
48
  "description": "Listing the user's saved addresses",
48
49
  "route": "/api/storefront/saved_addresses",
49
- "explanation": " List a customer's saved addresses. Useful for account management and\n for using saved addresses in checkout.\n",
50
+ "explanation": "<p>List a customer&#39;s saved addresses. Useful for account management and<br>\nfor using saved addresses in checkout.</p>\n",
50
51
  "http_method": "GET"
51
52
  }
@@ -8,7 +8,7 @@
8
8
  "requests": [
9
9
  {
10
10
  "request_headers": {
11
- "Authorization": "Token token=\"zCw1AgFNnS5Q1sb1SkZSZvL3\""
11
+ "Authorization": "Token token=\"5GQNUMpSREs8zfrHtkrRtTpF\""
12
12
  },
13
13
  "request_query_parameters": {
14
14
  },
@@ -24,23 +24,24 @@
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/\"e8d32428386ab8d2e968838007f7313b\"",
27
+ "Vary": "X-Requested-With, X-Workarea-Segments",
28
+ "Last-Modified": "Wed, 27 Nov 2019 00:55:56 GMT",
29
29
  "Cache-Control": "no-cache, no-store, must-revalidate",
30
- "X-Request-Id": "2f379e4c-2e91-4eea-97ff-383a5342bcb6",
31
- "X-Runtime": "0.006241",
30
+ "X-Request-Id": "7fe0a289-e787-4e87-b706-cfb9d27e6c71",
31
+ "X-Runtime": "0.003836",
32
+ "X-Workarea-Segments": "",
32
33
  "Expires": "0",
33
34
  "Content-Length": "377"
34
35
  },
35
36
  "request_method": "GET",
36
- "request_path": "/api/storefront/saved_addresses/5d5dbcecd4322a4b69d78adc",
37
+ "request_path": "/api/storefront/saved_addresses/5dddc99c1241596aa5205509",
37
38
  "request_body": null,
38
39
  "request_content_type": null,
39
40
  "response_status": 200,
40
41
  "response_status_text": "OK",
41
- "response_body": "{\n \"user_id\": \"5d5dbcecd4322a4b69d78ad9\",\n \"url\": \"http://www.example.com/api/storefront/saved_addresses/5d5dbcecd4322a4b69d78adc\",\n \"id\": \"5d5dbcecd4322a4b69d78adc\",\n \"first_name\": \"Susan\",\n \"last_name\": \"Baker\",\n \"company\": null,\n \"street\": \"350 Fifth Avenue\",\n \"street_2\": null,\n \"city\": \"New York\",\n \"country\": \"US\",\n \"region\": \"NY\",\n \"postal_code\": \"10118\",\n \"phone_number\": \"6465552390\",\n \"phone_extension\": null\n}",
42
+ "response_body": "{\n \"user_id\": \"5dddc99b1241596aa5205505\",\n \"url\": \"http://www.example.com/api/storefront/saved_addresses/5dddc99c1241596aa5205509\",\n \"id\": \"5dddc99c1241596aa5205509\",\n \"first_name\": \"Susan\",\n \"last_name\": \"Baker\",\n \"company\": null,\n \"street\": \"350 Fifth Avenue\",\n \"street_2\": null,\n \"city\": \"New York\",\n \"country\": \"US\",\n \"region\": \"NY\",\n \"postal_code\": \"10118\",\n \"phone_number\": \"6465552390\",\n \"phone_extension\": null\n}",
42
43
  "response_content_type": "application/json",
43
- "curl": "curl -g \"https://www.example.com/api/storefront/saved_addresses/5d5dbcecd4322a4b69d78adc\" -X GET \\\n\t-H \"Authorization: Token token=\\\"zCw1AgFNnS5Q1sb1SkZSZvL3\\\"\""
44
+ "curl": "curl -g \"https://www.example.com/api/storefront/saved_addresses/5dddc99c1241596aa5205509\" -X GET \\\n\t-H \"Authorization: Token token=\\\"5GQNUMpSREs8zfrHtkrRtTpF\\\"\""
44
45
  }
45
46
  ],
46
47
  "resource": "Saved Addresses",
@@ -9,7 +9,7 @@
9
9
  {
10
10
  "request_headers": {
11
11
  "Content-Type": "application/json",
12
- "Authorization": "Token token=\"DW3FBga4e6SNpi3Uioa3knkG\""
12
+ "Authorization": "Token token=\"FHoxyYe5QsxaYye31zkya3Vp\""
13
13
  },
14
14
  "request_query_parameters": {
15
15
  },
@@ -25,23 +25,24 @@
25
25
  "Access-Control-Allow-Headers": "*",
26
26
  "Access-Control-Allow-Methods": "GET, POST, PATCH, PUT, DELETE, OPTIONS",
27
27
  "X-Requested-With": "",
28
- "Vary": "X-Requested-With, X-Flash-Messages",
29
- "ETag": "W/\"2d646328a7ad60faf998ed30871b02f0\"",
28
+ "Vary": "X-Requested-With, X-Workarea-Segments",
29
+ "Last-Modified": "Wed, 27 Nov 2019 00:55:51 GMT",
30
30
  "Cache-Control": "no-cache, no-store, must-revalidate",
31
- "X-Request-Id": "8b20bda1-23ff-4b34-a398-f1fa01ef1bfe",
32
- "X-Runtime": "0.069961",
31
+ "X-Request-Id": "1d9aa0af-893b-4d75-a4b8-e6672e3da2e0",
32
+ "X-Runtime": "0.080268",
33
+ "X-Workarea-Segments": "",
33
34
  "Expires": "0",
34
35
  "Content-Length": "377"
35
36
  },
36
37
  "request_method": "PATCH",
37
- "request_path": "/api/storefront/saved_addresses/5d5dbcead4322a4b69d78ad1",
38
+ "request_path": "/api/storefront/saved_addresses/5dddc9971241596aa52054f6",
38
39
  "request_body": "{\"street\":\"4059 Mt Lee Dr.\",\"city\":\"Hollywood\",\"region\":\"CA\",\"postal_code\":\"90068\",\"phone_number\":\"7545552390\"}",
39
40
  "request_content_type": "application/json",
40
41
  "response_status": 200,
41
42
  "response_status_text": "OK",
42
- "response_body": "{\n \"user_id\": \"5d5dbcead4322a4b69d78ace\",\n \"url\": \"http://www.example.com/api/storefront/saved_addresses/5d5dbcead4322a4b69d78ad1\",\n \"id\": \"5d5dbcead4322a4b69d78ad1\",\n \"first_name\": \"Susan\",\n \"last_name\": \"Baker\",\n \"company\": null,\n \"street\": \"4059 Mt Lee Dr.\",\n \"street_2\": null,\n \"city\": \"Hollywood\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"postal_code\": \"90068\",\n \"phone_number\": \"7545552390\",\n \"phone_extension\": null\n}",
43
+ "response_body": "{\n \"user_id\": \"5dddc9971241596aa52054f2\",\n \"url\": \"http://www.example.com/api/storefront/saved_addresses/5dddc9971241596aa52054f6\",\n \"id\": \"5dddc9971241596aa52054f6\",\n \"first_name\": \"Susan\",\n \"last_name\": \"Baker\",\n \"company\": null,\n \"street\": \"4059 Mt Lee Dr.\",\n \"street_2\": null,\n \"city\": \"Hollywood\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"postal_code\": \"90068\",\n \"phone_number\": \"7545552390\",\n \"phone_extension\": null\n}",
43
44
  "response_content_type": "application/json",
44
- "curl": "curl \"https://www.example.com/api/storefront/saved_addresses/5d5dbcead4322a4b69d78ad1\" -d '{\"street\":\"4059 Mt Lee Dr.\",\"city\":\"Hollywood\",\"region\":\"CA\",\"postal_code\":\"90068\",\"phone_number\":\"7545552390\"}' -X PATCH \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Token token=\\\"DW3FBga4e6SNpi3Uioa3knkG\\\"\""
45
+ "curl": "curl \"https://www.example.com/api/storefront/saved_addresses/5dddc9971241596aa52054f6\" -d '{\"street\":\"4059 Mt Lee Dr.\",\"city\":\"Hollywood\",\"region\":\"CA\",\"postal_code\":\"90068\",\"phone_number\":\"7545552390\"}' -X PATCH \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Token token=\\\"FHoxyYe5QsxaYye31zkya3Vp\\\"\""
45
46
  }
46
47
  ],
47
48
  "resource": "Saved Addresses",
@@ -9,7 +9,7 @@
9
9
  {
10
10
  "request_headers": {
11
11
  "Content-Type": "application/json",
12
- "Authorization": "Token token=\"sWdWsZwAMRXqfQX53eS5QgFK\""
12
+ "Authorization": "Token token=\"rtbqstRt5B87UebHPY4SYriL\""
13
13
  },
14
14
  "request_query_parameters": {
15
15
  },
@@ -25,11 +25,12 @@
25
25
  "Access-Control-Allow-Headers": "*",
26
26
  "Access-Control-Allow-Methods": "GET, POST, PATCH, PUT, DELETE, OPTIONS",
27
27
  "X-Requested-With": "",
28
- "Vary": "X-Requested-With, X-Flash-Messages",
29
- "ETag": "W/\"d1773c960a12fbd4acdd2865535c1bf5\"",
28
+ "Vary": "X-Requested-With, X-Workarea-Segments",
29
+ "Last-Modified": "Wed, 27 Nov 2019 00:53:15 GMT",
30
30
  "Cache-Control": "no-cache, no-store, must-revalidate",
31
- "X-Request-Id": "adfb2603-9c23-468d-899a-e7cbab68c30e",
32
- "X-Runtime": "0.012313",
31
+ "X-Request-Id": "74d3bfbf-a7d2-435c-975c-c4906dac26bc",
32
+ "X-Runtime": "0.010853",
33
+ "X-Workarea-Segments": "",
33
34
  "Expires": "0",
34
35
  "Content-Length": "294"
35
36
  },
@@ -39,9 +40,9 @@
39
40
  "request_content_type": "application/json",
40
41
  "response_status": 200,
41
42
  "response_status_text": "OK",
42
- "response_body": "{\n \"user_id\": \"5d5dbd6bd4322a4b69d79092\",\n \"id\": \"5d5dbd6bd4322a4b69d79097\",\n \"url\": \"http://www.example.com/api/storefront/saved_credit_cards/5d5dbd6bd4322a4b69d79097\",\n \"default\": false,\n \"issuer\": \"Visa\",\n \"display_number\": \"XXXX-XXXX-XXXX-1111\",\n \"month\": 7,\n \"year\": 2024,\n \"first_name\": \"Susan\",\n \"last_name\": \"Baker\"\n}",
43
+ "response_body": "{\n \"user_id\": \"5dddc8fb1241596aa5204f6c\",\n \"id\": \"5dddc8fb1241596aa5204f72\",\n \"url\": \"http://www.example.com/api/storefront/saved_credit_cards/5dddc8fb1241596aa5204f72\",\n \"default\": false,\n \"issuer\": \"Visa\",\n \"display_number\": \"XXXX-XXXX-XXXX-1111\",\n \"month\": 7,\n \"year\": 2024,\n \"first_name\": \"Susan\",\n \"last_name\": \"Baker\"\n}",
43
44
  "response_content_type": "application/json",
44
- "curl": "curl \"https://www.example.com/api/storefront/saved_credit_cards\" -d '{\"number\":\"4111111111111111\",\"first_name\":\"Susan\",\"last_name\":\"Baker\",\"month\":\"7\",\"year\":\"2024\",\"cvv\":\"123\"}' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Token token=\\\"sWdWsZwAMRXqfQX53eS5QgFK\\\"\""
45
+ "curl": "curl \"https://www.example.com/api/storefront/saved_credit_cards\" -d '{\"number\":\"4111111111111111\",\"first_name\":\"Susan\",\"last_name\":\"Baker\",\"month\":\"7\",\"year\":\"2024\",\"cvv\":\"123\"}' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Token token=\\\"rtbqstRt5B87UebHPY4SYriL\\\"\""
45
46
  }
46
47
  ],
47
48
  "resource": "Saved Credit Cards",
@@ -9,7 +9,7 @@
9
9
  {
10
10
  "request_headers": {
11
11
  "Content-Type": "application/x-www-form-urlencoded",
12
- "Authorization": "Token token=\"UzbVUsqx5qNipBy5NZ6u5j3b\""
12
+ "Authorization": "Token token=\"D2LCYEh6sAPC6HQUeTJwe9Pe\""
13
13
  },
14
14
  "request_query_parameters": {
15
15
  },
@@ -24,21 +24,23 @@
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",
27
+ "Vary": "X-Requested-With, X-Workarea-Segments",
28
+ "Last-Modified": "Wed, 27 Nov 2019 00:53:17 GMT",
28
29
  "Cache-Control": "no-cache, no-store, must-revalidate",
29
- "X-Request-Id": "57646d9b-606a-4375-95fb-fe1528eef0e7",
30
- "X-Runtime": "0.007183",
30
+ "X-Request-Id": "c083436c-c7b0-4bda-940d-d9f466d8dc8b",
31
+ "X-Runtime": "0.005613",
32
+ "X-Workarea-Segments": "",
31
33
  "Expires": "0"
32
34
  },
33
35
  "request_method": "DELETE",
34
- "request_path": "/api/storefront/saved_credit_cards/5d5dbd6cd4322a4b69d7909d",
36
+ "request_path": "/api/storefront/saved_credit_cards/5dddc8fd1241596aa5204f81",
35
37
  "request_body": null,
36
38
  "request_content_type": "application/x-www-form-urlencoded",
37
39
  "response_status": 204,
38
40
  "response_status_text": "No Content",
39
41
  "response_body": null,
40
42
  "response_content_type": null,
41
- "curl": "curl \"https://www.example.com/api/storefront/saved_credit_cards/5d5dbd6cd4322a4b69d7909d\" -d '' -X DELETE \\\n\t-H \"Content-Type: application/x-www-form-urlencoded\" \\\n\t-H \"Authorization: Token token=\\\"UzbVUsqx5qNipBy5NZ6u5j3b\\\"\""
43
+ "curl": "curl \"https://www.example.com/api/storefront/saved_credit_cards/5dddc8fd1241596aa5204f81\" -d '' -X DELETE \\\n\t-H \"Content-Type: application/x-www-form-urlencoded\" \\\n\t-H \"Authorization: Token token=\\\"D2LCYEh6sAPC6HQUeTJwe9Pe\\\"\""
42
44
  }
43
45
  ],
44
46
  "resource": "Saved Credit Cards",
@@ -8,7 +8,7 @@
8
8
  "requests": [
9
9
  {
10
10
  "request_headers": {
11
- "Authorization": "Token token=\"bdUW93xR4u4eSrnrYVJc3ESz\""
11
+ "Authorization": "Token token=\"DQKxg6mi7izwjdLNV8QhmHYS\""
12
12
  },
13
13
  "request_query_parameters": {
14
14
  },
@@ -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/\"e8344f8761b9570442a3c2a2de5c5cb8\"",
27
+ "Vary": "X-Requested-With, X-Workarea-Segments",
28
+ "Last-Modified": "Wed, 27 Nov 2019 00:53:16 GMT",
29
29
  "Cache-Control": "no-cache, no-store, must-revalidate",
30
- "X-Request-Id": "0d129975-ff48-48a2-bc7e-1faaff4cf759",
31
- "X-Runtime": "0.007464",
30
+ "X-Request-Id": "7cfdf86e-5030-43fb-85fa-c5c4cbea058f",
31
+ "X-Runtime": "0.005535",
32
+ "X-Workarea-Segments": "",
32
33
  "Expires": "0",
33
34
  "Content-Length": "571"
34
35
  },
@@ -38,14 +39,14 @@
38
39
  "request_content_type": null,
39
40
  "response_status": 200,
40
41
  "response_status_text": "OK",
41
- "response_body": "{\n \"user_id\": \"5d5dbd6cd4322a4b69d7909f\",\n \"credit_cards\": [\n {\n \"id\": \"5d5dbd6cd4322a4b69d790a3\",\n \"url\": \"http://www.example.com/api/storefront/saved_credit_cards/5d5dbd6cd4322a4b69d790a3\",\n \"default\": false,\n \"issuer\": \"Visa\",\n \"display_number\": \"XXXX-XXXX-XXXX-1881\",\n \"month\": 3,\n \"year\": 2023,\n \"first_name\": \"Susan\",\n \"last_name\": \"Baker\"\n },\n {\n \"id\": \"5d5dbd6cd4322a4b69d790a4\",\n \"url\": \"http://www.example.com/api/storefront/saved_credit_cards/5d5dbd6cd4322a4b69d790a4\",\n \"default\": false,\n \"issuer\": \"Visa\",\n \"display_number\": \"XXXX-XXXX-XXXX-1111\",\n \"month\": 7,\n \"year\": 2024,\n \"first_name\": \"Susan\",\n \"last_name\": \"Baker\"\n }\n ]\n}",
42
+ "response_body": "{\n \"user_id\": \"5dddc8fc1241596aa5204f74\",\n \"credit_cards\": [\n {\n \"id\": \"5dddc8fc1241596aa5204f79\",\n \"url\": \"http://www.example.com/api/storefront/saved_credit_cards/5dddc8fc1241596aa5204f79\",\n \"default\": false,\n \"issuer\": \"Visa\",\n \"display_number\": \"XXXX-XXXX-XXXX-1881\",\n \"month\": 3,\n \"year\": 2023,\n \"first_name\": \"Susan\",\n \"last_name\": \"Baker\"\n },\n {\n \"id\": \"5dddc8fc1241596aa5204f7a\",\n \"url\": \"http://www.example.com/api/storefront/saved_credit_cards/5dddc8fc1241596aa5204f7a\",\n \"default\": false,\n \"issuer\": \"Visa\",\n \"display_number\": \"XXXX-XXXX-XXXX-1111\",\n \"month\": 7,\n \"year\": 2024,\n \"first_name\": \"Susan\",\n \"last_name\": \"Baker\"\n }\n ]\n}",
42
43
  "response_content_type": "application/json",
43
- "curl": "curl -g \"https://www.example.com/api/storefront/saved_credit_cards\" -X GET \\\n\t-H \"Authorization: Token token=\\\"bdUW93xR4u4eSrnrYVJc3ESz\\\"\""
44
+ "curl": "curl -g \"https://www.example.com/api/storefront/saved_credit_cards\" -X GET \\\n\t-H \"Authorization: Token token=\\\"DQKxg6mi7izwjdLNV8QhmHYS\\\"\""
44
45
  }
45
46
  ],
46
47
  "resource": "Saved Credit Cards",
47
48
  "description": "Listing the user's saved credit cards",
48
49
  "route": "/api/storefront/saved_credit_cards",
49
- "explanation": " List a customer's saved addresses. Useful for account management.\n These addresses will be available to the customer in an\n authenticated checkout.\n",
50
+ "explanation": "<p>List a customer&#39;s saved addresses. Useful for account management.<br>\nThese addresses will be available to the customer in an<br>\nauthenticated checkout.</p>\n",
50
51
  "http_method": "GET"
51
52
  }
@@ -8,7 +8,7 @@
8
8
  "requests": [
9
9
  {
10
10
  "request_headers": {
11
- "Authorization": "Token token=\"8iKJ3VEmcfyhdH7Ppy7BPBiz\""
11
+ "Authorization": "Token token=\"rdCn2gLdQQch8s6wpLMPWQsp\""
12
12
  },
13
13
  "request_query_parameters": {
14
14
  },
@@ -24,23 +24,24 @@
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/\"caea022584c113878675ef307855910a\"",
27
+ "Vary": "X-Requested-With, X-Workarea-Segments",
28
+ "Last-Modified": "Wed, 27 Nov 2019 00:53:19 GMT",
29
29
  "Cache-Control": "no-cache, no-store, must-revalidate",
30
- "X-Request-Id": "c7577fce-775e-4e71-9ab1-3b0fd79d1127",
31
- "X-Runtime": "0.007011",
30
+ "X-Request-Id": "5b6ad680-3f33-4c8e-8308-4c5b66cdc815",
31
+ "X-Runtime": "0.005172",
32
+ "X-Workarea-Segments": "",
32
33
  "Expires": "0",
33
34
  "Content-Length": "294"
34
35
  },
35
36
  "request_method": "GET",
36
- "request_path": "/api/storefront/saved_credit_cards/5d5dbd6dd4322a4b69d790aa",
37
+ "request_path": "/api/storefront/saved_credit_cards/5dddc8ff1241596aa5204f8f",
37
38
  "request_body": null,
38
39
  "request_content_type": null,
39
40
  "response_status": 200,
40
41
  "response_status_text": "OK",
41
- "response_body": "{\n \"user_id\": \"5d5dbd6dd4322a4b69d790a6\",\n \"id\": \"5d5dbd6dd4322a4b69d790aa\",\n \"url\": \"http://www.example.com/api/storefront/saved_credit_cards/5d5dbd6dd4322a4b69d790aa\",\n \"default\": false,\n \"issuer\": \"Visa\",\n \"display_number\": \"XXXX-XXXX-XXXX-1881\",\n \"month\": 3,\n \"year\": 2023,\n \"first_name\": \"Susan\",\n \"last_name\": \"Baker\"\n}",
42
+ "response_body": "{\n \"user_id\": \"5dddc8ff1241596aa5204f8a\",\n \"id\": \"5dddc8ff1241596aa5204f8f\",\n \"url\": \"http://www.example.com/api/storefront/saved_credit_cards/5dddc8ff1241596aa5204f8f\",\n \"default\": false,\n \"issuer\": \"Visa\",\n \"display_number\": \"XXXX-XXXX-XXXX-1881\",\n \"month\": 3,\n \"year\": 2023,\n \"first_name\": \"Susan\",\n \"last_name\": \"Baker\"\n}",
42
43
  "response_content_type": "application/json",
43
- "curl": "curl -g \"https://www.example.com/api/storefront/saved_credit_cards/5d5dbd6dd4322a4b69d790aa\" -X GET \\\n\t-H \"Authorization: Token token=\\\"8iKJ3VEmcfyhdH7Ppy7BPBiz\\\"\""
44
+ "curl": "curl -g \"https://www.example.com/api/storefront/saved_credit_cards/5dddc8ff1241596aa5204f8f\" -X GET \\\n\t-H \"Authorization: Token token=\\\"rdCn2gLdQQch8s6wpLMPWQsp\\\"\""
44
45
  }
45
46
  ],
46
47
  "resource": "Saved Credit Cards",