workarea-api 4.5.0 → 4.5.6

data/doc/api/storefront/system_content/showing_system_content.json

@@ -18,17 +18,17 @@
         "X-Download-Options": "noopen",
         "X-Permitted-Cross-Domain-Policies": "none",
         "Referrer-Policy": "strict-origin-when-cross-origin",
-        "Date": "Wed, 27 Nov 2019 00:52:48 GMT",
+        "Date": "Wed, 19 Aug 2020 13:54:09 GMT",
         "Content-Type": "application/json; charset=utf-8",
         "Access-Control-Allow-Origin": "*",
         "Access-Control-Allow-Headers": "*",
         "Access-Control-Allow-Methods": "GET, POST, PATCH, PUT, DELETE, OPTIONS",
         "X-Requested-With": "",
         "Vary": "X-Requested-With, X-Workarea-Segments",
-        "Last-Modified": "Wed, 27 Nov 2019 00:52:48 GMT",
+        "Last-Modified": "Wed, 19 Aug 2020 13:54:09 GMT",
         "Cache-Control": "no-cache, no-store, must-revalidate",
-        "X-Request-Id": "f3d9d3a1-842e-422e-b717-5c29b14889e8",
-        "X-Runtime": "0.008132",
+        "X-Request-Id": "c7549707-035f-428f-a882-b6f0266fbecf",
+        "X-Runtime": "0.013768",
         "X-Workarea-Segments": "",
         "Expires": "0",
         "Content-Length": "1981"
@@ -39,7 +39,7 @@
       "request_content_type": null,
       "response_status": 200,
       "response_status_text": "OK",
-      "response_body": "{\n  \"id\": \"5dddc8e01241596aa5204ce3\",\n  \"name\": \"Layout\",\n  \"url\": \"http://www.example.com/api/storefront/system_content/Layout\",\n  \"browser_title\": \"Layout\",\n  \"meta_description\": \"Shop online for Workarea API products\",\n  \"content_blocks\": [\n    {\n      \"id\": \"5dddc8e01241596aa5204ce4\",\n      \"type\": \"text\",\n      \"area\": \"header_promo\",\n      \"data\": {\n        \"text\": \"Don't miss our sizzling summer deals!\"\n      },\n      \"hidden_breakpoints\": [\n\n      ],\n      \"position\": 0,\n      \"html\": \"<div class=\\\"content-block content-block--text\\\" id=\\\"content_block_5dddc8e01241596aa5204ce4\\\" data-analytics=\\\"{&quot;event&quot;:&quot;contentBlockDisplay&quot;,&quot;payload&quot;:{&quot;id&quot;:&quot;5dddc8e01241596aa5204ce4&quot;,&quot;type&quot;:&quot;text&quot;,&quot;position&quot;:0,&quot;data&quot;:{&quot;text&quot;:&quot;Don&#39;t miss our sizzling summer deals!&quot;}}}\\\" data-hidden-block-css-content=\\\"Block hidden at this breakpoint\\\"><div class='text-content-block'>Don't miss our sizzling summer deals!</div>\\n</div>\\n\"\n    },\n    {\n      \"id\": \"5dddc8e01241596aa5204ce5\",\n      \"type\": \"text\",\n      \"area\": \"footer_navigation\",\n      \"data\": {\n        \"text\": \"Be the first to received our exclusive discounts\"\n      },\n      \"hidden_breakpoints\": [\n\n      ],\n      \"position\": 0,\n      \"html\": \"<div class=\\\"content-block content-block--text\\\" id=\\\"content_block_5dddc8e01241596aa5204ce5\\\" data-analytics=\\\"{&quot;event&quot;:&quot;contentBlockDisplay&quot;,&quot;payload&quot;:{&quot;id&quot;:&quot;5dddc8e01241596aa5204ce5&quot;,&quot;type&quot;:&quot;text&quot;,&quot;position&quot;:0,&quot;data&quot;:{&quot;text&quot;:&quot;Be the first to received our exclusive discounts&quot;}}}\\\" data-hidden-block-css-content=\\\"Block hidden at this breakpoint\\\"><div class='text-content-block'>Be the first to received our exclusive discounts</div>\\n</div>\\n\"\n    }\n  ]\n}",
+      "response_body": "{\n  \"id\": \"5f3d2f010218236e938cebfe\",\n  \"name\": \"Layout\",\n  \"url\": \"http://www.example.com/api/storefront/system_content/Layout\",\n  \"browser_title\": \"Layout\",\n  \"meta_description\": \"Shop online for Workarea API products\",\n  \"content_blocks\": [\n    {\n      \"id\": \"5f3d2f010218236e938cebff\",\n      \"type\": \"text\",\n      \"area\": \"header_promo\",\n      \"data\": {\n        \"text\": \"Don't miss our sizzling summer deals!\"\n      },\n      \"hidden_breakpoints\": [\n\n      ],\n      \"position\": 0,\n      \"html\": \"<div class=\\\"content-block content-block--text\\\" id=\\\"content_block_5f3d2f010218236e938cebff\\\" data-analytics=\\\"{&quot;event&quot;:&quot;contentBlockDisplay&quot;,&quot;payload&quot;:{&quot;id&quot;:&quot;5f3d2f010218236e938cebff&quot;,&quot;type&quot;:&quot;text&quot;,&quot;position&quot;:0,&quot;data&quot;:{&quot;text&quot;:&quot;Don&#39;t miss our sizzling summer deals!&quot;}}}\\\" data-hidden-block-css-content=\\\"Block hidden at this breakpoint\\\"><div class='text-content-block'>Don't miss our sizzling summer deals!</div>\\n</div>\\n\"\n    },\n    {\n      \"id\": \"5f3d2f010218236e938cec00\",\n      \"type\": \"text\",\n      \"area\": \"footer_navigation\",\n      \"data\": {\n        \"text\": \"Be the first to received our exclusive discounts\"\n      },\n      \"hidden_breakpoints\": [\n\n      ],\n      \"position\": 0,\n      \"html\": \"<div class=\\\"content-block content-block--text\\\" id=\\\"content_block_5f3d2f010218236e938cec00\\\" data-analytics=\\\"{&quot;event&quot;:&quot;contentBlockDisplay&quot;,&quot;payload&quot;:{&quot;id&quot;:&quot;5f3d2f010218236e938cec00&quot;,&quot;type&quot;:&quot;text&quot;,&quot;position&quot;:0,&quot;data&quot;:{&quot;text&quot;:&quot;Be the first to received our exclusive discounts&quot;}}}\\\" data-hidden-block-css-content=\\\"Block hidden at this breakpoint\\\"><div class='text-content-block'>Be the first to received our exclusive discounts</div>\\n</div>\\n\"\n    }\n  ]\n}",
       "response_content_type": "application/json",
       "curl": "curl -g \"https://www.example.com/api/storefront/system_content/layout\" -X GET "
     }

