workarea-api 4.4.6

data/doc/api/admin/tax_categories/showing_a_tax_category.json

@@ -0,0 +1,44 @@
+{
+  "parameters": [
+
+  ],
+  "response_fields": [
+
+  ],
+  "requests": [
+    {
+      "request_headers": {
+      },
+      "request_query_parameters": {
+      },
+      "response_headers": {
+        "X-Frame-Options": "SAMEORIGIN",
+        "X-XSS-Protection": "1; mode=block",
+        "X-Content-Type-Options": "nosniff",
+        "X-Download-Options": "noopen",
+        "X-Permitted-Cross-Domain-Policies": "none",
+        "Referrer-Policy": "strict-origin-when-cross-origin",
+        "Content-Type": "application/json; charset=utf-8",
+        "ETag": "W/\"42b0dce6b342e3e54776f9a5daac854f\"",
+        "Cache-Control": "no-cache, no-store, must-revalidate",
+        "X-Request-Id": "13c475cc-137f-47dd-b944-5c6b2ecb2859",
+        "X-Runtime": "0.003804",
+        "Expires": "0",
+        "Content-Length": "161"
+      },
+      "request_method": "GET",
+      "request_path": "/api/admin/tax_categories/5d5dbd32d4322a4b69d78e1f",
+      "request_body": null,
+      "request_content_type": null,
+      "response_status": 200,
+      "response_status_text": "OK",
+      "response_body": "{\n  \"tax_category\": {\n    \"_id\": \"5d5dbd32d4322a4b69d78e1f\",\n    \"code\": \"32\",\n    \"created_at\": \"2019-08-21T21:52:50.169Z\",\n    \"name\": \"Clothing\",\n    \"updated_at\": \"2019-08-21T21:52:50.169Z\"\n  }\n}",
+      "response_content_type": "application/json",
+      "curl": "curl -g \"https://www.example.com/api/admin/tax_categories/5d5dbd32d4322a4b69d78e1f\" -X GET "
+    }
+  ],
+  "resource": "Tax Categories",
+  "description": "Showing a tax category",
+  "route": "/api/admin/tax_categories/:id",
+  "http_method": "GET"
+}

data/doc/api/admin/tax_categories/updating_a_tax_categories.json

@@ -0,0 +1,42 @@
+{
+  "parameters": [
+
+  ],
+  "response_fields": [
+
+  ],
+  "requests": [
+    {
+      "request_headers": {
+        "Content-Type": "application/json"
+      },
+      "request_query_parameters": {
+      },
+      "response_headers": {
+        "X-Frame-Options": "SAMEORIGIN",
+        "X-XSS-Protection": "1; mode=block",
+        "X-Content-Type-Options": "nosniff",
+        "X-Download-Options": "noopen",
+        "X-Permitted-Cross-Domain-Policies": "none",
+        "Referrer-Policy": "strict-origin-when-cross-origin",
+        "Cache-Control": "no-cache, no-store, must-revalidate",
+        "X-Request-Id": "8f2f73d7-3419-4d08-bcc7-5facc7667272",
+        "X-Runtime": "0.008818",
+        "Expires": "0"
+      },
+      "request_method": "PATCH",
+      "request_path": "/api/admin/tax_categories/5d5dbd31d4322a4b69d78e12",
+      "request_body": "{\"tax_category\":{\"name\":\"foo\"}}",
+      "request_content_type": "application/json",
+      "response_status": 204,
+      "response_status_text": "No Content",
+      "response_body": null,
+      "response_content_type": null,
+      "curl": "curl \"https://www.example.com/api/admin/tax_categories/5d5dbd31d4322a4b69d78e12\" -d '{\"tax_category\":{\"name\":\"foo\"}}' -X PATCH \\\n\t-H \"Content-Type: application/json\""
+    }
+  ],
+  "resource": "Tax Categories",
+  "description": "Updating a tax categories",
+  "route": "/api/admin/tax_categories/:id",
+  "http_method": "PATCH"
+}

data/doc/api/admin/tax_rates/creating_a_tax_rate.json

@@ -0,0 +1,46 @@
+{
+  "parameters": [
+
+  ],
+  "response_fields": [
+
+  ],
+  "requests": [
+    {
+      "request_headers": {
+        "Content-Type": "application/json"
+      },
+      "request_query_parameters": {
+      },
+      "response_headers": {
+        "X-Frame-Options": "SAMEORIGIN",
+        "X-XSS-Protection": "1; mode=block",
+        "X-Content-Type-Options": "nosniff",
+        "X-Download-Options": "noopen",
+        "X-Permitted-Cross-Domain-Policies": "none",
+        "Referrer-Policy": "strict-origin-when-cross-origin",
+        "Location": "/api/admin/tax_categories/5d5dbcced4322a4b69d78944/rates/5d5dbcced4322a4b69d78945",
+        "Content-Type": "application/json; charset=utf-8",
+        "ETag": "W/\"e6de92c0e210c4debd8c7675c827866c\"",
+        "Cache-Control": "no-cache, no-store, must-revalidate",
+        "X-Request-Id": "fd61d800-c116-4c5a-8a19-747008314782",
+        "X-Runtime": "0.009738",
+        "Expires": "0",
+        "Content-Length": "288"
+      },
+      "request_method": "POST",
+      "request_path": "/api/admin/tax_categories/5d5dbcced4322a4b69d78944/rates",
+      "request_body": "{\"rate\":{\"category_id\":\"5d5dbcced4322a4b69d78944\",\"charge_on_shipping\":true,\"country\":\"US\",\"created_at\":\"2019-08-21T21:51:10.142Z\",\"percentage\":0.06,\"postal_code\":null,\"region\":\"PA\",\"tier_max\":null,\"tier_min\":null,\"updated_at\":\"2019-08-21T21:51:10.142Z\"}}",
+      "request_content_type": "application/json",
+      "response_status": 201,
+      "response_status_text": "Created",
+      "response_body": "{\n  \"rate\": {\n    \"_id\": \"5d5dbcced4322a4b69d78945\",\n    \"category_id\": \"5d5dbcced4322a4b69d78944\",\n    \"charge_on_shipping\": true,\n    \"country\": \"US\",\n    \"created_at\": \"2019-08-21T21:51:10.142Z\",\n    \"percentage\": 0.06,\n    \"postal_code\": null,\n    \"region\": \"PA\",\n    \"tier_max\": null,\n    \"tier_min\": null,\n    \"updated_at\": \"2019-08-21T21:51:10.142Z\"\n  }\n}",
+      "response_content_type": "application/json",
+      "curl": "curl \"https://www.example.com/api/admin/tax_categories/5d5dbcced4322a4b69d78944/rates\" -d '{\"rate\":{\"category_id\":\"5d5dbcced4322a4b69d78944\",\"charge_on_shipping\":true,\"country\":\"US\",\"created_at\":\"2019-08-21T21:51:10.142Z\",\"percentage\":0.06,\"postal_code\":null,\"region\":\"PA\",\"tier_max\":null,\"tier_min\":null,\"updated_at\":\"2019-08-21T21:51:10.142Z\"}}' -X POST \\\n\t-H \"Content-Type: application/json\""
+    }
+  ],
+  "resource": "Tax Rates",
+  "description": "Creating a tax rate",
+  "route": "/api/admin/tax_categories/:tax_category_id/rates",
+  "http_method": "POST"
+}

