workarea-api 4.4.6

data/doc/api/admin/pages/showing_a_page.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/\"1c32c72633b71fac0ad5bb153950eb74\"",
+        "Cache-Control": "no-cache, no-store, must-revalidate",
+        "X-Request-Id": "09edf0e6-0e64-4d60-921e-5c88736769e1",
+        "X-Runtime": "0.006680",
+        "Expires": "0",
+        "Content-Length": "273"
+      },
+      "request_method": "GET",
+      "request_path": "/api/admin/pages/5d5dbdaad4322a4b69d793c4",
+      "request_body": null,
+      "request_content_type": null,
+      "response_status": 200,
+      "response_status_text": "OK",
+      "response_body": "{\n  \"page\": {\n    \"_id\": \"5d5dbdaad4322a4b69d793c4\",\n    \"active\": true,\n    \"created_at\": \"2019-08-21T21:54:50.298Z\",\n    \"display_h1\": true,\n    \"name\": \"Test Page\",\n    \"show_navigation\": false,\n    \"slug\": \"test-page\",\n    \"subscribed_user_ids\": [\n\n    ],\n    \"tags\": [\n\n    ],\n    \"template\": \"generic\",\n    \"updated_at\": \"2019-08-21T21:54:50.298Z\"\n  }\n}",
+      "response_content_type": "application/json",
+      "curl": "curl -g \"https://www.example.com/api/admin/pages/5d5dbdaad4322a4b69d793c4\" -X GET "
+    }
+  ],
+  "resource": "Pages",
+  "description": "Showing a page",
+  "route": "/api/admin/pages/:id",
+  "http_method": "GET"
+}

data/doc/api/admin/pages/updating_a_page.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": "cc036fdb-e3e2-41d5-a56b-fba3d0f63da0",
+        "X-Runtime": "0.048711",
+        "Expires": "0"
+      },
+      "request_method": "PATCH",
+      "request_path": "/api/admin/pages/5d5dbdaad4322a4b69d793c9",
+      "request_body": "{\"active\":true,\"created_at\":\"2019-08-21T21:54:50.980Z\",\"display_h1\":true,\"name\":\"Test Page\",\"show_navigation\":false,\"subscribed_user_ids\":[],\"tags\":[],\"template\":\"generic\",\"updated_at\":\"2019-08-21T21:54:50.980Z\"}",
+      "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/pages/5d5dbdaad4322a4b69d793c9\" -d '{\"active\":true,\"created_at\":\"2019-08-21T21:54:50.980Z\",\"display_h1\":true,\"name\":\"Test Page\",\"show_navigation\":false,\"subscribed_user_ids\":[],\"tags\":[],\"template\":\"generic\",\"updated_at\":\"2019-08-21T21:54:50.980Z\"}' -X PATCH \\\n\t-H \"Content-Type: application/json\""
+    }
+  ],
+  "resource": "Pages",
+  "description": "Updating a page",
+  "route": "/api/admin/pages/:id",
+  "http_method": "PATCH"
+}