data/doc/api/storefront/system_content/showing_the_home_page.json

@@ -18,17 +18,17 @@
         "X-Download-Options": "noopen",
         "X-Permitted-Cross-Domain-Policies": "none",
         "Referrer-Policy": "strict-origin-when-cross-origin",
-        "Date": "Wed, 27 Nov 2019 00:52:48 GMT",
+        "Date": "Wed, 19 Aug 2020 13:54:10 GMT",
         "Content-Type": "application/json; charset=utf-8",
         "Access-Control-Allow-Origin": "*",
         "Access-Control-Allow-Headers": "*",
         "Access-Control-Allow-Methods": "GET, POST, PATCH, PUT, DELETE, OPTIONS",
         "X-Requested-With": "",
         "Vary": "X-Requested-With, X-Workarea-Segments",
-        "Last-Modified": "Wed, 27 Nov 2019 00:52:48 GMT",
+        "Last-Modified": "Wed, 19 Aug 2020 13:54:10 GMT",
         "Cache-Control": "no-cache, no-store, must-revalidate",
-        "X-Request-Id": "f924549d-136a-4b93-b820-e6149f37bfc2",
-        "X-Runtime": "0.008772",
+        "X-Request-Id": "3ad54fe0-81b2-4828-89f6-e4514c6621fa",
+        "X-Runtime": "0.009666",
         "X-Workarea-Segments": "",
         "Expires": "0",
         "Content-Length": "1830"
@@ -39,7 +39,7 @@
       "request_content_type": null,
       "response_status": 200,
       "response_status_text": "OK",