data/doc/api/admin/tax_rates/listing_tax_rates.json

@@ -0,0 +1,44 @@
+{
+  "parameters": [
+
+  ],
+  "response_fields": [
+
+  ],
+  "requests": [
+    {
+      "request_headers": {
+      },
+      "request_query_parameters": {
+      },
+      "response_headers": {
+        "X-Frame-Options": "SAMEORIGIN",
+        "X-XSS-Protection": "1; mode=block",
+        "X-Content-Type-Options": "nosniff",
+        "X-Download-Options": "noopen",
+        "X-Permitted-Cross-Domain-Policies": "none",
+        "Referrer-Policy": "strict-origin-when-cross-origin",
+        "Content-Type": "application/json; charset=utf-8",
+        "ETag": "W/\"95c5f7eb247fe49d47124a59477a6787\"",
+        "Cache-Control": "no-cache, no-store, must-revalidate",
+        "X-Request-Id": "a78ecada-5fe9-474f-b37f-9ece884dd74f",
+        "X-Runtime": "0.005613",
+        "Expires": "0",
+        "Content-Length": "851"
+      },
+      "request_method": "GET",
+      "request_path": "/api/admin/tax_categories/5d5dbcccd4322a4b69d78936/rates",
+      "request_body": null,
+      "request_content_type": null,
+      "response_status": 200,
+      "response_status_text": "OK",
+      "response_body": "{\n  \"rates\": [\n    {\n      \"_id\": \"5d5dbcccd4322a4b69d78935\",\n      \"category_id\": \"5d5dbcccd4322a4b69d78936\",\n      \"charge_on_shipping\": true,\n      \"country\": \"US\",\n      \"created_at\": \"2019-08-21T21:51:08.994Z\",\n      \"percentage\": 0.06,\n      \"postal_code\": null,\n      \"region\": \"PA\",\n      \"tier_max\": null,\n      \"tier_min\": null,\n      \"updated_at\": \"2019-08-21T21:51:08.994Z\"\n    },\n    {\n      \"_id\": \"5d5dbcccd4322a4b69d78937\",\n      \"category_id\": \"5d5dbcccd4322a4b69d78936\",\n      \"charge_on_shipping\": true,\n      \"country\": \"US\",\n      \"created_at\": \"2019-08-21T21:51:08.994Z\",\n      \"percentage\": 0.06,\n      \"postal_code\": null,\n      \"region\": \"PA\",\n      \"tier_max\": null,\n      \"tier_min\": null,\n      \"updated_at\": \"2019-08-21T21:51:08.994Z\"\n    },\n    {\n      \"_id\": \"5d5dbcccd4322a4b69d78938\",\n      \"category_id\": \"5d5dbcccd4322a4b69d78936\",\n      \"charge_on_shipping\": true,\n      \"country\": \"US\",\n      \"created_at\": \"2019-08-21T21:51:08.994Z\",\n      \"percentage\": 0.06,\n      \"postal_code\": null,\n      \"region\": \"PA\",\n      \"tier_max\": null,\n      \"tier_min\": null,\n      \"updated_at\": \"2019-08-21T21:51:08.994Z\"\n    }\n  ]\n}",
+      "response_content_type": "application/json",
+      "curl": "curl -g \"https://www.example.com/api/admin/tax_categories/5d5dbcccd4322a4b69d78936/rates\" -X GET "
+    }
+  ],
+  "resource": "Tax Rates",
+  "description": "Listing tax rates",
+  "route": "/api/admin/tax_categories/:tax_category_id/rates",
+  "http_method": "GET"
+}

data/doc/api/admin/tax_rates/removing_a_tax_rate.json