data/doc/api/admin/payment_profiles/bulk_upserting_payment_profiles.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": "578850a2-4943-4ce0-94e1-6ba3493172b1",
+        "X-Runtime": "0.031390",
+        "Expires": "0"
+      },
+      "request_method": "PATCH",
+      "request_path": "/api/admin/payment_profiles/bulk",
+      "request_body": "{\"payment_profiles\":[{\"created_at\":\"2019-08-21T21:51:19.385Z\",\"email\":\"user@workarea.com\",\"gateway_id\":null,\"reference\":1,\"store_credit\":{\"cents\":0.0,\"currency_iso\":\"USD\"},\"updated_at\":\"2019-08-21T21:51:19.385Z\"},{\"created_at\":\"2019-08-21T21:51:19.385Z\",\"email\":\"user@workarea.com\",\"gateway_id\":null,\"reference\":1,\"store_credit\":{\"cents\":0.0,\"currency_iso\":\"USD\"},\"updated_at\":\"2019-08-21T21:51:19.385Z\"},{\"created_at\":\"2019-08-21T21:51:19.385Z\",\"email\":\"user@workarea.com\",\"gateway_id\":null,\"reference\":1,\"store_credit\":{\"cents\":0.0,\"currency_iso\":\"USD\"},\"updated_at\":\"2019-08-21T21:51:19.385Z\"}]}",
+      "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/payment_profiles/bulk\" -d '{\"payment_profiles\":[{\"created_at\":\"2019-08-21T21:51:19.385Z\",\"email\":\"user@workarea.com\",\"gateway_id\":null,\"reference\":1,\"store_credit\":{\"cents\":0.0,\"currency_iso\":\"USD\"},\"updated_at\":\"2019-08-21T21:51:19.385Z\"},{\"created_at\":\"2019-08-21T21:51:19.385Z\",\"email\":\"user@workarea.com\",\"gateway_id\":null,\"reference\":1,\"store_credit\":{\"cents\":0.0,\"currency_iso\":\"USD\"},\"updated_at\":\"2019-08-21T21:51:19.385Z\"},{\"created_at\":\"2019-08-21T21:51:19.385Z\",\"email\":\"user@workarea.com\",\"gateway_id\":null,\"reference\":1,\"store_credit\":{\"cents\":0.0,\"currency_iso\":\"USD\"},\"updated_at\":\"2019-08-21T21:51:19.385Z\"}]}' -X PATCH \\\n\t-H \"Content-Type: application/json\""
+    }
+  ],
+  "resource": "Payment Profiles",
+  "description": "Bulk upserting payment profiles",
+  "route": "/api/admin/payment_profiles/bulk",
+  "http_method": "PATCH"
+}

data/doc/api/admin/payment_profiles/creating_a_payment_profile.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/payment_profiles/5d5dbcd4d4322a4b69d7898b",
+        "Content-Type": "application/json; charset=utf-8",
+        "ETag": "W/\"43419f8e2a7708c9090c08f7b6f5d443\"",
+        "Cache-Control": "no-cache, no-store, must-revalidate",
+        "X-Request-Id": "d2e9d66f-2cfe-4b77-9861-1c61738a30e5",
+        "X-Runtime": "0.010658",
+        "Expires": "0",
+        "Content-Length": "246"
+      },
+      "request_method": "POST",
+      "request_path": "/api/admin/payment_profiles",
+      "request_body": "{\"payment_profile\":{\"created_at\":\"2019-08-21T21:51:16.567Z\",\"email\":\"user@workarea.com\",\"gateway_id\":null,\"reference\":2,\"store_credit\":{\"cents\":0.0,\"currency_iso\":\"USD\"},\"updated_at\":\"2019-08-21T21:51:16.567Z\"}}",
+      "request_content_type": "application/json",
+      "response_status": 201,
+      "response_status_text": "Created",
+      "response_body": "{\n  \"payment_profile\": {\n    \"_id\": \"5d5dbcd4d4322a4b69d7898b\",\n    \"created_at\": \"2019-08-21T21:51:16.567Z\",\n    \"email\": \"user@workarea.com\",\n    \"gateway_id\": null,\n    \"reference\": \"2\",\n    \"store_credit\": {\n      \"cents\": 0.0,\n      \"currency_iso\": \"USD\"\n    },\n    \"updated_at\": \"2019-08-21T21:51:16.567Z\"\n  }\n}",
+      "response_content_type": "application/json",
+      "curl": "curl \"https://www.example.com/api/admin/payment_profiles\" -d '{\"payment_profile\":{\"created_at\":\"2019-08-21T21:51:16.567Z\",\"email\":\"user@workarea.com\",\"gateway_id\":null,\"reference\":2,\"store_credit\":{\"cents\":0.0,\"currency_iso\":\"USD\"},\"updated_at\":\"2019-08-21T21:51:16.567Z\"}}' -X POST \\\n\t-H \"Content-Type: application/json\""
+    }
+  ],
+  "resource": "Payment Profiles",
+  "description": "Creating a payment profile",
+  "route": "/api/admin/payment_profiles",
+  "http_method": "POST"
+}

