openapi-directory
Version:
Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS
1 lines • 29.9 kB
JSON
{"openapi":"3.0.0","info":{"contact":{"name":"Instawell","url":"https://instawell.com/api","x-twitter":"instawellness"},"description":"Instawell's RESTful API gives you access to mental health professionals.","license":{"name":"MIT","url":"http://github.com/gruntjs/grunt/blob/master/LICENSE-MIT"},"title":"Instawell","version":"1.0","x-apisguru-categories":["social"],"x-logo":{"url":"https://twitter.com/instawellness/profile_image?size=original"},"x-origin":[{"format":"swagger","url":"https://raw.githubusercontent.com/instawell/Instawell/master/APIDocs/Instawell_API_Docs.json","version":"2.0"}],"x-providerName":"instawell.com"},"paths":{"/campaigns/create":{"post":{"description":"Create a new Campaign for an existing user or for a new user. \n\nIf you are a new user and you want to create a Campaign, simply supply the email as a parameter in the body and an account will be automatically created for you. \n\n*The response will also return a an `auth_token` that you can use in subsequent requests.*\n\nIf you are an existing user and you want to create a new Campaign under your existing account, then simply add the `X-instawell-token` header in the request to do this.","operationId":"Create Campaign","parameters":[{"description":"","in":"header","name":"Content-Type","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"email":{"description":"Email is a required field if you do not have an auth token. An account will automatically be created for your use.","type":"string"},"name":{"description":"Optional. The name of the Campaign","type":"string"},"description":{"description":"Optional. Short introduction to your Campaign. This is what visitors to your Campaign page will see.","type":"string"},"image":{"description":"Optional. A URL pointing to an image to be used as the background of your Campaign.","type":"string"}},"required":["email","name","description","image"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCampaignresponse"}}}}},"security":[],"summary":"Create Campaign","tags":["Misc"],"x-operation-settings":{"AllowDynamicFormParameters":false,"AllowDynamicQueryParameters":false,"CollectParameters":false,"IsMultiContentStreaming":false},"x-unitTests":[]}},"/campaigns/get":{"get":{"description":"Use this method to retrieve information about the Campaign. We return basic information like name, description and image used as well as other meta information.","operationId":"Get Campaign","parameters":[{"description":"","in":"query","name":"campaign_id","required":true,"schema":{"type":"string"}},{"description":"","in":"header","name":"Content-Type","required":true,"schema":{"type":"string"}},{"description":"","in":"header","name":"X-instawell-token","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCampaignresponse"}}}}},"security":[],"summary":"Get Campaign","tags":["Misc"],"x-operation-settings":{"AllowDynamicFormParameters":false,"AllowDynamicQueryParameters":false,"CollectParameters":false,"IsMultiContentStreaming":false},"x-unitTests":[]}},"/campaigns/get_stats":{"get":{"description":"You can use this method to retrieve some basic stats about your Campaign. We currently return the following information\n\n- users_joined : How many uses' joined the Campaign\n- money_spent : How much money was spent on the Campaign by users.\n- plans_sold : The number of Plans that have been sold on the Campaign\n- view_count : The number of people who viewed the Campaign\n- feed : The most recent activity log of your Campaign","operationId":"Get Campaign Stats","parameters":[{"description":"","in":"query","name":"campaign_id","required":true,"schema":{"type":"string"}},{"description":"","in":"header","name":"Content-Type","required":true,"schema":{"type":"string"}},{"description":"","in":"header","name":"X-instawell-token","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCampaignStatsresponse"},"examples":{"response":{"value":{"stats":{"feed":[],"money_spent":0,"plans_sold":0,"users_joined":1,"view_count":1}}}}}}}},"security":[],"summary":"Get Campaign Stats","tags":["Misc"],"x-operation-settings":{"AllowDynamicFormParameters":false,"AllowDynamicQueryParameters":false,"CollectParameters":false,"IsMultiContentStreaming":false},"x-unitTests":[{"expectedResponse":{"body":"{\"stats\":{\"users_joined\":1,\"money_spent\":0,\"plans_sold\":0,\"view_count\":1,\"feed\":[]}}","headers":{"Access-Control-Allow-Credentials":"true","Access-Control-Allow-Headers":"Content-Type, X-instawell-token, instawell-token","Access-Control-Allow-Methods":"GET, POST, OPTIONS","Access-Control-Allow-Origin":"*","Connection":"Keep-Alive","Content-Encoding":"gzip","Content-Length":"95","Content-Type":"application/json; charset=UTF-8","Date":"Mon, 10 Jul 2017 22:22:36 GMT","Keep-Alive":"timeout=5, max=500","Server":"Apache/2.4.12 (Ubuntu)","Set-Cookie":"ol_sess_cookie_live=a%3A4%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%22974de7ee82869ff8ac5778e5ae87a7f1%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A15%3A%22112.134.100.188%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A20%3A%22PostmanRuntime%2F6.1.6%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1499722661%3B%7Dcbd374dd8907799c43bfb82ddfa01de0; expires=Tue, 11-Jul-2017 22:22:36 GMT; Max-Age=86400; path=/","Status":"200","Vary":"Accept-Encoding","X-Clacks-Overhead":"GNU Terry Pratchett","X-execution-duration":"0.049762964248657"},"x-allowExtraHeaders":true,"x-arrayCheckCount":false,"x-arrayOrderedMatching":false,"x-bodyMatchMode":"RAW","x-matchResponseSchema":true},"request":{"headers":{"Content-Type":"application/json","X-instawell-token":"589caa2d7eb42fb1630d69e2636a4673853c26757f38621b58a195f44c27c0584194da64e15259849009a5cfc161210d76db9e81d81747c6a1a7be195e353d17"},"method":"GET","uri":"/campaigns/get_stats?campaign_id={{campaign_id}}"},"x-testDescription":"You can use this method to retrieve some basic stats about your Campaign. We currently return the following information\n\n- users_joined : How many uses' joined the Campaign\n- money_spent : How much money was spent on the Campaign by users.\n- plans_sold : The number of Plans that have been sold on the Campaign\n- view_count : The number of people who viewed the Campaign\n- feed : The most recent activity log of your Campaign","x-testEnabled":true,"x-testName":"Get Campaign Stats","x-testShouldPass":true}]}},"/campaigns/get_widget":{"get":{"description":"The widget code is some HTML that will allow you to embed an Instawell widget on your own website. The widget points to your Campaign and allows visitors to interact with your Campaign right from your own website. \n\nTo include the widget on your website, simply copy the `embed_html` field from the response and paste it at the bottom of your website template. \n","operationId":"Get Campaign Widget","parameters":[{"description":"","in":"query","name":"campaign_id","required":true,"schema":{"type":"string"}},{"description":"","in":"header","name":"Content-Type","required":true,"schema":{"type":"string"}},{"description":"","in":"header","name":"X-instawell-token","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCampaignWidgetresponse"},"examples":{"response":{"value":{"embed_html":"<script data-iw-script='1' type='text/javascript' src='https://static-1.instawell.com/assets/widget/widget-main.js?campaign=1QayZ'></script>"}}}}}}},"security":[],"summary":"Get Campaign Widget","tags":["Misc"],"x-operation-settings":{"AllowDynamicFormParameters":false,"AllowDynamicQueryParameters":false,"CollectParameters":false,"IsMultiContentStreaming":false},"x-unitTests":[{"expectedResponse":{"body":"{\"embed_html\":\"<script data-iw-script='1' type='text\\/javascript' src='https:\\/\\/static-1.instawell.com\\/assets\\/widget\\/widget-main.js?campaign=1QayZ'><\\/script>\"}","headers":{"Access-Control-Allow-Credentials":"true","Access-Control-Allow-Headers":"Content-Type, X-instawell-token, instawell-token","Access-Control-Allow-Methods":"GET, POST, OPTIONS","Access-Control-Allow-Origin":"*","Connection":"Keep-Alive","Content-Encoding":"gzip","Content-Length":"152","Content-Type":"application/json; charset=UTF-8","Date":"Mon, 10 Jul 2017 22:23:02 GMT","Keep-Alive":"timeout=5, max=500","Server":"Apache/2.4.12 (Ubuntu)","Set-Cookie":"ol_sess_cookie_live=a%3A4%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%22974de7ee82869ff8ac5778e5ae87a7f1%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A15%3A%22112.134.100.188%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A20%3A%22PostmanRuntime%2F6.1.6%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1499722661%3B%7Dcbd374dd8907799c43bfb82ddfa01de0; expires=Tue, 11-Jul-2017 22:23:02 GMT; Max-Age=86400; path=/","Status":"200","Vary":"Accept-Encoding","X-Clacks-Overhead":"GNU Terry Pratchett","X-execution-duration":"0.041615962982178"},"x-allowExtraHeaders":true,"x-arrayCheckCount":false,"x-arrayOrderedMatching":false,"x-bodyMatchMode":"RAW","x-matchResponseSchema":true},"request":{"headers":{"Content-Type":"application/json","X-instawell-token":"589caa2d7eb42fb1630d69e2636a4673853c26757f38621b58a195f44c27c0584194da64e15259849009a5cfc161210d76db9e81d81747c6a1a7be195e353d17"},"method":"GET","uri":"/campaigns/get_widget?campaign_id={{campaign_id}}"},"x-testDescription":"The widget code is some HTML that will allow you to embed an Instawell widget on your own website. The widget points to your Campaign and allows visitors to interact with your Campaign right from your own website. \n\nTo include the widget on your website, simply copy the `embed_html` field from the response and paste it at the bottom of your website template. \n","x-testEnabled":true,"x-testName":"Get Campaign Widget","x-testShouldPass":true}]}},"/campaigns/update":{"post":{"description":"The Campaign owner can update information about the Campaign. We currently allow you to update the name, description and the image used. \n","operationId":"Update a Campaign","parameters":[{"description":"","in":"header","name":"Content-Type","required":true,"schema":{"type":"string"}},{"description":"","in":"header","name":"X-instawell-token","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"name":{"description":"The new name to be used for your C","type":"string"},"image":{"description":"A URL pointing to an image to be used as the background of your Campaign.","type":"string"},"description":{"description":"Welcome message seen by visitors","type":"string"},"campaign_id":{"description":"The ID of the Campaign you are updating","type":"string"}},"required":["name","image","description","campaign_id"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateACampaignresponse"}}}}},"security":[],"summary":"Update a Campaign","tags":["Misc"],"x-operation-settings":{"AllowDynamicFormParameters":false,"AllowDynamicQueryParameters":false,"CollectParameters":false,"IsMultiContentStreaming":false},"x-unitTests":[]}},"/plans/find":{"get":{"description":"Use this method to find available Plans on Instawell. Use the `category` field to filter Plans by Category. \n\nCalling this method without the `category` field will return the possible Category values. \n\nPossible category values are : mentalhealth, relationships","operationId":"Find Plans","parameters":[{"description":"","in":"query","name":"category","required":true,"schema":{"type":"string"}},{"description":"","in":"header","name":"Content-Type","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FindPlansresponse"},"examples":{"response":{"value":{"plans":[{"description":"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Phasellus sed tempus purus. Maecenas ultrices laoreet quam. Nunc dapibus dolor purus, vel congue felis volutpat nec. Pellentesque auctor commodo mattis. Proin ac molestie elit, id efficitur metus. Nunc vitae dignissim urna.","helper":{"avatar_url":"https://static-1.instawell.com/assets/img/defaults/photos/j.png","id":"5","username":"john"},"id":"1","image":"https://static-1.instawell.com/assets/img/landing/main2.jpg?v=0.1.2588","name":"Example Plan 1","price":"40.00","url":"https://sandbox.instawell.com/john/plan/1/example-plan-1"}]}}}}}}},"security":[],"summary":"Find Plans","tags":["Misc"],"x-operation-settings":{"AllowDynamicFormParameters":false,"AllowDynamicQueryParameters":false,"CollectParameters":false,"IsMultiContentStreaming":false},"x-unitTests":[{"expectedResponse":{"body":"{\"plans\":[{\"id\":\"1\",\"name\":\"Example Plan 1\",\"description\":\"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Phasellus sed tempus purus. Maecenas ultrices laoreet quam. Nunc dapibus dolor purus, vel congue felis volutpat nec. Pellentesque auctor commodo mattis. Proin ac molestie elit, id efficitur metus. Nunc vitae dignissim urna.\",\"image\":\"https:\\/\\/static-1.instawell.com\\/assets\\/img\\/landing\\/main2.jpg?v=0.1.2588\",\"price\":\"40.00\",\"helper\":{\"id\":\"5\",\"username\":\"john\",\"avatar_url\":\"https:\\/\\/static-1.instawell.com\\/assets\\/img\\/defaults\\/photos\\/j.png\"},\"url\":\"https:\\/\\/sandbox.instawell.com\\/john\\/plan\\/1\\/example-plan-1\"}]}","headers":{"Access-Control-Allow-Credentials":"true","Access-Control-Allow-Headers":"Content-Type, X-instawell-token, instawell-token","Access-Control-Allow-Methods":"GET, POST, OPTIONS","Access-Control-Allow-Origin":"*","Connection":"Keep-Alive","Content-Encoding":"gzip","Content-Length":"403","Content-Type":"application/json; charset=UTF-8","Date":"Fri, 13 Oct 2017 06:58:42 GMT","Keep-Alive":"timeout=5, max=500","Server":"Apache/2.4.12 (Ubuntu)","Status":"200","Vary":"Accept-Encoding","X-execution-duration":"0.096148014068604"},"x-allowExtraHeaders":true,"x-arrayCheckCount":false,"x-arrayOrderedMatching":false,"x-bodyMatchMode":"RAW","x-matchResponseSchema":true},"request":{"headers":{"Content-Type":"application/json"},"method":"GET","uri":"/plans/find?category=mentalhealth"},"x-testDescription":"Use this method to find available Plans on Instawell. Use the `category` field to filter Plans by Category. \n\nCalling this method without the `category` field will return the possible Category values. \n\nPossible category values are : mentalhealth, relationships","x-testEnabled":true,"x-testName":"Find Plans","x-testShouldPass":true}]}},"/plans/request":{"post":{"description":"Once you've found a Plan you like, you can make a request for it. When you make a request for it, we notify the Helper who created the Plan that there's someone waiting to chat with them. And you can start chatting with them as soon as they accept the request. \n\nThe response to this method also contains a link you can use to automatically login to your account.\n\nYou can call this method as a visitor or as an existing user with a valid `auth_token`. If your `auth_token` is included, we'll create the account under your existing account. Otherwise we'll create an account automatically for you and return the auth token.","operationId":"Request Plan","parameters":[{"description":"","in":"header","name":"Content-Type","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"plan_id":{"description":"Required. The ID of the Plan that you want to chat about.","type":"string"}},"required":["plan_id"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestPlanresponse"},"examples":{"response":{"value":{"chat_url":"https://sandbox.instawell.com/cl/7d6f62101201a72f4","message":"Your request has been created and John Pereira has been notified of your request."}}}}}}},"security":[],"summary":"Request Plan","tags":["Misc"],"x-operation-settings":{"AllowDynamicFormParameters":false,"AllowDynamicQueryParameters":false,"CollectParameters":false,"IsMultiContentStreaming":false},"x-unitTests":[{"expectedResponse":{"body":"{\n \"message\": \"Your request has been created and John Pereira has been notified of your request.\",\n \"chat_url\": \"https://sandbox.instawell.com/cl/7d6f62101201a72f4\"\n}","headers":{"Access-Control-Allow-Credentials":"true","Access-Control-Allow-Headers":"Content-Type, X-instawell-token, instawell-token","Access-Control-Allow-Methods":"GET, POST, OPTIONS","Access-Control-Allow-Origin":"*","Connection":"Keep-Alive","Content-Encoding":"gzip","Content-Length":"150","Content-Type":"application/json; charset=UTF-8","Date":"Fri, 13 Oct 2017 06:59:39 GMT","Keep-Alive":"timeout=5, max=500","Server":"Apache/2.4.12 (Ubuntu)","Status":"200","Vary":"Accept-Encoding","X-execution-duration":"3.5281460285187"},"x-allowExtraHeaders":true,"x-arrayCheckCount":false,"x-arrayOrderedMatching":false,"x-bodyMatchMode":"RAW","x-matchResponseSchema":true},"request":{"body":"plan_id={{plan_id}}","headers":{"Content-Type":"application/x-www-form-urlencoded"},"method":"POST","uri":"/plans/request"},"x-testDescription":"Once you've found a Plan you like, you can make a request for it. When you make a request for it, we notify the Helper who created the Plan that there's someone waiting to chat with them. And you can start chatting with them as soon as they accept the request. \n\nThe response to this method also contains a link you can use to automatically login to your account.\n\nYou can call this method as a visitor or as an existing user with a valid `auth_token`. If your `auth_token` is included, we'll create the account under your existing account. Otherwise we'll create an account automatically for you and return the auth token.","x-testEnabled":true,"x-testName":"Request Plan","x-testShouldPass":true}]}},"/users/notifications":{"get":{"description":"Use this method to retrieve your most recent notifications. ","operationId":"Get Notifications","parameters":[{"description":"","in":"header","name":"Content-Type","required":true,"schema":{"type":"string"}},{"description":"","in":"header","name":"X-instawell-token","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetNotificationsresponse"},"examples":{"response":{"value":{"notifications":[{"chat_url":"https://instawell.com/chats/john/anon-1581","created":"2017-11-09 18:07:20","is_read":1,"text":"anon_1987 silenced the chat"},{"chat_url":"https://instawell.com/chats/john/anon-1581","created":"2017-11-09 17:28:33","is_read":1,"text":"John Pereira sent you a message"}]}}}}}}},"security":[],"summary":"Get Notifications","tags":["Misc"],"x-operation-settings":{"AllowDynamicFormParameters":false,"AllowDynamicQueryParameters":false,"CollectParameters":false,"IsMultiContentStreaming":false},"x-unitTests":[{"expectedResponse":{"body":"{\n \"notifications\": [\n {\n \"text\": \"anon_1987 silenced the chat\",\n \"chat_url\": \"https://instawell.com/chats/john/anon-1581\",\n \"is_read\": 1,\n \"created\": \"2017-11-09 18:07:20\"\n },\n {\n \"text\": \"John Pereira sent you a message\",\n \"chat_url\": \"https://instawell.com/chats/john/anon-1581\",\n \"is_read\": 1,\n \"created\": \"2017-11-09 17:28:33\"\n }\n ]\n}","headers":{"Access-Control-Allow-Credentials":"true","Access-Control-Allow-Headers":"Content-Type, X-instawell-token, instawell-token","Access-Control-Allow-Methods":"GET, POST, OPTIONS","Access-Control-Allow-Origin":"*","Connection":"Keep-Alive","Content-Length":"20","Content-Type":"application/json; charset=UTF-8","Date":"Fri, 10 Nov 2017 07:54:48 GMT","Keep-Alive":"timeout=5, max=500","Server":"Apache/2.4.12 (Ubuntu)","Set-Cookie":"ol_sess_cookie_live=a%3A4%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%22efaf309fcbee5d8c8a0330e9d70a8cb2%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A12%3A%22111.92.54.26%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A20%3A%22PostmanRuntime%2F6.4.1%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1510300261%3B%7D18ea7134775318ce3f4df685ecbfa822; expires=Sat, 11-Nov-2017 07:54:48 GMT; Max-Age=86400; path=/","Status":"200","X-execution-duration":"0.037554025650024"},"x-allowExtraHeaders":true,"x-arrayCheckCount":false,"x-arrayOrderedMatching":false,"x-bodyMatchMode":"RAW","x-matchResponseSchema":true},"request":{"headers":{"Content-Type":"application/json","X-instawell-token":"589caa2d7eb42fb1630d69e2636a4673853c26757f38621b58a195f44c27c0584194da64e15259849009a5cfc161210d76db9e81d81747c6a1a7be195e353d17"},"method":"GET","uri":"/users/notifications"},"x-testDescription":"Use this method to retrieve your most recent notifications. ","x-testEnabled":true,"x-testName":"Get Notifications","x-testShouldPass":true}]}}},"servers":[{"url":"http://instawell.local/v3"}],"components":{"schemas":{"AuthData":{"properties":{"mode":{"description":"","type":"string"}},"required":["mode"],"title":"AuthData","type":"object"},"Campaign":{"properties":{"auth_type":{"description":"","type":"string"},"campaign_plans":{"description":"","items":{"type":"string"},"type":"array"},"code":{"description":"","type":"string"},"created":{"description":"","type":"string"},"data":{"description":"","items":{"type":"string"},"type":"array"},"description":{"description":"","type":"string"},"enabled":{"description":"","type":"string"},"id":{"description":"","type":"string"},"image":{"description":"","type":"string"},"join_mode_text":{"description":"","type":"string"},"meta":{"$ref":"#/components/schemas/Meta"},"name":{"description":"","type":"string"},"published":{"description":"","format":"int32","type":"integer"},"purpose_code":{"description":"","type":"string"},"used_plans_count":{"description":"","format":"int32","type":"integer"},"user_count":{"description":"","format":"int32","type":"integer"},"user_id":{"description":"","type":"string"}},"required":["id","user_id","code","name","image","description","auth_type","data","enabled","published","created","used_plans_count","user_count","campaign_plans","join_mode_text","meta","purpose_code"],"title":"Campaign","type":"object"},"Campaign13":{"properties":{"auth_type":{"description":"","type":"string"},"campaign_plans":{"description":"","items":{"type":"string"},"type":"array"},"code":{"description":"","type":"string"},"created":{"description":"","type":"string"},"data":{"$ref":"#/components/schemas/Data"},"description":{"description":"","type":"string"},"enabled":{"description":"","type":"string"},"id":{"description":"","type":"string"},"image":{"description":"","type":"string"},"join_mode_text":{"description":"","type":"string"},"meta":{"$ref":"#/components/schemas/Meta"},"name":{"description":"","type":"string"},"published":{"description":"","format":"int32","type":"integer"},"purpose_code":{"description":"","type":"string"},"used_plans_count":{"description":"","format":"int32","type":"integer"},"user_count":{"description":"","format":"int32","type":"integer"},"user_id":{"description":"","type":"string"}},"required":["id","user_id","code","name","image","description","auth_type","data","enabled","published","created","used_plans_count","user_count","campaign_plans","join_mode_text","meta","purpose_code"],"title":"Campaign13","type":"object"},"Campaign8":{"properties":{"auth_data":{"$ref":"#/components/schemas/AuthData"},"auth_type":{"description":"","type":"string"},"campaign_helpers":{"description":"","items":{"type":"string"},"type":"array"},"campaign_plans":{"description":"","items":{"type":"string"},"type":"array"},"code":{"description":"","type":"string"},"created":{"description":"","type":"string"},"data":{"$ref":"#/components/schemas/Data"},"description":{"description":"","type":"string"},"enabled":{"description":"","type":"string"},"id":{"description":"","type":"string"},"image":{"description":"","type":"string"},"join_mode_text":{"description":"","type":"string"},"meta":{"$ref":"#/components/schemas/Meta"},"name":{"description":"","type":"string"},"published":{"description":"","format":"int32","type":"integer"},"purpose_code":{"description":"","type":"string"},"used_plans_count":{"description":"","format":"int32","type":"integer"},"user_count":{"description":"","format":"int32","type":"integer"},"user_id":{"description":"","type":"string"}},"required":["id","user_id","code","name","image","description","auth_type","data","enabled","published","created","used_plans_count","user_count","campaign_helpers","campaign_plans","join_mode_text","meta","purpose_code","auth_data"],"title":"Campaign8","type":"object"},"CreateCampaignresponse":{"properties":{"admin_url":{"description":"","type":"string"},"auth_token":{"description":"","type":"string"},"campaign":{"$ref":"#/components/schemas/Campaign"}},"required":["campaign","auth_token","admin_url"],"title":"Create CampaignResponse","type":"object"},"Data":{"properties":{"purpose_code":{"description":"","type":"string"}},"required":["purpose_code"],"title":"Data","type":"object"},"FindPlansresponse":{"example":{"plans":[{"description":"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Phasellus sed tempus purus. Maecenas ultrices laoreet quam. Nunc dapibus dolor purus, vel congue felis volutpat nec. Pellentesque auctor commodo mattis. Proin ac molestie elit, id efficitur metus. Nunc vitae dignissim urna.","helper":{"avatar_url":"https://static-1.instawell.com/assets/img/defaults/photos/j.png","id":"5","username":"john"},"id":"1","image":"https://static-1.instawell.com/assets/img/landing/main2.jpg?v=0.1.2588","name":"Example Plan 1","price":"40.00","url":"https://sandbox.instawell.com/john/plan/1/example-plan-1"}]},"properties":{"plans":{"description":"","items":{"$ref":"#/components/schemas/Plan"},"type":"array"}},"required":["plans"],"title":"Find PlansResponse","type":"object"},"GetCampaignStatsresponse":{"example":{"stats":{"feed":[],"money_spent":0,"plans_sold":0,"users_joined":1,"view_count":1}},"properties":{"stats":{"$ref":"#/components/schemas/Stats"}},"required":["stats"],"title":"Get Campaign StatsResponse","type":"object"},"GetCampaignWidgetresponse":{"example":{"embed_html":"<script data-iw-script='1' type='text/javascript' src='https://static-1.instawell.com/assets/widget/widget-main.js?campaign=1QayZ'></script>"},"properties":{"embed_html":{"description":"","type":"string"}},"required":["embed_html"],"title":"Get Campaign WidgetResponse","type":"object"},"GetCampaignresponse":{"properties":{"campaign":{"$ref":"#/components/schemas/Campaign13"}},"required":["campaign"],"title":"Get CampaignResponse","type":"object"},"GetNotificationsresponse":{"example":{"notifications":[{"chat_url":"https://instawell.com/chats/john/anon-1581","created":"2017-11-09 18:07:20","is_read":1,"text":"anon_1987 silenced the chat"},{"chat_url":"https://instawell.com/chats/john/anon-1581","created":"2017-11-09 17:28:33","is_read":1,"text":"John Pereira sent you a message"}]},"properties":{"notifications":{"description":"","items":{"$ref":"#/components/schemas/Notification"},"type":"array"}},"required":["notifications"],"title":"Get NotificationsResponse","type":"object"},"Helper":{"properties":{"avatar_url":{"description":"","type":"string"},"id":{"description":"","type":"string"},"username":{"description":"","type":"string"}},"required":["id","username","avatar_url"],"title":"Helper","type":"object"},"Meta":{"properties":{"CAMPAIGN_HOSTED_SITE_URL":{"description":"","type":"string"},"CAMPAIGN_RESTRICT_TO_SELECTED_HELPERS":{"description":"","type":"string"},"CAMPAIGN_RESTRICT_TO_SELECTED_PLANS":{"description":"","type":"string"}},"required":["CAMPAIGN_HOSTED_SITE_URL","CAMPAIGN_RESTRICT_TO_SELECTED_HELPERS","CAMPAIGN_RESTRICT_TO_SELECTED_PLANS"],"title":"Meta","type":"object"},"Notification":{"properties":{"chat_url":{"description":"","type":"string"},"created":{"description":"","type":"string"},"is_read":{"description":"","format":"int32","type":"integer"},"text":{"description":"","type":"string"}},"required":["text","chat_url","is_read","created"],"title":"Notification","type":"object"},"Plan":{"properties":{"description":{"description":"","type":"string"},"helper":{"$ref":"#/components/schemas/Helper"},"id":{"description":"","type":"string"},"image":{"description":"","type":"string"},"name":{"description":"","type":"string"},"price":{"description":"","type":"string"},"url":{"description":"","type":"string"}},"required":["id","name","description","image","price","helper","url"],"title":"Plan","type":"object"},"RequestPlanresponse":{"example":{"chat_url":"https://sandbox.instawell.com/cl/7d6f62101201a72f4","message":"Your request has been created and John Pereira has been notified of your request."},"properties":{"chat_url":{"description":"","type":"string"},"message":{"description":"","type":"string"}},"required":["message","chat_url"],"title":"Request PlanResponse","type":"object"},"Stats":{"properties":{"feed":{"description":"","items":{"type":"string"},"type":"array"},"money_spent":{"description":"","format":"int32","type":"integer"},"plans_sold":{"description":"","format":"int32","type":"integer"},"users_joined":{"description":"","format":"int32","type":"integer"},"view_count":{"description":"","format":"int32","type":"integer"}},"required":["users_joined","money_spent","plans_sold","view_count","feed"],"title":"Stats","type":"object"},"UpdateACampaignresponse":{"properties":{"campaign":{"$ref":"#/components/schemas/Campaign8"}},"required":["campaign"],"title":"Update a CampaignResponse","type":"object"}}}}