@@ -0,0 +1,42 @@
+{
+  "parameters": [
+
+  ],
+  "response_fields": [
+
+  ],
+  "requests": [
+    {
+      "request_headers": {
+        "Content-Type": "application/x-www-form-urlencoded"
+      },
+      "request_query_parameters": {
+      },
+      "response_headers": {
+        "X-Frame-Options": "SAMEORIGIN",
+        "X-XSS-Protection": "1; mode=block",
+        "X-Content-Type-Options": "nosniff",
+        "X-Download-Options": "noopen",
+        "X-Permitted-Cross-Domain-Policies": "none",
+        "Referrer-Policy": "strict-origin-when-cross-origin",
+        "Cache-Control": "no-cache, no-store, must-revalidate",
+        "X-Request-Id": "d2b1e7b1-08c7-473b-b378-7d74b9480449",
+        "X-Runtime": "0.007095",
+        "Expires": "0"
+      },
+      "request_method": "PATCH",
+      "request_path": "/api/admin/tax_categories/5d5dbcced4322a4b69d7894b/rates/5d5dbcced4322a4b69d7894c",
+      "request_body": null,
+      "request_content_type": "application/x-www-form-urlencoded",
+      "response_status": 204,
+      "response_status_text": "No Content",
+      "response_body": null,
+      "response_content_type": null,
+      "curl": "curl \"https://www.example.com/api/admin/tax_categories/5d5dbcced4322a4b69d7894b/rates/5d5dbcced4322a4b69d7894c\" -d '' -X PATCH \\\n\t-H \"Content-Type: application/x-www-form-urlencoded\""
+    }
+  ],
+  "resource": "Tax Rates",
+  "description": "Removing a tax rate",
+  "route": "/api/admin/tax_categories/:tax_category_id/rates/:id",
+  "http_method": "PATCH"
+}

data/doc/api/admin/tax_rates/updating_a_tax_rate.json

@@ -0,0 +1,42 @@
+{
+  "parameters": [
+
+  ],
+  "response_fields": [
+
+  ],
+  "requests": [
+    {
+      "request_headers": {
+        "Content-Type": "application/json"
+      },
+      "request_query_parameters": {
+      },
+      "response_headers": {
+        "X-Frame-Options": "SAMEORIGIN",
+        "X-XSS-Protection": "1; mode=block",
+        "X-Content-Type-Options": "nosniff",
+        "X-Download-Options": "noopen",
+        "X-Permitted-Cross-Domain-Policies": "none",
+        "Referrer-Policy": "strict-origin-when-cross-origin",
+        "Cache-Control": "no-cache, no-store, must-revalidate",
+        "X-Request-Id": "537b860e-f50f-46a2-a30d-7c3ae4cd95c4",
+        "X-Runtime": "0.010097",
+        "Expires": "0"
+      },
+      "request_method": "PATCH",
+      "request_path": "/api/admin/tax_categories/5d5dbccdd4322a4b69d7893d/rates/5d5dbccdd4322a4b69d7893e",
+      "request_body": "{\"rate\":{\"percentage\":0.04}}",
+      "request_content_type": "application/json",
+      "response_status": 204,
+      "response_status_text": "No Content",
+      "response_body": null,
+      "response_content_type": null,
+      "curl": "curl \"https://www.example.com/api/admin/tax_categories/5d5dbccdd4322a4b69d7893d/rates/5d5dbccdd4322a4b69d7893e\" -d '{\"rate\":{\"percentage\":0.04}}' -X PATCH \\\n\t-H \"Content-Type: application/json\""
+    }
+  ],
+  "resource": "Tax Rates",
+  "description": "Updating a tax rate",
+  "route": "/api/admin/tax_categories/:tax_category_id/rates/:id",
+  "http_method": "PATCH"
+}

data/doc/api/admin/users/bulk_upserting_users.json