data/doc/api/admin/payment_profiles/listing_payment_profiles.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/\"55415aa508af62241225b2d540b0e48e\"",
+        "Cache-Control": "no-cache, no-store, must-revalidate",
+        "X-Request-Id": "5b95226d-a3b5-4507-856f-8d39539ae5f3",
+        "X-Runtime": "0.006248",
+        "Expires": "0",
+        "Content-Length": "476"
+      },
+      "request_method": "GET",
+      "request_path": "/api/admin/payment_profiles?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  \"payment_profiles\": [\n    {\n      \"_id\": \"5d5dbcd6d4322a4b69d7899a\",\n      \"created_at\": \"2019-08-21T21:51:18.275Z\",\n      \"email\": \"user@workarea.com\",\n      \"gateway_id\": null,\n      \"reference\": \"1\",\n      \"store_credit\": {\n        \"cents\": 0.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"updated_at\": \"2019-08-21T21:51:18.275Z\"\n    },\n    {\n      \"_id\": \"5d5dbcd6d4322a4b69d78999\",\n      \"created_at\": \"2019-08-21T21:51:18.271Z\",\n      \"email\": \"user@workarea.com\",\n      \"gateway_id\": null,\n      \"reference\": \"0\",\n      \"store_credit\": {\n        \"cents\": 0.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"updated_at\": \"2019-08-21T21:51:18.271Z\"\n    }\n  ]\n}",
+      "response_content_type": "application/json",
+      "curl": "curl -g \"https://www.example.com/api/admin/payment_profiles?page=1&sort_by=created_at&sort_direction=desc\" -X GET "
+    }
+  ],
+  "resource": "Payment Profiles",
+  "description": "Listing payment profiles",
+  "route": "/api/admin/payment_profiles",
+  "http_method": "GET"
+}

data/doc/api/admin/payment_profiles/removing_a_payment_profile.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": "06aaae54-a453-49a0-a85c-18bdad7859a8",
+        "X-Runtime": "0.005983",
+        "Expires": "0"
+      },
+      "request_method": "DELETE",
+      "request_path": "/api/admin/payment_profiles/5d5dbcd5d4322a4b69d78990",
+      "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/payment_profiles/5d5dbcd5d4322a4b69d78990\" -d '' -X DELETE \\\n\t-H \"Content-Type: application/x-www-form-urlencoded\""
+    }
+  ],
+  "resource": "Payment Profiles",
+  "description": "Removing a payment profile",
+  "route": "/api/admin/payment_profiles/:id",
+  "http_method": "DELETE"
+}

data/doc/api/admin/payment_profiles/showing_a_payment_profile.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/\"688878f71eb26281f251a34c0089cc3a\"",
+        "Cache-Control": "no-cache, no-store, must-revalidate",
+        "X-Request-Id": "a0234a4a-8b69-4bfc-8a22-e9a2c881bda7",
+        "X-Runtime": "0.006112",
+        "Expires": "0",
+        "Content-Length": "249"
+      },
+      "request_method": "GET",
+      "request_path": "/api/admin/payment_profiles/5d5dbcd5d4322a4b69d78995",
+      "request_body": null,
+      "request_content_type": null,
+      "response_status": 200,
+      "response_status_text": "OK",
+      "response_body": "{\n  \"payment_profile\": {\n    \"_id\": \"5d5dbcd5d4322a4b69d78995\",\n    \"created_at\": \"2019-08-21T21:51:17.694Z\",\n    \"email\": \"user@workarea.com\",\n    \"gateway_id\": null,\n    \"reference\": \"1243\",\n    \"store_credit\": {\n      \"cents\": 0.0,\n      \"currency_iso\": \"USD\"\n    },\n    \"updated_at\": \"2019-08-21T21:51:17.694Z\"\n  }\n}",
+      "response_content_type": "application/json",
+      "curl": "curl -g \"https://www.example.com/api/admin/payment_profiles/5d5dbcd5d4322a4b69d78995\" -X GET "
+    }
+  ],
+  "resource": "Payment Profiles",
+  "description": "Showing a payment profile",
+  "route": "/api/admin/payment_profiles/:id",
+  "http_method": "GET"
+}