-      "response_body": "{\n  \"id\": \"5dddc8df1241596aa5204cde\",\n  \"name\": \"Home Page\",\n  \"url\": \"http://www.example.com/api/storefront/system_content/Home%20Page\",\n  \"browser_title\": \"Home Page\",\n  \"meta_description\": \"Shop online for Workarea API products\",\n  \"content_blocks\": [\n    {\n      \"id\": \"5dddc8df1241596aa5204cdf\",\n      \"type\": \"text\",\n      \"area\": \"default\",\n      \"data\": {\n        \"text\": \"Summer is here!\"\n      },\n      \"hidden_breakpoints\": [\n\n      ],\n      \"position\": 0,\n      \"html\": \"<div class=\\\"content-block content-block--text\\\" id=\\\"content_block_5dddc8df1241596aa5204cdf\\\" data-analytics=\\\"{&quot;event&quot;:&quot;contentBlockDisplay&quot;,&quot;payload&quot;:{&quot;id&quot;:&quot;5dddc8df1241596aa5204cdf&quot;,&quot;type&quot;:&quot;text&quot;,&quot;position&quot;:0,&quot;data&quot;:{&quot;text&quot;:&quot;Summer is here!&quot;}}}\\\" data-hidden-block-css-content=\\\"Block hidden at this breakpoint\\\"><div class='text-content-block'>Summer is here!</div>\\n</div>\\n\"\n    },\n    {\n      \"id\": \"5dddc8df1241596aa5204ce0\",\n      \"type\": \"text\",\n      \"area\": \"default\",\n      \"data\": {\n        \"text\": \"Get 20% off all swimwear\"\n      },\n      \"hidden_breakpoints\": [\n\n      ],\n      \"position\": 1,\n      \"html\": \"<div class=\\\"content-block content-block--text\\\" id=\\\"content_block_5dddc8df1241596aa5204ce0\\\" data-analytics=\\\"{&quot;event&quot;:&quot;contentBlockDisplay&quot;,&quot;payload&quot;:{&quot;id&quot;:&quot;5dddc8df1241596aa5204ce0&quot;,&quot;type&quot;:&quot;text&quot;,&quot;position&quot;:1,&quot;data&quot;:{&quot;text&quot;:&quot;Get 20% off all swimwear&quot;}}}\\\" data-hidden-block-css-content=\\\"Block hidden at this breakpoint\\\"><div class='text-content-block'>Get 20% off all swimwear</div>\\n</div>\\n\"\n    }\n  ]\n}",
+      "response_body": "{\n  \"id\": \"5f3d2f020218236e938cec03\",\n  \"name\": \"Home Page\",\n  \"url\": \"http://www.example.com/api/storefront/system_content/Home%20Page\",\n  \"browser_title\": \"Home Page\",\n  \"meta_description\": \"Shop online for Workarea API products\",\n  \"content_blocks\": [\n    {\n      \"id\": \"5f3d2f020218236e938cec04\",\n      \"type\": \"text\",\n      \"area\": \"default\",\n      \"data\": {\n        \"text\": \"Summer is here!\"\n      },\n      \"hidden_breakpoints\": [\n\n      ],\n      \"position\": 0,\n      \"html\": \"<div class=\\\"content-block content-block--text\\\" id=\\\"content_block_5f3d2f020218236e938cec04\\\" data-analytics=\\\"{&quot;event&quot;:&quot;contentBlockDisplay&quot;,&quot;payload&quot;:{&quot;id&quot;:&quot;5f3d2f020218236e938cec04&quot;,&quot;type&quot;:&quot;text&quot;,&quot;position&quot;:0,&quot;data&quot;:{&quot;text&quot;:&quot;Summer is here!&quot;}}}\\\" data-hidden-block-css-content=\\\"Block hidden at this breakpoint\\\"><div class='text-content-block'>Summer is here!</div>\\n</div>\\n\"\n    },\n    {\n      \"id\": \"5f3d2f020218236e938cec05\",\n      \"type\": \"text\",\n      \"area\": \"default\",\n      \"data\": {\n        \"text\": \"Get 20% off all swimwear\"\n      },\n      \"hidden_breakpoints\": [\n\n      ],\n      \"position\": 1,\n      \"html\": \"<div class=\\\"content-block content-block--text\\\" id=\\\"content_block_5f3d2f020218236e938cec05\\\" data-analytics=\\\"{&quot;event&quot;:&quot;contentBlockDisplay&quot;,&quot;payload&quot;:{&quot;id&quot;:&quot;5f3d2f020218236e938cec05&quot;,&quot;type&quot;:&quot;text&quot;,&quot;position&quot;:1,&quot;data&quot;:{&quot;text&quot;:&quot;Get 20% off all swimwear&quot;}}}\\\" data-hidden-block-css-content=\\\"Block hidden at this breakpoint\\\"><div class='text-content-block'>Get 20% off all swimwear</div>\\n</div>\\n\"\n    }\n  ]\n}",
       "response_content_type": "application/json",
       "curl": "curl -g \"https://www.example.com/api/storefront/system_content/home_page\" -X GET "
     }

data/doc/api/storefront/taxons/showing_a_taxon.json

@@ -18,30 +18,30 @@
         "X-Download-Options": "noopen",
         "X-Permitted-Cross-Domain-Policies": "none",
         "Referrer-Policy": "strict-origin-when-cross-origin",
-        "Date": "Wed, 27 Nov 2019 00:52:46 GMT",
+        "Date": "Wed, 19 Aug 2020 13:55:29 GMT",
         "Content-Type": "application/json; charset=utf-8",
         "Access-Control-Allow-Origin": "*",
         "Access-Control-Allow-Headers": "*",
         "Access-Control-Allow-Methods": "GET, POST, PATCH, PUT, DELETE, OPTIONS",
         "X-Requested-With": "",
         "Vary": "X-Requested-With, X-Workarea-Segments",
-        "Last-Modified": "Wed, 27 Nov 2019 00:52:46 GMT",
+        "Last-Modified": "Wed, 19 Aug 2020 13:55:29 GMT",
         "Cache-Control": "no-cache, no-store, must-revalidate",
-        "X-Request-Id": "5ceec41f-08e9-4933-a1f9-788147b25053",
-        "X-Runtime": "0.007104",
+        "X-Request-Id": "b0eb5722-8d04-4656-9d95-9aedaebebf17",
+        "X-Runtime": "0.013856",
         "X-Workarea-Segments": "",
         "Expires": "0",
         "Content-Length": "534"
       },
       "request_method": "GET",
-      "request_path": "/api/storefront/taxons/5dddc8dd1241596aa5204cd9",
+      "request_path": "/api/storefront/taxons/5f3d2f510218236e938cf11a",
       "request_body": null,
       "request_content_type": null,
       "response_status": 200,
       "response_status_text": "OK",