@@ -0,0 +1,42 @@
+{
+  "parameters": [
+
+  ],
+  "response_fields": [
+
+  ],
+  "requests": [
+    {
+      "request_headers": {
+        "Content-Type": "application/json"
+      },
+      "request_query_parameters": {
+      },
+      "response_headers": {
+        "X-Frame-Options": "SAMEORIGIN",
+        "X-XSS-Protection": "1; mode=block",
+        "X-Content-Type-Options": "nosniff",
+        "X-Download-Options": "noopen",
+        "X-Permitted-Cross-Domain-Policies": "none",
+        "Referrer-Policy": "strict-origin-when-cross-origin",
+        "Cache-Control": "no-cache, no-store, must-revalidate",
+        "X-Request-Id": "a85b052d-467d-4e50-ad64-32cc957e5319",
+        "X-Runtime": "1.442258",
+        "Expires": "0"
+      },
+      "request_method": "PATCH",
+      "request_path": "/api/admin/users/bulk",
+      "request_body": "{\"users\":[{\"admin\":false,\"api_access\":false,\"avatar_name\":null,\"avatar_uid\":null,\"can_publish_now\":null,\"can_restore\":null,\"catalog_access\":false,\"created_at\":\"2019-08-21T21:56:02.804Z\",\"created_by_id\":null,\"email\":\"user1@workarea.com\",\"failed_login_count\":0,\"first_name\":\"Ben\",\"help_admin\":false,\"ip_address\":null,\"last_impersonated_at\":null,\"last_impersonated_by_id\":null,\"last_login_at\":null,\"last_login_attempt_at\":null,\"last_name\":\"Crouse\",\"marketing_access\":false,\"orders_access\":false,\"password_changed_at\":\"2019-08-21T21:56:02.803Z\",\"people_access\":false,\"permissions_manager\":false,\"releases_access\":false,\"reports_access\":false,\"search_access\":false,\"settings_access\":false,\"status_email_recipient\":false,\"store_access\":false,\"subscribed_user_ids\":[],\"tags\":[],\"updated_at\":\"2019-08-21T21:56:02.804Z\",\"user_agent\":null,\"password\":\"p@ssw0rd\"},{\"admin\":false,\"api_access\":false,\"avatar_name\":null,\"avatar_uid\":null,\"can_publish_now\":null,\"can_restore\":null,\"catalog_access\":false,\"created_at\":\"2019-08-21T21:56:02.804Z\",\"created_by_id\":null,\"email\":\"user1@workarea.com\",\"failed_login_count\":0,\"first_name\":\"Ben\",\"help_admin\":false,\"ip_address\":null,\"last_impersonated_at\":null,\"last_impersonated_by_id\":null,\"last_login_at\":null,\"last_login_attempt_at\":null,\"last_name\":\"Crouse\",\"marketing_access\":false,\"orders_access\":false,\"password_changed_at\":\"2019-08-21T21:56:02.803Z\",\"people_access\":false,\"permissions_manager\":false,\"releases_access\":false,\"reports_access\":false,\"search_access\":false,\"settings_access\":false,\"status_email_recipient\":false,\"store_access\":false,\"subscribed_user_ids\":[],\"tags\":[],\"updated_at\":\"2019-08-21T21:56:02.804Z\",\"user_agent\":null,\"password\":\"p@ssw0rd\"},{\"admin\":false,\"api_access\":false,\"avatar_name\":null,\"avatar_uid\":null,\"can_publish_now\":null,\"can_restore\":null,\"catalog_access\":false,\"created_at\":\"2019-08-21T21:56:02.804Z\",\"created_by_id\":null,\"email\":\"user1@workarea.com\",\"failed_login_count\":0,\"first_name\":\"Ben\",\"help_admin\":false,\"ip_address\":null,\"last_impersonated_at\":null,\"last_impersonated_by_id\":null,\"last_login_at\":null,\"last_login_attempt_at\":null,\"last_name\":\"Crouse\",\"marketing_access\":false,\"orders_access\":false,\"password_changed_at\":\"2019-08-21T21:56:02.803Z\",\"people_access\":false,\"permissions_manager\":false,\"releases_access\":false,\"reports_access\":false,\"search_access\":false,\"settings_access\":false,\"status_email_recipient\":false,\"store_access\":false,\"subscribed_user_ids\":[],\"tags\":[],\"updated_at\":\"2019-08-21T21:56:02.804Z\",\"user_agent\":null,\"password\":\"p@ssw0rd\"}]}",
+      "request_content_type": "application/json",
+      "response_status": 204,
+      "response_status_text": "No Content",
+      "response_body": null,
+      "response_content_type": null,
+      "curl": "curl \"https://www.example.com/api/admin/users/bulk\" -d '{\"users\":[{\"admin\":false,\"api_access\":false,\"avatar_name\":null,\"avatar_uid\":null,\"can_publish_now\":null,\"can_restore\":null,\"catalog_access\":false,\"created_at\":\"2019-08-21T21:56:02.804Z\",\"created_by_id\":null,\"email\":\"user1@workarea.com\",\"failed_login_count\":0,\"first_name\":\"Ben\",\"help_admin\":false,\"ip_address\":null,\"last_impersonated_at\":null,\"last_impersonated_by_id\":null,\"last_login_at\":null,\"last_login_attempt_at\":null,\"last_name\":\"Crouse\",\"marketing_access\":false,\"orders_access\":false,\"password_changed_at\":\"2019-08-21T21:56:02.803Z\",\"people_access\":false,\"permissions_manager\":false,\"releases_access\":false,\"reports_access\":false,\"search_access\":false,\"settings_access\":false,\"status_email_recipient\":false,\"store_access\":false,\"subscribed_user_ids\":[],\"tags\":[],\"updated_at\":\"2019-08-21T21:56:02.804Z\",\"user_agent\":null,\"password\":\"p@ssw0rd\"},{\"admin\":false,\"api_access\":false,\"avatar_name\":null,\"avatar_uid\":null,\"can_publish_now\":null,\"can_restore\":null,\"catalog_access\":false,\"created_at\":\"2019-08-21T21:56:02.804Z\",\"created_by_id\":null,\"email\":\"user1@workarea.com\",\"failed_login_count\":0,\"first_name\":\"Ben\",\"help_admin\":false,\"ip_address\":null,\"last_impersonated_at\":null,\"last_impersonated_by_id\":null,\"last_login_at\":null,\"last_login_attempt_at\":null,\"last_name\":\"Crouse\",\"marketing_access\":false,\"orders_access\":false,\"password_changed_at\":\"2019-08-21T21:56:02.803Z\",\"people_access\":false,\"permissions_manager\":false,\"releases_access\":false,\"reports_access\":false,\"search_access\":false,\"settings_access\":false,\"status_email_recipient\":false,\"store_access\":false,\"subscribed_user_ids\":[],\"tags\":[],\"updated_at\":\"2019-08-21T21:56:02.804Z\",\"user_agent\":null,\"password\":\"p@ssw0rd\"},{\"admin\":false,\"api_access\":false,\"avatar_name\":null,\"avatar_uid\":null,\"can_publish_now\":null,\"can_restore\":null,\"catalog_access\":false,\"created_at\":\"2019-08-21T21:56:02.804Z\",\"created_by_id\":null,\"email\":\"user1@workarea.com\",\"failed_login_count\":0,\"first_name\":\"Ben\",\"help_admin\":false,\"ip_address\":null,\"last_impersonated_at\":null,\"last_impersonated_by_id\":null,\"last_login_at\":null,\"last_login_attempt_at\":null,\"last_name\":\"Crouse\",\"marketing_access\":false,\"orders_access\":false,\"password_changed_at\":\"2019-08-21T21:56:02.803Z\",\"people_access\":false,\"permissions_manager\":false,\"releases_access\":false,\"reports_access\":false,\"search_access\":false,\"settings_access\":false,\"status_email_recipient\":false,\"store_access\":false,\"subscribed_user_ids\":[],\"tags\":[],\"updated_at\":\"2019-08-21T21:56:02.804Z\",\"user_agent\":null,\"password\":\"p@ssw0rd\"}]}' -X PATCH \\\n\t-H \"Content-Type: application/json\""
+    }
+  ],
+  "resource": "Users",
+  "description": "Bulk upserting users",
+  "route": "/api/admin/users/bulk",
+  "http_method": "PATCH"
+}

data/doc/api/admin/users/creating_a_user.json