data/doc/api/admin/payment_profiles/updating_a_payment_profiles.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": "f628c1ce-974f-4bc3-83dd-05a63cd03669",
+        "X-Runtime": "0.010059",
+        "Expires": "0"
+      },
+      "request_method": "PATCH",
+      "request_path": "/api/admin/payment_profiles/5d5dbcd6d4322a4b69d7899e",
+      "request_body": "{\"payment_profile\":{\"store_credit\":29}}",
+      "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/payment_profiles/5d5dbcd6d4322a4b69d7899e\" -d '{\"payment_profile\":{\"store_credit\":29}}' -X PATCH \\\n\t-H \"Content-Type: application/json\""
+    }
+  ],
+  "resource": "Payment Profiles",
+  "description": "Updating a payment profiles",
+  "route": "/api/admin/payment_profiles/:id",
+  "http_method": "PATCH"
+}

data/doc/api/admin/payment_transactions/listing_payment_transactions.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/\"13d4e3751994d6c6fcb609b025e9f9b6\"",
+        "Cache-Control": "no-cache, no-store, must-revalidate",
+        "X-Request-Id": "5031a4c8-1e0c-46dd-8ab4-71f05a32fc0e",
+        "X-Runtime": "0.005451",
+        "Expires": "0",
+        "Content-Length": "1164"
+      },
+      "request_method": "GET",
+      "request_path": "/api/admin/payment_transactions?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  \"transactions\": [\n    {\n      \"_id\": \"5d5dbdb7d4322a4b69d794ed\",\n      \"action\": \"authorize\",\n      \"amount\": {\n        \"cents\": 1100.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"canceled_at\": null,\n      \"cancellation\": null,\n      \"created_at\": \"2019-08-21T21:55:03.476Z\",\n      \"payment_id\": \"1001\",\n      \"reference_id\": null,\n      \"response\": {\n        \"success\": true,\n        \"message\": \"Bogus Gateway: Forced success\",\n        \"params\": {\n          \"authorized_amount\": \"11.00\"\n        },\n        \"options\": {\n          \"test\": true,\n          \"authorization\": \"53433\",\n          \"avs_result\": {\n            \"code\": null,\n            \"message\": null,\n            \"street_match\": null,\n            \"postal_match\": null\n          },\n          \"cvv_result\": null\n        }\n      },\n      \"success\": true,\n      \"tender_id\": \"5d5dbdb6d4322a4b69d794e0\",\n      \"updated_at\": \"2019-08-21T21:55:03.476Z\"\n    },\n    {\n      \"_id\": \"5d5dbdb4d4322a4b69d794a4\",\n      \"action\": \"authorize\",\n      \"amount\": {\n        \"cents\": 1100.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"canceled_at\": null,\n      \"cancellation\": null,\n      \"created_at\": \"2019-08-21T21:55:00.456Z\",\n      \"payment_id\": \"1000\",\n      \"reference_id\": null,\n      \"response\": {\n        \"success\": true,\n        \"message\": \"Bogus Gateway: Forced success\",\n        \"params\": {\n          \"authorized_amount\": \"11.00\"\n        },\n        \"options\": {\n          \"test\": true,\n          \"authorization\": \"53433\",\n          \"avs_result\": {\n            \"code\": null,\n            \"message\": null,\n            \"street_match\": null,\n            \"postal_match\": null\n          },\n          \"cvv_result\": null\n        }\n      },\n      \"success\": true,\n      \"tender_id\": \"5d5dbdb3d4322a4b69d79497\",\n      \"updated_at\": \"2019-08-21T21:55:00.456Z\"\n    }\n  ]\n}",
+      "response_content_type": "application/json",
+      "curl": "curl -g \"https://www.example.com/api/admin/payment_transactions?page=1&sort_by=created_at&sort_direction=desc\" -X GET "
+    }
+  ],
+  "resource": "Payment transactions",
+  "description": "Listing payment transactions",
+  "route": "/api/admin/payment_transactions",
+  "http_method": "GET"
+}