-      "response_body": "{\n  \"taxon\": {\n    \"id\": \"5dddc8dd1241596aa5204cd9\",\n    \"url\": \"/api/storefront/taxons/5dddc8dd1241596aa5204cd9\",\n    \"name\": \"Mens\",\n    \"depth\": 1,\n    \"navigable_url\": \"http://example.com/pages/mens\",\n    \"parent_id\": \"5dddc8dd1241596aa5204cda\",\n    \"parent_ids\": [\n      \"5dddc8dd1241596aa5204cda\"\n    ],\n    \"position\": 0\n  },\n  \"children\": [\n    {\n      \"id\": \"5dddc8de1241596aa5204cdb\",\n      \"url\": \"/api/storefront/taxons/5dddc8de1241596aa5204cdb\",\n      \"name\": \"Sale\",\n      \"depth\": 2,\n      \"navigable_url\": null,\n      \"parent_id\": \"5dddc8dd1241596aa5204cd9\",\n      \"parent_ids\": [\n        \"5dddc8dd1241596aa5204cda\",\n        \"5dddc8dd1241596aa5204cd9\"\n      ],\n      \"position\": 0\n    }\n  ]\n}",
+      "response_body": "{\n  \"taxon\": {\n    \"id\": \"5f3d2f510218236e938cf11a\",\n    \"url\": \"/api/storefront/taxons/5f3d2f510218236e938cf11a\",\n    \"name\": \"Mens\",\n    \"depth\": 1,\n    \"navigable_url\": \"http://example.com/pages/mens\",\n    \"parent_id\": \"5f3d2f510218236e938cf11b\",\n    \"parent_ids\": [\n      \"5f3d2f510218236e938cf11b\"\n    ],\n    \"position\": 0\n  },\n  \"children\": [\n    {\n      \"id\": \"5f3d2f510218236e938cf11c\",\n      \"url\": \"/api/storefront/taxons/5f3d2f510218236e938cf11c\",\n      \"name\": \"Sale\",\n      \"depth\": 2,\n      \"navigable_url\": null,\n      \"parent_id\": \"5f3d2f510218236e938cf11a\",\n      \"parent_ids\": [\n        \"5f3d2f510218236e938cf11b\",\n        \"5f3d2f510218236e938cf11a\"\n      ],\n      \"position\": 0\n    }\n  ]\n}",
       "response_content_type": "application/json",
-      "curl": "curl -g \"https://www.example.com/api/storefront/taxons/5dddc8dd1241596aa5204cd9\" -X GET "
+      "curl": "curl -g \"https://www.example.com/api/storefront/taxons/5f3d2f510218236e938cf11a\" -X GET "
     }
   ],
   "resource": "Taxons",

data/doc/api/storefront/validation_errors/checkout_validation_errors.json

@@ -25,23 +25,23 @@
         "Access-Control-Allow-Methods": "GET, POST, PATCH, PUT, DELETE, OPTIONS",
         "X-Requested-With": "",
         "Vary": "X-Requested-With, X-Workarea-Segments",
-        "Last-Modified": "Wed, 27 Nov 2019 00:51:33 GMT",
+        "Last-Modified": "Wed, 19 Aug 2020 13:54:56 GMT",
         "Cache-Control": "no-cache, no-store, must-revalidate",
-        "X-Request-Id": "1f3d729a-7f8d-47cc-a170-f6dbf096a0bf",
-        "X-Runtime": "0.447104",
+        "X-Request-Id": "042fc2df-60ed-489f-90c0-37926f3dea56",
+        "X-Runtime": "0.579544",
         "X-Workarea-Segments": "",
         "Expires": "0",
         "Content-Length": "3271"
       },
       "request_method": "PATCH",
-      "request_path": "/api/storefront/checkouts/65CBE75A6F",
+      "request_path": "/api/storefront/checkouts/42F1747F29",
       "request_body": "{\"email\":\"susanb@\",\"shipping_address\":{\"first_name\":\"\",\"last_name\":\"Baker\",\"street\":\"350 Fifth Avenue\",\"city\":\"New York\",\"region\":\"NY\",\"country\":\"US\",\"postal_code\":\"10118\"},\"billing_address\":{\"first_name\":\"Susan\",\"last_name\":\"Baker\",\"street\":\"\",\"city\":\"New York\",\"region\":\"NY\",\"country\":\"US\",\"postal_code\":\"10118\"}}",
       "request_content_type": "application/json",