@@ -0,0 +1,46 @@
+{
+  "parameters": [
+
+  ],
+  "response_fields": [
+
+  ],
+  "requests": [
+    {
+      "request_headers": {
+        "Content-Type": "application/json"
+      },
+      "request_query_parameters": {
+      },
+      "response_headers": {
+        "X-Frame-Options": "SAMEORIGIN",
+        "X-XSS-Protection": "1; mode=block",
+        "X-Content-Type-Options": "nosniff",
+        "X-Download-Options": "noopen",
+        "X-Permitted-Cross-Domain-Policies": "none",
+        "Referrer-Policy": "strict-origin-when-cross-origin",
+        "Location": "/api/admin/users/5d5dbdf5d4322a4b69d799e4",
+        "Content-Type": "application/json; charset=utf-8",
+        "ETag": "W/\"967ce4b5607be2e4d42270d000d87742\"",
+        "Cache-Control": "no-cache, no-store, must-revalidate",
+        "X-Request-Id": "0bc1cc0e-7c94-4597-921a-f83c26390322",
+        "X-Runtime": "0.272085",
+        "Expires": "0",
+        "Content-Length": "896"
+      },
+      "request_method": "POST",
+      "request_path": "/api/admin/users",
+      "request_body": "{\"user\":{\"admin\":false,\"api_access\":false,\"avatar_name\":null,\"avatar_uid\":null,\"can_publish_now\":null,\"can_restore\":null,\"catalog_access\":false,\"created_at\":\"2019-08-21T21:56:05.074Z\",\"created_by_id\":null,\"email\":\"user1@workarea.com\",\"failed_login_count\":0,\"first_name\":\"Ben\",\"help_admin\":false,\"ip_address\":null,\"last_impersonated_at\":null,\"last_impersonated_by_id\":null,\"last_login_at\":null,\"last_login_attempt_at\":null,\"last_name\":\"Crouse\",\"marketing_access\":false,\"orders_access\":false,\"password_changed_at\":\"2019-08-21T21:56:05.073Z\",\"people_access\":false,\"permissions_manager\":false,\"releases_access\":false,\"reports_access\":false,\"search_access\":false,\"settings_access\":false,\"status_email_recipient\":false,\"store_access\":false,\"subscribed_user_ids\":[],\"tags\":[],\"updated_at\":\"2019-08-21T21:56:05.074Z\",\"user_agent\":null,\"password\":\"p@ssw0rd\"}}",
+      "request_content_type": "application/json",
+      "response_status": 201,
+      "response_status_text": "Created",
+      "response_body": "{\n  \"user\": {\n    \"_id\": \"5d5dbdf5d4322a4b69d799e4\",\n    \"admin\": false,\n    \"api_access\": false,\n    \"avatar_name\": null,\n    \"avatar_uid\": null,\n    \"can_publish_now\": null,\n    \"can_restore\": null,\n    \"catalog_access\": false,\n    \"created_at\": \"2019-08-21T21:56:05.074Z\",\n    \"created_by_id\": null,\n    \"email\": \"user1@workarea.com\",\n    \"failed_login_count\": 0,\n    \"first_name\": \"Ben\",\n    \"help_admin\": false,\n    \"ip_address\": null,\n    \"last_impersonated_at\": null,\n    \"last_impersonated_by_id\": null,\n    \"last_login_at\": null,\n    \"last_login_attempt_at\": null,\n    \"last_name\": \"Crouse\",\n    \"marketing_access\": false,\n    \"orders_access\": false,\n    \"password_changed_at\": \"2019-08-21T21:56:05.337Z\",\n    \"people_access\": false,\n    \"permissions_manager\": false,\n    \"releases_access\": false,\n    \"reports_access\": false,\n    \"search_access\": false,\n    \"settings_access\": false,\n    \"status_email_recipient\": false,\n    \"store_access\": false,\n    \"subscribed_user_ids\": [\n\n    ],\n    \"tags\": [\n\n    ],\n    \"token\": \"uFyd3hJ5eBAZS2Nd94duRn1G\",\n    \"updated_at\": \"2019-08-21T21:56:05.074Z\",\n    \"user_agent\": null\n  }\n}",
+      "response_content_type": "application/json",
+      "curl": "curl \"https://www.example.com/api/admin/users\" -d '{\"user\":{\"admin\":false,\"api_access\":false,\"avatar_name\":null,\"avatar_uid\":null,\"can_publish_now\":null,\"can_restore\":null,\"catalog_access\":false,\"created_at\":\"2019-08-21T21:56:05.074Z\",\"created_by_id\":null,\"email\":\"user1@workarea.com\",\"failed_login_count\":0,\"first_name\":\"Ben\",\"help_admin\":false,\"ip_address\":null,\"last_impersonated_at\":null,\"last_impersonated_by_id\":null,\"last_login_at\":null,\"last_login_attempt_at\":null,\"last_name\":\"Crouse\",\"marketing_access\":false,\"orders_access\":false,\"password_changed_at\":\"2019-08-21T21:56:05.073Z\",\"people_access\":false,\"permissions_manager\":false,\"releases_access\":false,\"reports_access\":false,\"search_access\":false,\"settings_access\":false,\"status_email_recipient\":false,\"store_access\":false,\"subscribed_user_ids\":[],\"tags\":[],\"updated_at\":\"2019-08-21T21:56:05.074Z\",\"user_agent\":null,\"password\":\"p@ssw0rd\"}}' -X POST \\\n\t-H \"Content-Type: application/json\""
+    }
+  ],
+  "resource": "Users",
+  "description": "Creating a user",
+  "route": "/api/admin/users",
+  "http_method": "POST"
+}

data/doc/api/admin/users/listing_users.json