data/doc/api/admin/payment_transactions/showing_a_payment_transaction.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/\"11d51544ed5ea4e2488ad69c2714ca25\"",
+        "Cache-Control": "no-cache, no-store, must-revalidate",
+        "X-Request-Id": "ec04a76d-cb28-48e2-a6e2-f9c621c29869",
+        "X-Runtime": "0.005641",
+        "Expires": "0",
+        "Content-Length": "588"
+      },
+      "request_method": "GET",
+      "request_path": "/api/admin/payment_transactions/5d5dbdbbd4322a4b69d79522",
+      "request_body": null,
+      "request_content_type": null,
+      "response_status": 200,
+      "response_status_text": "OK",
+      "response_body": "{\n  \"transaction\": {\n    \"_id\": \"5d5dbdbbd4322a4b69d79522\",\n    \"action\": \"authorize\",\n    \"amount\": {\n      \"cents\": 1100.0,\n      \"currency_iso\": \"USD\"\n    },\n    \"canceled_at\": null,\n    \"cancellation\": null,\n    \"created_at\": \"2019-08-21T21:55:07.035Z\",\n    \"payment_id\": \"1234\",\n    \"reference_id\": null,\n    \"response\": {\n      \"success\": true,\n      \"message\": \"Bogus Gateway: Forced success\",\n      \"params\": {\n        \"authorized_amount\": \"11.00\"\n      },\n      \"options\": {\n        \"test\": true,\n        \"authorization\": \"53433\",\n        \"avs_result\": {\n          \"code\": null,\n          \"message\": null,\n          \"street_match\": null,\n          \"postal_match\": null\n        },\n        \"cvv_result\": null\n      }\n    },\n    \"success\": true,\n    \"tender_id\": \"5d5dbdbad4322a4b69d79515\",\n    \"updated_at\": \"2019-08-21T21:55:07.035Z\"\n  }\n}",
+      "response_content_type": "application/json",
+      "curl": "curl -g \"https://www.example.com/api/admin/payment_transactions/5d5dbdbbd4322a4b69d79522\" -X GET "
+    }
+  ],
+  "resource": "Payment transactions",
+  "description": "Showing a payment transaction",
+  "route": "/api/admin/payment_transactions/:id",
+  "http_method": "GET"
+}