-      "response_status": 200,
-      "response_status_text": "OK",
-      "response_body": "{\n  \"order\": {\n    \"id\": \"65CBE75A6F\",\n    \"url\": \"http://www.example.com/api/storefront/orders/65CBE75A6F\",\n    \"user_id\": null,\n    \"email\": \"susanb@\",\n    \"placed_at\": null,\n    \"canceled_at\": null,\n    \"promo_codes\": [\n\n    ],\n    \"requires_shipping\": true,\n    \"items\": [\n      {\n        \"id\": \"5dddc8951241596aa5204b41\",\n        \"product_id\": \"VINTEE\",\n        \"sku\": \"VT001\",\n        \"quantity\": 2,\n        \"product_url\": \"http://www.example.com/api/storefront/products/vintage-tee?sku=VT001\",\n        \"options\": {\n        },\n        \"customizations\": {\n        },\n        \"product_image\": {\n          \"urls\": [\n            {\n              \"type\": \"small\",\n              \"url\": \"http://www.example.com/product_images/placeholder/small.jpg?c=1574815751\"\n            },\n            {\n              \"type\": \"medium\",\n              \"url\": \"http://www.example.com/product_images/placeholder/medium.jpg?c=1574815751\"\n            },\n            {\n              \"type\": \"small_thumb\",\n              \"url\": \"http://www.example.com/product_images/placeholder/small_thumb.jpg?c=1574815751\"\n            },\n            {\n              \"type\": \"medium_thumb\",\n              \"url\": \"http://www.example.com/product_images/placeholder/medium_thumb.jpg?c=1574815751\"\n            },\n            {\n              \"type\": \"large_thumb\",\n              \"url\": \"http://www.example.com/product_images/placeholder/large_thumb.jpg?c=1574815751\"\n            },\n            {\n              \"type\": \"detail\",\n              \"url\": \"http://www.example.com/product_images/placeholder/detail.jpg?c=1574815751\"\n            },\n            {\n              \"type\": \"zoom\",\n              \"url\": \"http://www.example.com/product_images/placeholder/zoom.jpg?c=1574815751\"\n            },\n            {\n              \"type\": \"super_zoom\",\n              \"url\": \"http://www.example.com/product_images/placeholder/super_zoom.jpg?c=1574815751\"\n            },\n            {\n              \"type\": \"favicon\",\n              \"url\": \"http://www.example.com/product_images/placeholder/favicon.jpg?c=1574815751\"\n            },\n            {\n              \"type\": \"favicon_ico\",\n              \"url\": \"http://www.example.com/product_images/placeholder/favicon_ico.jpg?c=1574815751\"\n            }\n          ]\n        },\n        \"pricing\": {\n          \"price_adjustments\": [\n            {\n              \"description\": \"Item Subtotal\",\n              \"discount\": false,\n              \"amount\": {\n                \"cents\": 1000.0,\n                \"currency_iso\": \"USD\"\n              }\n            }\n          ],\n          \"total_price\": {\n            \"cents\": 1000.0,\n            \"currency_iso\": \"USD\"\n          },\n          \"on_sale\": false,\n          \"original_unit_price\": {\n            \"cents\": 500.0,\n            \"currency_iso\": \"USD\"\n          },\n          \"original_price\": {\n            \"cents\": 500.0,\n            \"currency_iso\": \"USD\"\n          },\n          \"customized\": false,\n          \"customizations_unit_price\": {\n            \"cents\": 0.0,\n            \"currency_iso\": \"USD\"\n          }\n        }\n      }\n    ],\n    \"pricing\": {\n      \"price_adjustments\": [\n\n      ],\n      \"shipping_total\": {\n        \"cents\": 0.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"tax_total\": {\n        \"cents\": 0.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"subtotal_price\": {\n        \"cents\": 1000.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"total_price\": {\n        \"cents\": 1000.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"paid_amount\": {\n        \"cents\": 1000.0,\n        \"currency_iso\": \"USD\"\n      }\n    },\n    \"shipping_service\": null,\n    \"tenders\": [\n\n    ]\n  },\n  \"checkout\": {\n    \"url\": \"http://www.example.com/api/storefront/checkouts/65CBE75A6F\",\n    \"started_at\": \"2019-11-27T00:51:33.506Z\",\n    \"shippable\": false,\n    \"complete\": false,\n    \"addresses\": {\n      \"complete\": false,\n      \"email\": \"susanb@\",\n      \"problems\": [\n        \"Email is invalid\"\n      ],\n      \"shipping_address\": {\n        \"id\": \"5dddc8951241596aa5204b48\",\n        \"first_name\": \"\",\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\": null,\n        \"phone_extension\": null,\n        \"problems\": [\n          \"First name can't be blank\"\n        ]\n      },\n      \"billing_address\": {\n        \"id\": \"5dddc8951241596aa5204b49\",\n        \"first_name\": \"Susan\",\n        \"last_name\": \"Baker\",\n        \"company\": null,\n        \"street\": \"\",\n        \"street_2\": null,\n        \"city\": \"New York\",\n        \"country\": \"US\",\n        \"region\": \"NY\",\n        \"postal_code\": \"10118\",\n        \"phone_number\": null,\n        \"phone_extension\": null,\n        \"problems\": [\n          \"Street can't be blank\"\n        ]\n      }\n    },\n    \"shipping\": {\n      \"complete\": false,\n      \"problems\": [\n        \"Address is invalid\"\n      ],\n      \"shipping_service\": null,\n      \"shipping_total\": {\n        \"cents\": 0.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"shipping_options\": [\n\n      ]\n    },\n    \"payment\": {\n      \"complete\": false,\n      \"problems\": [\n        \"Address is invalid\"\n      ],\n      \"tenders\": [\n\n      ]\n    }\n  }\n}",
+      "response_status": 422,
+      "response_status_text": "Unprocessable Entity",
+      "response_body": "{\n  \"order\": {\n    \"id\": \"42F1747F29\",\n    \"url\": \"http://www.example.com/api/storefront/orders/42F1747F29\",\n    \"user_id\": null,\n    \"email\": \"susanb@\",\n    \"placed_at\": null,\n    \"canceled_at\": null,\n    \"promo_codes\": [\n\n    ],\n    \"requires_shipping\": true,\n    \"items\": [\n      {\n        \"id\": \"5f3d2f300218236e938cee2b\",\n        \"product_id\": \"VINTEE\",\n        \"sku\": \"VT001\",\n        \"quantity\": 2,\n        \"product_url\": \"http://www.example.com/api/storefront/products/vintage-tee?sku=VT001\",\n        \"options\": {\n        },\n        \"customizations\": {\n        },\n        \"product_image\": {\n          \"urls\": [\n            {\n              \"type\": \"small\",\n              \"url\": \"http://www.example.com/product_images/placeholder/small.jpg?c=1597845226\"\n            },\n            {\n              \"type\": \"medium\",\n              \"url\": \"http://www.example.com/product_images/placeholder/medium.jpg?c=1597845226\"\n            },\n            {\n              \"type\": \"small_thumb\",\n              \"url\": \"http://www.example.com/product_images/placeholder/small_thumb.jpg?c=1597845226\"\n            },\n            {\n              \"type\": \"medium_thumb\",\n              \"url\": \"http://www.example.com/product_images/placeholder/medium_thumb.jpg?c=1597845226\"\n            },\n            {\n              \"type\": \"large_thumb\",\n              \"url\": \"http://www.example.com/product_images/placeholder/large_thumb.jpg?c=1597845226\"\n            },\n            {\n              \"type\": \"detail\",\n              \"url\": \"http://www.example.com/product_images/placeholder/detail.jpg?c=1597845226\"\n            },\n            {\n              \"type\": \"zoom\",\n              \"url\": \"http://www.example.com/product_images/placeholder/zoom.jpg?c=1597845226\"\n            },\n            {\n              \"type\": \"super_zoom\",\n              \"url\": \"http://www.example.com/product_images/placeholder/super_zoom.jpg?c=1597845226\"\n            },\n            {\n              \"type\": \"favicon\",\n              \"url\": \"http://www.example.com/product_images/placeholder/favicon.jpg?c=1597845226\"\n            },\n            {\n              \"type\": \"favicon_ico\",\n              \"url\": \"http://www.example.com/product_images/placeholder/favicon_ico.jpg?c=1597845226\"\n            }\n          ]\n        },\n        \"pricing\": {\n          \"price_adjustments\": [\n            {\n              \"description\": \"Item Subtotal\",\n              \"discount\": false,\n              \"amount\": {\n                \"cents\": 1000.0,\n                \"currency_iso\": \"USD\"\n              }\n            }\n          ],\n          \"total_price\": {\n            \"cents\": 1000.0,\n            \"currency_iso\": \"USD\"\n          },\n          \"on_sale\": false,\n          \"original_unit_price\": {\n            \"cents\": 500.0,\n            \"currency_iso\": \"USD\"\n          },\n          \"original_price\": {\n            \"cents\": 500.0,\n            \"currency_iso\": \"USD\"\n          },\n          \"customized\": false,\n          \"customizations_unit_price\": {\n            \"cents\": 0.0,\n            \"currency_iso\": \"USD\"\n          }\n        }\n      }\n    ],\n    \"pricing\": {\n      \"price_adjustments\": [\n\n      ],\n      \"shipping_total\": {\n        \"cents\": 0.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"tax_total\": {\n        \"cents\": 0.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"subtotal_price\": {\n        \"cents\": 1000.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"total_price\": {\n        \"cents\": 1000.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"paid_amount\": {\n        \"cents\": 1000.0,\n        \"currency_iso\": \"USD\"\n      }\n    },\n    \"shipping_service\": null,\n    \"tenders\": [\n\n    ]\n  },\n  \"checkout\": {\n    \"url\": \"http://www.example.com/api/storefront/checkouts/42F1747F29\",\n    \"started_at\": \"2020-08-19T13:54:56.210Z\",\n    \"shippable\": false,\n    \"complete\": false,\n    \"addresses\": {\n      \"complete\": false,\n      \"email\": \"susanb@\",\n      \"problems\": [\n        \"Email is invalid\"\n      ],\n      \"shipping_address\": {\n        \"id\": \"5f3d2f300218236e938cee32\",\n        \"first_name\": \"\",\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\": null,\n        \"phone_extension\": null,\n        \"problems\": [\n          \"First name can't be blank\"\n        ]\n      },\n      \"billing_address\": {\n        \"id\": \"5f3d2f300218236e938cee33\",\n        \"first_name\": \"Susan\",\n        \"last_name\": \"Baker\",\n        \"company\": null,\n        \"street\": \"\",\n        \"street_2\": null,\n        \"city\": \"New York\",\n        \"country\": \"US\",\n        \"region\": \"NY\",\n        \"postal_code\": \"10118\",\n        \"phone_number\": null,\n        \"phone_extension\": null,\n        \"problems\": [\n          \"Street can't be blank\"\n        ]\n      }\n    },\n    \"shipping\": {\n      \"complete\": false,\n      \"problems\": [\n        \"Address is invalid\"\n      ],\n      \"shipping_service\": null,\n      \"shipping_total\": {\n        \"cents\": 0.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"shipping_options\": [\n\n      ]\n    },\n    \"payment\": {\n      \"complete\": false,\n      \"problems\": [\n        \"Address is invalid\"\n      ],\n      \"tenders\": [\n\n      ]\n    }\n  }\n}",
       "response_content_type": "application/json",