@@ -0,0 +1,58 @@
+{
+  "parameters": [
+    {
+      "name": "page",
+      "description": "Current page"
+    },
+    {
+      "name": "sort_by",
+      "description": "Field on which to sort (see responses for possible values)"
+    },
+    {
+      "name": "sort_direction",
+      "description": "Direction to sort (asc or desc)"
+    }
+  ],
+  "response_fields": [
+
+  ],
+  "requests": [
+    {
+      "request_headers": {
+      },
+      "request_query_parameters": {
+        "page": "1",
+        "sort_by": "created_at",
+        "sort_direction": "desc"
+      },
+      "response_headers": {
+        "X-Frame-Options": "SAMEORIGIN",
+        "X-XSS-Protection": "1; mode=block",
+        "X-Content-Type-Options": "nosniff",
+        "X-Download-Options": "noopen",
+        "X-Permitted-Cross-Domain-Policies": "none",
+        "Referrer-Policy": "strict-origin-when-cross-origin",
+        "Content-Type": "application/json; charset=utf-8",
+        "ETag": "W/\"4a02bfeea619bd629c2bf58dbf614fec\"",
+        "Cache-Control": "no-cache, no-store, must-revalidate",
+        "X-Request-Id": "0f2aa681-a5bd-424c-aaa1-882a3e30f9bf",
+        "X-Runtime": "0.009118",
+        "Expires": "0",
+        "Content-Length": "2668"
+      },
+      "request_method": "GET",
+      "request_path": "/api/admin/users?page=1&sort_by=created_at&sort_direction=desc",
+      "request_body": null,
+      "request_content_type": null,
+      "response_status": 200,
+      "response_status_text": "OK",
+      "response_body": "{\n  \"users\": [\n    {\n      \"_id\": \"5d5dbdf1d4322a4b69d799cb\",\n      \"admin\": false,\n      \"api_access\": false,\n      \"avatar_name\": null,\n      \"avatar_uid\": null,\n      \"can_publish_now\": null,\n      \"can_restore\": null,\n      \"catalog_access\": false,\n      \"created_at\": \"2019-08-21T21:56:01.962Z\",\n      \"created_by_id\": null,\n      \"email\": \"user384@workarea.com\",\n      \"failed_login_count\": 0,\n      \"first_name\": \"Ben\",\n      \"help_admin\": false,\n      \"ip_address\": null,\n      \"last_impersonated_at\": null,\n      \"last_impersonated_by_id\": null,\n      \"last_login_at\": null,\n      \"last_login_attempt_at\": null,\n      \"last_name\": \"Crouse\",\n      \"marketing_access\": false,\n      \"orders_access\": false,\n      \"password_changed_at\": \"2019-08-21T21:56:01.961Z\",\n      \"people_access\": false,\n      \"permissions_manager\": false,\n      \"releases_access\": false,\n      \"reports_access\": false,\n      \"search_access\": false,\n      \"settings_access\": false,\n      \"status_email_recipient\": false,\n      \"store_access\": false,\n      \"subscribed_user_ids\": [\n\n      ],\n      \"tags\": [\n\n      ],\n      \"token\": \"kTNjuK9gQaJHFKkNLZsSc7n8\",\n      \"updated_at\": \"2019-08-21T21:56:01.962Z\",\n      \"user_agent\": null\n    },\n    {\n      \"_id\": \"5d5dbdf1d4322a4b69d799c9\",\n      \"admin\": false,\n      \"api_access\": false,\n      \"avatar_name\": null,\n      \"avatar_uid\": null,\n      \"can_publish_now\": null,\n      \"can_restore\": null,\n      \"catalog_access\": false,\n      \"created_at\": \"2019-08-21T21:56:01.699Z\",\n      \"created_by_id\": null,\n      \"email\": \"user383@workarea.com\",\n      \"failed_login_count\": 0,\n      \"first_name\": \"Ben\",\n      \"help_admin\": false,\n      \"ip_address\": null,\n      \"last_impersonated_at\": null,\n      \"last_impersonated_by_id\": null,\n      \"last_login_at\": null,\n      \"last_login_attempt_at\": null,\n      \"last_name\": \"Crouse\",\n      \"marketing_access\": false,\n      \"orders_access\": false,\n      \"password_changed_at\": \"2019-08-21T21:56:01.699Z\",\n      \"people_access\": false,\n      \"permissions_manager\": false,\n      \"releases_access\": false,\n      \"reports_access\": false,\n      \"search_access\": false,\n      \"settings_access\": false,\n      \"status_email_recipient\": false,\n      \"store_access\": false,\n      \"subscribed_user_ids\": [\n\n      ],\n      \"tags\": [\n\n      ],\n      \"token\": \"5LFiSSrsPiB93x2JUnV7UDEF\",\n      \"updated_at\": \"2019-08-21T21:56:01.699Z\",\n      \"user_agent\": null\n    },\n    {\n      \"_id\": \"5d5dbdf1d4322a4b69d799c7\",\n      \"admin\": true,\n      \"api_access\": true,\n      \"avatar_name\": null,\n      \"avatar_uid\": null,\n      \"can_publish_now\": true,\n      \"can_restore\": true,\n      \"catalog_access\": true,\n      \"created_at\": \"2019-08-21T21:56:01.420Z\",\n      \"created_by_id\": null,\n      \"email\": \"user382@workarea.com\",\n      \"failed_login_count\": 0,\n      \"first_name\": \"Ben\",\n      \"help_admin\": true,\n      \"ip_address\": null,\n      \"last_impersonated_at\": null,\n      \"last_impersonated_by_id\": null,\n      \"last_login_at\": null,\n      \"last_login_attempt_at\": null,\n      \"last_name\": \"Crouse\",\n      \"marketing_access\": true,\n      \"orders_access\": true,\n      \"password_changed_at\": \"2019-08-21T21:56:01.420Z\",\n      \"people_access\": true,\n      \"permissions_manager\": true,\n      \"releases_access\": true,\n      \"reports_access\": true,\n      \"search_access\": true,\n      \"settings_access\": true,\n      \"status_email_recipient\": false,\n      \"store_access\": true,\n      \"subscribed_user_ids\": [\n\n      ],\n      \"tags\": [\n\n      ],\n      \"token\": \"R5PeK5CG1wk6rfD5nf4vNNAu\",\n      \"updated_at\": \"2019-08-21T21:56:01.420Z\",\n      \"user_agent\": null\n    }\n  ]\n}",
+      "response_content_type": "application/json",
+      "curl": "curl -g \"https://www.example.com/api/admin/users?page=1&sort_by=created_at&sort_direction=desc\" -X GET "
+    }
+  ],
+  "resource": "Users",
+  "description": "Listing users",
+  "route": "/api/admin/users",
+  "http_method": "GET"
+}