data/doc/api/admin/payments/listing_payments.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/\"d2eda2e32f1a0d992c5893b7346b2efe\"",
+        "Cache-Control": "no-cache, no-store, must-revalidate",
+        "X-Request-Id": "c415381c-c43d-456a-b8a7-afb8e1602966",
+        "X-Runtime": "0.010870",
+        "Expires": "0",
+        "Content-Length": "1422"
+      },
+      "request_method": "GET",
+      "request_path": "/api/admin/payments?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  \"payments\": [\n    {\n      \"_id\": \"1001\",\n      \"address\": {\n        \"_id\": \"5d5dbc93d4322a4b69d78464\",\n        \"city\": \"Philadelphia\",\n        \"company\": null,\n        \"country\": \"US\",\n        \"created_at\": null,\n        \"first_name\": \"Ben\",\n        \"last_name\": \"Crouse\",\n        \"phone_extension\": null,\n        \"phone_number\": null,\n        \"postal_code\": \"19106\",\n        \"region\": \"PA\",\n        \"street\": \"22 S. 3rd St.\",\n        \"street_2\": \"Second Floor\",\n        \"updated_at\": null\n      },\n      \"created_at\": \"2019-08-21T21:50:11.679Z\",\n      \"credit_card\": {\n        \"_id\": \"5d5dbc94d4322a4b69d7847f\",\n        \"amount\": {\n          \"cents\": 1100.0,\n          \"currency_iso\": \"USD\"\n        },\n        \"created_at\": null,\n        \"display_number\": \"XXXX-XXXX-XXXX-1\",\n        \"issuer\": \"Test Card\",\n        \"month\": 1,\n        \"saved_card_id\": null,\n        \"token\": \"1\",\n        \"updated_at\": \"2019-08-21T21:50:13.368Z\",\n        \"year\": 2020\n      },\n      \"profile_id\": \"5d5dbc94d4322a4b69d7847e\",\n      \"updated_at\": \"2019-08-21T21:50:13.378Z\"\n    },\n    {\n      \"_id\": \"1000\",\n      \"address\": {\n        \"_id\": \"5d5dbc90d4322a4b69d78427\",\n        \"city\": \"Philadelphia\",\n        \"company\": null,\n        \"country\": \"US\",\n        \"created_at\": null,\n        \"first_name\": \"Ben\",\n        \"last_name\": \"Crouse\",\n        \"phone_extension\": null,\n        \"phone_number\": null,\n        \"postal_code\": \"19106\",\n        \"region\": \"PA\",\n        \"street\": \"22 S. 3rd St.\",\n        \"street_2\": \"Second Floor\",\n        \"updated_at\": null\n      },\n      \"created_at\": \"2019-08-21T21:50:08.691Z\",\n      \"credit_card\": {\n        \"_id\": \"5d5dbc91d4322a4b69d78436\",\n        \"amount\": {\n          \"cents\": 1100.0,\n          \"currency_iso\": \"USD\"\n        },\n        \"created_at\": null,\n        \"display_number\": \"XXXX-XXXX-XXXX-1\",\n        \"issuer\": \"Test Card\",\n        \"month\": 1,\n        \"saved_card_id\": null,\n        \"token\": \"1\",\n        \"updated_at\": \"2019-08-21T21:50:10.381Z\",\n        \"year\": 2020\n      },\n      \"profile_id\": \"5d5dbc91d4322a4b69d78435\",\n      \"updated_at\": \"2019-08-21T21:50:10.392Z\"\n    }\n  ]\n}",
+      "response_content_type": "application/json",
+      "curl": "curl -g \"https://www.example.com/api/admin/payments?page=1&sort_by=created_at&sort_direction=desc\" -X GET "
+    }
+  ],
+  "resource": "Payments",
+  "description": "Listing payments",
+  "route": "/api/admin/payments",
+  "http_method": "GET"
+}