-      "curl": "curl \"https://www.example.com/api/storefront/checkouts/65CBE75A6F\" -d '{\"email\":\"susanb@\",\"shipping_address\":{\"first_name\":\"\",\"last_name\":\"Baker\",\"street\":\"350 Fifth Avenue\",\"city\":\"New York\",\"region\":\"NY\",\"country\":\"US\",\"postal_code\":\"10118\"},\"billing_address\":{\"first_name\":\"Susan\",\"last_name\":\"Baker\",\"street\":\"\",\"city\":\"New York\",\"region\":\"NY\",\"country\":\"US\",\"postal_code\":\"10118\"}}' -X PATCH \\\n\t-H \"Content-Type: application/json\""
+      "curl": "curl \"https://www.example.com/api/storefront/checkouts/42F1747F29\" -d '{\"email\":\"susanb@\",\"shipping_address\":{\"first_name\":\"\",\"last_name\":\"Baker\",\"street\":\"350 Fifth Avenue\",\"city\":\"New York\",\"region\":\"NY\",\"country\":\"US\",\"postal_code\":\"10118\"},\"billing_address\":{\"first_name\":\"Susan\",\"last_name\":\"Baker\",\"street\":\"\",\"city\":\"New York\",\"region\":\"NY\",\"country\":\"US\",\"postal_code\":\"10118\"}}' -X PATCH \\\n\t-H \"Content-Type: application/json\""
     }
   ],
   "resource": "Validation Errors",