data/doc/api/admin/users/removing_a_user.json

@@ -0,0 +1,42 @@
+{
+  "parameters": [
+
+  ],
+  "response_fields": [
+
+  ],
+  "requests": [
+    {
+      "request_headers": {
+        "Content-Type": "application/json"
+      },
+      "request_query_parameters": {
+      },
+      "response_headers": {
+        "X-Frame-Options": "SAMEORIGIN",
+        "X-XSS-Protection": "1; mode=block",
+        "X-Content-Type-Options": "nosniff",
+        "X-Download-Options": "noopen",
+        "X-Permitted-Cross-Domain-Policies": "none",
+        "Referrer-Policy": "strict-origin-when-cross-origin",
+        "Cache-Control": "no-cache, no-store, must-revalidate",
+        "X-Request-Id": "54735f8a-a973-481e-9135-549144c9dd4b",
+        "X-Runtime": "0.014506",
+        "Expires": "0"
+      },
+      "request_method": "DELETE",
+      "request_path": "/api/admin/users/5d5dbdf0d4322a4b69d799c3",
+      "request_body": null,
+      "request_content_type": "application/json",
+      "response_status": 204,
+      "response_status_text": "No Content",
+      "response_body": null,
+      "response_content_type": null,
+      "curl": "curl \"https://www.example.com/api/admin/users/5d5dbdf0d4322a4b69d799c3\" -d '' -X DELETE \\\n\t-H \"Content-Type: application/json\""
+    }
+  ],
+  "resource": "Users",
+  "description": "Removing a user",
+  "route": "/api/admin/users/:id",
+  "http_method": "DELETE"
+}

data/doc/api/admin/users/showing_a_user.json

@@ -0,0 +1,44 @@
+{
+  "parameters": [
+
+  ],
+  "response_fields": [
+
+  ],
+  "requests": [
+    {
+      "request_headers": {
+      },
+      "request_query_parameters": {
+      },
+      "response_headers": {
+        "X-Frame-Options": "SAMEORIGIN",
+        "X-XSS-Protection": "1; mode=block",
+        "X-Content-Type-Options": "nosniff",
+        "X-Download-Options": "noopen",
+        "X-Permitted-Cross-Domain-Policies": "none",
+        "Referrer-Policy": "strict-origin-when-cross-origin",
+        "Content-Type": "application/json; charset=utf-8",
+        "ETag": "W/\"a83fb0a6c570e73b2c656713b90f7347\"",
+        "Cache-Control": "no-cache, no-store, must-revalidate",
+        "X-Request-Id": "0a7ec35c-7840-49b7-a07e-e9a9929963e6",
+        "X-Runtime": "0.005777",
+        "Expires": "0",
+        "Content-Length": "898"
+      },
+      "request_method": "GET",
+      "request_path": "/api/admin/users/5d5dbdf6d4322a4b69d799eb",
+      "request_body": null,
+      "request_content_type": null,
+      "response_status": 200,
+      "response_status_text": "OK",
+      "response_body": "{\n  \"user\": {\n    \"_id\": \"5d5dbdf6d4322a4b69d799eb\",\n    \"admin\": false,\n    \"api_access\": false,\n    \"avatar_name\": null,\n    \"avatar_uid\": null,\n    \"can_publish_now\": null,\n    \"can_restore\": null,\n    \"catalog_access\": false,\n    \"created_at\": \"2019-08-21T21:56:06.163Z\",\n    \"created_by_id\": null,\n    \"email\": \"user390@workarea.com\",\n    \"failed_login_count\": 0,\n    \"first_name\": \"Ben\",\n    \"help_admin\": false,\n    \"ip_address\": null,\n    \"last_impersonated_at\": null,\n    \"last_impersonated_by_id\": null,\n    \"last_login_at\": null,\n    \"last_login_attempt_at\": null,\n    \"last_name\": \"Crouse\",\n    \"marketing_access\": false,\n    \"orders_access\": false,\n    \"password_changed_at\": \"2019-08-21T21:56:06.163Z\",\n    \"people_access\": false,\n    \"permissions_manager\": false,\n    \"releases_access\": false,\n    \"reports_access\": false,\n    \"search_access\": false,\n    \"settings_access\": false,\n    \"status_email_recipient\": false,\n    \"store_access\": false,\n    \"subscribed_user_ids\": [\n\n    ],\n    \"tags\": [\n\n    ],\n    \"token\": \"MkNivTsYxdHKziBAg6C9PazW\",\n    \"updated_at\": \"2019-08-21T21:56:06.163Z\",\n    \"user_agent\": null\n  }\n}",
+      "response_content_type": "application/json",
+      "curl": "curl -g \"https://www.example.com/api/admin/users/5d5dbdf6d4322a4b69d799eb\" -X GET "
+    }
+  ],
+  "resource": "Users",
+  "description": "Showing a user",
+  "route": "/api/admin/users/:id",
+  "http_method": "GET"
+}

data/doc/api/admin/users/updating_a_user.json