data/doc/api/admin/payments/showing_an_payment.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/\"19fb71ad8977313a776ac8d2d6ab020a\"",
+        "Cache-Control": "no-cache, no-store, must-revalidate",
+        "X-Request-Id": "ad4df977-06a7-4a8b-81d7-5ab0d77f4a7a",
+        "X-Runtime": "0.008921",
+        "Expires": "0",
+        "Content-Length": "1313"
+      },
+      "request_method": "GET",
+      "request_path": "/api/admin/payments/1234",
+      "request_body": null,
+      "request_content_type": null,
+      "response_status": 200,
+      "response_status_text": "OK",
+      "response_body": "{\n  \"payment\": {\n    \"_id\": \"1234\",\n    \"address\": {\n      \"_id\": \"5d5dbc97d4322a4b69d784a5\",\n      \"city\": \"Philadelphia\",\n      \"company\": null,\n      \"country\": \"US\",\n      \"created_at\": null,\n      \"first_name\": \"Ben\",\n      \"last_name\": \"Crouse\",\n      \"phone_extension\": null,\n      \"phone_number\": null,\n      \"postal_code\": \"19106\",\n      \"region\": \"PA\",\n      \"street\": \"22 S. 3rd St.\",\n      \"street_2\": \"Second Floor\",\n      \"updated_at\": null\n    },\n    \"created_at\": \"2019-08-21T21:50:15.206Z\",\n    \"credit_card\": {\n      \"_id\": \"5d5dbc97d4322a4b69d784b4\",\n      \"amount\": {\n        \"cents\": 1100.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"created_at\": null,\n      \"display_number\": \"XXXX-XXXX-XXXX-1\",\n      \"issuer\": \"Test Card\",\n      \"month\": 1,\n      \"saved_card_id\": null,\n      \"token\": \"1\",\n      \"updated_at\": \"2019-08-21T21:50:16.886Z\",\n      \"year\": 2020\n    },\n    \"profile_id\": \"5d5dbc97d4322a4b69d784b3\",\n    \"updated_at\": \"2019-08-21T21:50:16.896Z\"\n  },\n  \"payment_transactions\": [\n    {\n      \"_id\": \"5d5dbc98d4322a4b69d784c1\",\n      \"action\": \"authorize\",\n      \"amount\": {\n        \"cents\": 1100.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"canceled_at\": null,\n      \"cancellation\": null,\n      \"created_at\": \"2019-08-21T21:50:16.890Z\",\n      \"payment_id\": \"1234\",\n      \"reference_id\": null,\n      \"response\": {\n        \"success\": true,\n        \"message\": \"Bogus Gateway: Forced success\",\n        \"params\": {\n          \"authorized_amount\": \"11.00\"\n        },\n        \"options\": {\n          \"test\": true,\n          \"authorization\": \"53433\",\n          \"avs_result\": {\n            \"code\": null,\n            \"message\": null,\n            \"street_match\": null,\n            \"postal_match\": null\n          },\n          \"cvv_result\": null\n        }\n      },\n      \"success\": true,\n      \"tender_id\": \"5d5dbc97d4322a4b69d784b4\",\n      \"updated_at\": \"2019-08-21T21:50:16.890Z\"\n    }\n  ]\n}",
+      "response_content_type": "application/json",
+      "curl": "curl -g \"https://www.example.com/api/admin/payments/1234\" -X GET "
+    }
+  ],
+  "resource": "Payments",
+  "description": "Showing an payment",
+  "route": "/api/admin/payments/:id",
+  "http_method": "GET"
+}

data/doc/api/admin/prices/creating_a_pricing_sku_price.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/pricing_skus/2134/prices",
+        "Content-Type": "application/json; charset=utf-8",
+        "ETag": "W/\"c0a5bcc786d6b5f92274198be2a695cd\"",
+        "Cache-Control": "no-cache, no-store, must-revalidate",
+        "X-Request-Id": "f22c0baa-61bc-4b5f-be58-a8271f6583bd",
+        "X-Runtime": "0.033964",
+        "Expires": "0",
+        "Content-Length": "231"
+      },
+      "request_method": "POST",
+      "request_path": "/api/admin/pricing_skus/2134/prices",
+      "request_body": "{\"price\":{\"regular\":15}}",
+      "request_content_type": "application/json",
+      "response_status": 201,
+      "response_status_text": "Created",
+      "response_body": "{\n  \"price\": {\n    \"_id\": \"5d5dbde7d4322a4b69d79934\",\n    \"active\": true,\n    \"created_at\": \"2019-08-21T21:55:51.340Z\",\n    \"min_quantity\": 1,\n    \"on_sale\": false,\n    \"regular\": {\n      \"cents\": 1500.0,\n      \"currency_iso\": \"USD\"\n    },\n    \"sale\": null,\n    \"updated_at\": \"2019-08-21T21:55:51.340Z\"\n  }\n}",
+      "response_content_type": "application/json",
+      "curl": "curl \"https://www.example.com/api/admin/pricing_skus/2134/prices\" -d '{\"price\":{\"regular\":15}}' -X POST \\\n\t-H \"Content-Type: application/json\""
+    }
+  ],
+  "resource": "Prices",
+  "description": "Creating a pricing sku price",
+  "route": "/api/admin/pricing_skus/:pricing_sku_id/prices",
+  "http_method": "POST"
+}