data/doc/api/storefront/validation_errors/general_validation_errors.json

@@ -21,8 +21,8 @@
         "Referrer-Policy": "strict-origin-when-cross-origin",
         "Content-Type": "application/json; charset=utf-8",
         "Cache-Control": "no-cache, no-store, must-revalidate",
-        "X-Request-Id": "ba73618c-7816-4930-b249-c07a150c0e9c",
-        "X-Runtime": "0.007253",
+        "X-Request-Id": "08cd60aa-3701-4cba-b912-33cfa24b6354",
+        "X-Runtime": "0.008567",
         "X-Workarea-Segments": "",
         "Expires": "0",
         "Content-Length": "59"

data/lib/tasks/docs.rake

@@ -0,0 +1,20 @@
+load 'rails/test_unit/testing.rake'
+
+namespace :workarea do
+  namespace :test do
+    desc 'Generate Workarea API Documentation'
+    task api_docs: :'workarea:prepare' do
+      roots = [Workarea::Core::Engine.root] +
+                Workarea::Plugin.installed.map(&:root) +
+                [Rails.root]
+
+      ENV['GENERATE_API_DOCS'] = 'true'
+
+      Rails::TestUnit::Runner.rake_run(
+        roots
+          .map { |r| FileList["#{r}/test/documentation/**/*_test.rb"] }
+          .reduce(&:+)
+      )
+    end
+  end
+end

data/lib/workarea/api/version.rb

@@ -1,5 +1,5 @@
 module Workarea
   module Api
-    VERSION = '4.5.0'.freeze
+    VERSION = '4.5.6'.freeze
   end
 end

data/storefront/test/documentation/workarea/api/storefront/checkouts_documentation_test.rb

@@ -85,6 +85,27 @@ module Workarea
           end
         end
 
+        def test_and_document_update_failure
+          description 'Failure to update a checkout'
+          route storefront_api.checkout_path(':id')
+          explanation <<-EOS
+            This is an example of what occurs when you fail to send in the correct parameters for your checkout.
+          EOS
+
+          record_request do
+            patch storefront_api.checkout_path(@order),
+              as: :json,
+              params: {
+                email: 'susanb@workarea.com',
+                shipping_address: address.except(:first_name),
+                billing_address: address.except(:last_name),
+                shipping_service: 'Express'
+              }
+
+            assert_equal(422, response.status)
+          end
+        end
+
         def test_and_document_complete
           description 'Completing a checkout'
           route storefront_api.complete_checkout_path(':id')

data/storefront/test/documentation/workarea/api/storefront/validation_documentation_test.rb

@@ -72,7 +72,7 @@ module Workarea
                 }
               }
 
-            assert_equal(200, response.status)
+            assert_equal(422, response.status)
           end
         end
       end

data/storefront/workarea-api-storefront.gemspec

@@ -14,6 +14,6 @@ Gem::Specification.new do |s|
 
   s.required_ruby_version = '>= 2.3.0'
 
-  s.add_dependency 'workarea', '~> 3.x', '>= 3.2.x'
-  s.add_dependency 'responders', '~> 2.4.0'
+  s.add_dependency 'workarea', '~> 3.x', '>= 3.5.x'
+  s.add_dependency 'responders', '~> 3.0.0'
 end