@@ -0,0 +1,42 @@
+{
+  "parameters": [
+
+  ],
+  "response_fields": [
+
+  ],
+  "requests": [
+    {
+      "request_headers": {
+        "Content-Type": "application/json"
+      },
+      "request_query_parameters": {
+      },
+      "response_headers": {
+        "X-Frame-Options": "SAMEORIGIN",
+        "X-XSS-Protection": "1; mode=block",
+        "X-Content-Type-Options": "nosniff",
+        "X-Download-Options": "noopen",
+        "X-Permitted-Cross-Domain-Policies": "none",
+        "Referrer-Policy": "strict-origin-when-cross-origin",
+        "Cache-Control": "no-cache, no-store, must-revalidate",
+        "X-Request-Id": "6397306c-20b7-44dd-aecb-d48a0f7827a2",
+        "X-Runtime": "0.281893",
+        "Expires": "0"
+      },
+      "request_method": "PATCH",
+      "request_path": "/api/admin/users/5d5dbdf6d4322a4b69d799f0",
+      "request_body": "{\"user\":{\"admin\":false,\"api_access\":false,\"avatar_name\":null,\"avatar_uid\":null,\"can_publish_now\":null,\"can_restore\":null,\"catalog_access\":false,\"created_at\":\"2019-08-21T21:56:07.245Z\",\"created_by_id\":null,\"email\":\"user1@workarea.com\",\"failed_login_count\":0,\"first_name\":\"Ben\",\"help_admin\":false,\"ip_address\":null,\"last_impersonated_at\":null,\"last_impersonated_by_id\":null,\"last_login_at\":null,\"last_login_attempt_at\":null,\"last_name\":\"Crouse\",\"marketing_access\":false,\"orders_access\":false,\"password_changed_at\":\"2019-08-21T21:56:07.245Z\",\"people_access\":false,\"permissions_manager\":false,\"releases_access\":false,\"reports_access\":false,\"search_access\":false,\"settings_access\":false,\"status_email_recipient\":false,\"store_access\":false,\"subscribed_user_ids\":[],\"tags\":[],\"updated_at\":\"2019-08-21T21:56:07.245Z\",\"user_agent\":null,\"password\":\"p@ssw0rd\"}}",
+      "request_content_type": "application/json",
+      "response_status": 204,
+      "response_status_text": "No Content",
+      "response_body": null,
+      "response_content_type": null,
+      "curl": "curl \"https://www.example.com/api/admin/users/5d5dbdf6d4322a4b69d799f0\" -d '{\"user\":{\"admin\":false,\"api_access\":false,\"avatar_name\":null,\"avatar_uid\":null,\"can_publish_now\":null,\"can_restore\":null,\"catalog_access\":false,\"created_at\":\"2019-08-21T21:56:07.245Z\",\"created_by_id\":null,\"email\":\"user1@workarea.com\",\"failed_login_count\":0,\"first_name\":\"Ben\",\"help_admin\":false,\"ip_address\":null,\"last_impersonated_at\":null,\"last_impersonated_by_id\":null,\"last_login_at\":null,\"last_login_attempt_at\":null,\"last_name\":\"Crouse\",\"marketing_access\":false,\"orders_access\":false,\"password_changed_at\":\"2019-08-21T21:56:07.245Z\",\"people_access\":false,\"permissions_manager\":false,\"releases_access\":false,\"reports_access\":false,\"search_access\":false,\"settings_access\":false,\"status_email_recipient\":false,\"store_access\":false,\"subscribed_user_ids\":[],\"tags\":[],\"updated_at\":\"2019-08-21T21:56:07.245Z\",\"user_agent\":null,\"password\":\"p@ssw0rd\"}}' -X PATCH \\\n\t-H \"Content-Type: application/json\""
+    }
+  ],
+  "resource": "Users",
+  "description": "Updating a user",
+  "route": "/api/admin/users/:id",
+  "http_method": "PATCH"
+}

data/doc/api/admin/variants/creating_a_product_variant.json

@@ -0,0 +1,46 @@
+{
+  "parameters": [
+
+  ],
+  "response_fields": [
+
+  ],
+  "requests": [
+    {
+      "request_headers": {
+        "Content-Type": "application/json"
+      },
+      "request_query_parameters": {
+      },
+      "response_headers": {
+        "X-Frame-Options": "SAMEORIGIN",
+        "X-XSS-Protection": "1; mode=block",
+        "X-Content-Type-Options": "nosniff",
+        "X-Download-Options": "noopen",
+        "X-Permitted-Cross-Domain-Policies": "none",
+        "Referrer-Policy": "strict-origin-when-cross-origin",
+        "Location": "/api/admin/products/test-product/variants",
+        "Content-Type": "application/json; charset=utf-8",
+        "ETag": "W/\"3d0a82d4a96fc48e2dcd8f355716ed0d\"",
+        "Cache-Control": "no-cache, no-store, must-revalidate",
+        "X-Request-Id": "c0d7072c-3001-4f6c-bc71-057b2c7f761a",
+        "X-Runtime": "0.074235",
+        "Expires": "0",
+        "Content-Length": "191"
+      },
+      "request_method": "POST",
+      "request_path": "/api/admin/products/B08160A16A/variants",
+      "request_body": "{\"variant\":{\"active\":true,\"created_at\":null,\"details\":{},\"name\":\"SKU\",\"position\":0,\"sku\":\"SKU\",\"updated_at\":null}}",
+      "request_content_type": "application/json",
+      "response_status": 201,
+      "response_status_text": "Created",
+      "response_body": "{\n  \"variant\": {\n    \"_id\": \"5d5dbd09d4322a4b69d78bed\",\n    \"active\": true,\n    \"created_at\": \"2019-08-21T21:52:09.832Z\",\n    \"details\": {\n    },\n    \"name\": \"SKU\",\n    \"position\": 0,\n    \"sku\": \"SKU\",\n    \"updated_at\": \"2019-08-21T21:52:09.832Z\"\n  }\n}",
+      "response_content_type": "application/json",
+      "curl": "curl \"https://www.example.com/api/admin/products/B08160A16A/variants\" -d '{\"variant\":{\"active\":true,\"created_at\":null,\"details\":{},\"name\":\"SKU\",\"position\":0,\"sku\":\"SKU\",\"updated_at\":null}}' -X POST \\\n\t-H \"Content-Type: application/json\""
+    }
+  ],
+  "resource": "Variants",
+  "description": "Creating a product variant",
+  "route": "/api/admin/products/:product_id/variants",
+  "http_method": "POST"
+}