data/workarea-api.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |s|
 
   s.required_ruby_version = '>= 2.3.0'
 
-  s.add_dependency 'workarea', '~> 3.x', '>= 3.4.x'
+  s.add_dependency 'workarea', '~> 3.x', '>= 3.5.x'
   s.add_dependency 'workarea-api-storefront', Workarea::Api::VERSION
   s.add_dependency 'workarea-api-admin', Workarea::Api::VERSION
   s.add_dependency 'raddocs', '~> 2.2.0'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: workarea-api
 version: !ruby/object:Gem::Version
-  version: 4.5.0
+  version: 4.5.6
 platform: ruby
 authors:
 - Ben Crouse
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-27 00:00:00.000000000 Z
+date: 2020-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: workarea
@@ -20,7 +20,7 @@ dependencies:
         version: 3.x
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.4.x
+        version: 3.5.x
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -30,35 +30,35 @@ dependencies:
         version: 3.x
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.4.x
+        version: 3.5.x
 - !ruby/object:Gem::Dependency
   name: workarea-api-storefront
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.5.0
+        version: 4.5.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.5.0
+        version: 4.5.6
 - !ruby/object:Gem::Dependency
   name: workarea-api-admin
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.5.0
+        version: 4.5.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.5.0
+        version: 4.5.6
 - !ruby/object:Gem::Dependency
   name: raddocs
   requirement: !ruby/object:Gem::Requirement
@@ -163,6 +163,7 @@ files:
 - admin/config/locales/en.yml
 - admin/config/routes.rb
 - admin/lib/workarea/api/admin.rb
+- admin/lib/workarea/api/admin/date_indexes.rb
 - admin/lib/workarea/api/admin/engine.rb
 - admin/lib/workarea/api/admin/swagger.rb
 - admin/test/documentation/workarea/api/admin/categories_documentation_test.rb
@@ -332,10 +333,18 @@ files:
 - doc/api/admin/discounts/updating_discounts.json
 - doc/api/admin/email_signups/listing_email_signups.json
 - doc/api/admin/email_signups/showing_an_email_signup.json
+- doc/api/admin/email_signups/showing_an_email_signup_by_email.json
+- doc/api/admin/email_signups/showing_an_email_signup_by_id.json
 - doc/api/admin/fulfillment/listing_fulfillments.json
 - doc/api/admin/fulfillment/marking_items_as_canceled.json
 - doc/api/admin/fulfillment/marking_items_as_shipped.json
 - doc/api/admin/fulfillment/showing_fulfillment.json
+- doc/api/admin/global_functionality/dealing_with_locales.json
+- doc/api/admin/global_functionality/filtering_by_created_at_time_stamp.json
+- doc/api/admin/global_functionality/filtering_by_updated_time_stamp.json
+- doc/api/admin/global_functionality/paging_results.json
+- doc/api/admin/global_functionality/retrieving_addtional_pages_of_results.json
+- doc/api/admin/global_functionality/sorting_results.json
 - doc/api/admin/index.json
 - doc/api/admin/inventory_skus/bulk_upserting_inventory_skus.json
 - doc/api/admin/inventory_skus/creating_an_inventory_sku.json
@@ -356,6 +365,7 @@ files:
 - doc/api/admin/navigation_taxonomy/updating_a_navigation_taxons.json
 - doc/api/admin/orders/listing_orders.json
 - doc/api/admin/orders/showing_an_order.json
+- doc/api/admin/orders/viewing_orders_by_date_range.json
 - doc/api/admin/pages/bulk_upserting_pages.json
 - doc/api/admin/pages/creating_a_page.json
 - doc/api/admin/pages/listing_pages.json
@@ -449,6 +459,8 @@ files:
 - doc/api/admin/users/listing_users.json
 - doc/api/admin/users/removing_a_user.json
 - doc/api/admin/users/showing_a_user.json
+- doc/api/admin/users/showing_a_user_by_email.json
+- doc/api/admin/users/showing_a_user_by_id.json
 - doc/api/admin/users/updating_a_user.json
 - doc/api/admin/variants/creating_a_product_variant.json
 - doc/api/admin/variants/listing_product_variants.json
@@ -475,6 +487,7 @@ files:
 - doc/api/storefront/categories/showing_a_category.json
 - doc/api/storefront/categories/showing_a_listing_of_categories.json
 - doc/api/storefront/checkout/completing_a_checkout.json
+- doc/api/storefront/checkout/failure_to_update_a_checkout.json
 - doc/api/storefront/checkout/showing_a_checkout.json
 - doc/api/storefront/checkout/updating_a_checkout.json
 - doc/api/storefront/contacts/creating_a_contact.json
@@ -514,6 +527,7 @@ files:
 - doc/api/storefront/taxons/showing_a_taxon.json
 - doc/api/storefront/validation_errors/checkout_validation_errors.json
 - doc/api/storefront/validation_errors/general_validation_errors.json
+- lib/tasks/docs.rake
 - lib/workarea/api.rb
 - lib/workarea/api/curl.rb
 - lib/workarea/api/documentation.rb
@@ -743,7 +757,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Adds a JSON REST API to the Workarea Commerce Platform