{"docs":{"name":"Athena","info":"\n\u003cp\u003eAnother API description\u003c/p\u003e\n","copyright":"\u0026copy; 2026 Wordapp","doc_url":"/docs/1.0","api_url":"","resources":{"checkouts":{"doc_url":"/docs/1.0/checkouts","api_url":"","name":"Checkouts","short_description":null,"full_description":null,"version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/docs/1.0/checkouts/create","name":"create","apis":[{"api_url":"/api/accounts/:account_id/checkouts","http_method":"POST","short_description":"Creates payment session","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":404,"description":"Account Not Found","metadata":null},{"code":422,"description":null,"metadata":null}],"params":[{"name":"account_id","full_name":"account_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"amount_cents","full_name":"amount_cents","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"notes","full_name":"notes","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/checkouts/execute","name":"execute","apis":[{"api_url":"/api/accounts/:account_id/checkouts/execute","http_method":"POST","short_description":"Executes Paypal Payment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"account_id","full_name":"account_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"payment_id","full_name":"payment_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"payer_id","full_name":"payer_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null},"content_orders":{"doc_url":"/docs/1.0/content_orders","api_url":"","name":"Projects/ContentOrders","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/content_orders/index","name":"index","apis":[{"api_url":"/api/project2s/:project_id/content_orders","http_method":"GET","short_description":"Lists ContentOrders for Project.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Project Not Found.","metadata":null}],"params":[{"name":"project_id","full_name":"project_id","description":"\n\u003cp\u003eProject ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/content_orders/upload_for_preview","name":"upload_for_preview","apis":[{"api_url":"/api/content_orders/upload_for_preview","http_method":"POST","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":422,"description":"Errors related to uploaded file.","metadata":null}],"params":[{"name":"file","full_name":"file","description":"\n\u003cp\u003eFile to be uploaded\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a File","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/content_orders/for_editor","name":"for_editor","apis":[{"api_url":"/api/project2s/:project_id/content_orders/:id/for_editor","http_method":"GET","short_description":"Retrieves ContentOrder for Editor.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Project Not Found.","metadata":null},{"code":404,"description":"ContentOrder Not Found.","metadata":null},{"code":422,"description":"Unprocessable ContentOrder.","metadata":null}],"params":[{"name":"project_id","full_name":"project_id","description":"\n\u003cp\u003eProject ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent Order ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/content_orders/sample_output","name":"sample_output","apis":[{"api_url":"/api/content_orders/sample_output","http_method":"GET","short_description":"Returns sample output for zapier","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/content_orders/task_feed","name":"task_feed","apis":[{"api_url":"/api/content_orders/task_feed","http_method":"GET","short_description":"Content Orders for task feed.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"filter","full_name":"filter","description":"\n\u003cp\u003epublic_only or private_only\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mobile","full_name":"mobile","description":"\n\u003cp\u003ewhether called from a mobile or not (1/0)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/content_orders/block_user","name":"block_user","apis":[{"api_url":"/api/content_orders/:id/block_user","http_method":"POST","short_description":"Blocks user for specific roles","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"roles","full_name":"roles","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ewriter\u003c/code\u003e, \u003ccode\u003eeditor\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"reasons","full_name":"reasons","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"message","full_name":"message","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/content_orders/activities","name":"activities","apis":[{"api_url":"/api/content_orders/:id/activities","http_method":"GET","short_description":"Get content order activity history","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"ContentOrder Not Found.","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eContentOrder ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/content_orders/multiple_order_action","name":"multiple_order_action","apis":[{"api_url":"/api/content_orders/multiple_order_action","http_method":"POST","short_description":"Performs an action on multiple content orders.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":422,"description":"Unknown action.","metadata":null}],"params":[{"name":"batch_action","full_name":"batch_action","description":"\n\u003cp\u003eAction to be applied to content orders\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"content_order_ids","full_name":"content_order_ids","description":"\n\u003cp\u003eArray of content order ids\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/content_orders/sample_content","name":"sample_content","apis":[{"api_url":"/api/content_orders/sample_content","http_method":"GET","short_description":"Returns loved by publishers sample content ","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":422,"description":"Unknown action.","metadata":null}],"params":[{"name":"template_id","full_name":"template_id","description":"\n\u003cp\u003eTemplate Id to select content orders\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/content_orders/show","name":"show","apis":[{"api_url":"/api/project2s/:project_id/content_orders/:id","http_method":"GET","short_description":"Retrieves ContentOrder.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Project Not Found.","metadata":null},{"code":404,"description":"ContentOrder Not Found.","metadata":null},{"code":422,"description":"Unprocessable ContentOrder.","metadata":null}],"params":[{"name":"project_id","full_name":"project_id","description":"\n\u003cp\u003eProject ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent Order ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fields","full_name":"fields","description":"\n\u003cp\u003efields to be returned\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/content_orders/content_cache","name":"content_cache","apis":[{"api_url":"/api/project2s/:project_id/content_orders/:id/content_cache","http_method":"GET","short_description":"Retrieves Content Cache.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Project Not Found.","metadata":null},{"code":404,"description":"ContentOrder Not Found.","metadata":null}],"params":[{"name":"project_id","full_name":"project_id","description":"\n\u003cp\u003eProject ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent Order ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"update_cache","full_name":"update_cache","description":"\n\u003cp\u003eupdate_cache= true if always updated cache wanted\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/content_orders/create","name":"create","apis":[{"api_url":"/api/project2s/:project_id/content_orders","http_method":"POST","short_description":"Creates ContentOrder for Project.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Project Not Found.","metadata":null},{"code":422,"description":"Unprocessable Project Task.","metadata":null}],"params":[{"name":"project_id","full_name":"project_id","description":"\n\u003cp\u003eProject ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fields","full_name":"fields","description":"\n\u003cp\u003efields to be returned\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"content_order","full_name":"content_order","description":"\n\u003cp\u003eContent order parameter container\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"template_id","full_name":"content_order[template_id]","description":"\n\u003cp\u003eTemplate ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"content_order[domain_id]","description":"\n\u003cp\u003eDomain ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"language","full_name":"content_order[language]","description":"\n\u003cp\u003eLanguage\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order_type","full_name":"content_order[order_type]","description":"\n\u003cp\u003eLanguage\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"keywords","full_name":"content_order[keywords]","description":"\n\u003cp\u003eKeywords\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"keyword_substitutes","full_name":"content_order[keyword_substitutes]","description":"\n\u003cp\u003eKeyword Substitutes\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"source_url","full_name":"content_order[source_url]","description":"\n\u003cp\u003eSource Url\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"target_url","full_name":"content_order[target_url]","description":"\n\u003cp\u003eTarget Url\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"external_id","full_name":"content_order[external_id]","description":"\n\u003cp\u003eExternal Id\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/content_orders/update","name":"update","apis":[{"api_url":"/api/project2s/:project_id/content_orders/:id","http_method":"PUT","short_description":"Updates ContentOrder for Project.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Project Not Found.","metadata":null},{"code":404,"description":"ContentOrder Not Found.","metadata":null},{"code":422,"description":"Unprocessable ContentOrder.","metadata":null}],"params":[{"name":"project_id","full_name":"project_id","description":"\n\u003cp\u003eProject ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent Order ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fields","full_name":"fields","description":"\n\u003cp\u003efields to be returned\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"content_order","full_name":"content_order","description":"\n\u003cp\u003eContent order parameter container\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"template_id","full_name":"content_order[template_id]","description":"\n\u003cp\u003eTemplate ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"content_order[domain_id]","description":"\n\u003cp\u003eDomain ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"language","full_name":"content_order[language]","description":"\n\u003cp\u003eLanguage\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order_type","full_name":"content_order[order_type]","description":"\n\u003cp\u003eLanguage\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"keywords","full_name":"content_order[keywords]","description":"\n\u003cp\u003eKeywords\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"keyword_substitutes","full_name":"content_order[keyword_substitutes]","description":"\n\u003cp\u003eKeyword Substitutes\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"source_url","full_name":"content_order[source_url]","description":"\n\u003cp\u003eSource Url\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"target_url","full_name":"content_order[target_url]","description":"\n\u003cp\u003eTarget Url\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"external_id","full_name":"content_order[external_id]","description":"\n\u003cp\u003eExternal Id\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/content_orders/take_over","name":"take_over","apis":[{"api_url":"/api/project2s/:project_id/content_orders/:id/take_over","http_method":"POST","short_description":"Takeover or refresh taking over.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Project Not Found.","metadata":null},{"code":404,"description":"ContentOrder Not Found.","metadata":null},{"code":422,"description":"Unprocessable ContentOrder.","metadata":null}],"params":[{"name":"project_id","full_name":"project_id","description":"\n\u003cp\u003eProject ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent Order ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"manager","full_name":"manager","description":"\n\u003cp\u003emanager=true if manager take_over\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/content_orders/start","name":"start","apis":[{"api_url":"/api/project2s/:project_id/content_orders/:id/start","http_method":"POST","short_description":"Start Content Order","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Project Not Found.","metadata":null},{"code":404,"description":"ContentOrder Not Found.","metadata":null},{"code":422,"description":"Unprocessable ContentOrder.","metadata":null}],"params":[{"name":"project_id","full_name":"project_id","description":"\n\u003cp\u003eProject ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent Order ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/content_orders/send_forward","name":"send_forward","apis":[{"api_url":"/api/project2s/:project_id/content_orders/:id/send_forward","http_method":"POST","short_description":"Sends the order forward in workflow.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Project Not Found.","metadata":null},{"code":404,"description":"ContentOrder Not Found.","metadata":null},{"code":422,"description":"Unprocessable ContentOrder.","metadata":null}],"params":[{"name":"project_id","full_name":"project_id","description":"\n\u003cp\u003eProject ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent Order ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"workflow_message","full_name":"workflow_message","description":"\n\u003cp\u003eWorkflow Message\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"workflow_checklist","full_name":"workflow_checklist","description":"\n\u003cp\u003eWorkflow Checklist\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"approval_score","full_name":"approval_score","description":"\n\u003cp\u003eApproval score\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"task_type","full_name":"task_type","description":"\n\u003cp\u003etask type\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/content_orders/send_back","name":"send_back","apis":[{"api_url":"/api/project2s/:project_id/content_orders/:id/send_back","http_method":"POST","short_description":"Sends the order forward in workflow.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Project Not Found.","metadata":null},{"code":404,"description":"ContentOrder Not Found.","metadata":null},{"code":422,"description":"Unprocessable ContentOrder.","metadata":null}],"params":[{"name":"project_id","full_name":"project_id","description":"\n\u003cp\u003eProject ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent Order ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"workflow_message","full_name":"workflow_message","description":"\n\u003cp\u003eWorkflow Message\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"workflow_checklist","full_name":"workflow_checklist","description":"\n\u003cp\u003eWorkflow Checklist\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/content_orders/drop","name":"drop","apis":[{"api_url":"/api/project2s/:project_id/content_orders/:id/drop","http_method":"POST","short_description":"Sends the order forward in workflow.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Project Not Found.","metadata":null},{"code":404,"description":"ContentOrder Not Found.","metadata":null},{"code":422,"description":"Unprocessable ContentOrder.","metadata":null}],"params":[{"name":"project_id","full_name":"project_id","description":"\n\u003cp\u003eProject ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent Order ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"workflow_message","full_name":"workflow_message","description":"\n\u003cp\u003eWorkflow Message\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"workflow_checklist","full_name":"workflow_checklist","description":"\n\u003cp\u003eWorkflow Checklist\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"cancel_msg","full_name":"cancel_msg","description":"\n\u003cp\u003eCancel Message when reassigning.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"reasons","full_name":"reasons","description":"\n\u003cp\u003eCancel reasons\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/content_orders/flag","name":"flag","apis":[{"api_url":"/api/project2s/:project_id/content_orders/:id/flag","http_method":"POST","short_description":"Sends the order forward in workflow.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Project Not Found.","metadata":null},{"code":404,"description":"ContentOrder Not Found.","metadata":null},{"code":422,"description":"Unprocessable ContentOrder.","metadata":null}],"params":[{"name":"project_id","full_name":"project_id","description":"\n\u003cp\u003eProject ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent Order ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"workflow_message","full_name":"workflow_message","description":"\n\u003cp\u003eWorkflow Message\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"workflow_checklist","full_name":"workflow_checklist","description":"\n\u003cp\u003eWorkflow Checklist\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/content_orders/pause","name":"pause","apis":[{"api_url":"/api/project2s/:project_id/content_orders/:id/pause","http_method":"POST","short_description":"Pauses the content order.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Project Not Found.","metadata":null},{"code":404,"description":"ContentOrder Not Found.","metadata":null},{"code":422,"description":"Unprocessable ContentOrder.","metadata":null}],"params":[{"name":"project_id","full_name":"project_id","description":"\n\u003cp\u003eProject ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent Order ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/content_orders/cancel","name":"cancel","apis":[{"api_url":"/api/project2s/:project_id/content_orders/:id/cancel","http_method":"POST","short_description":"Cancels the content order.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Project Not Found.","metadata":null},{"code":404,"description":"ContentOrder Not Found.","metadata":null},{"code":422,"description":"Unprocessable ContentOrder.","metadata":null}],"params":[{"name":"project_id","full_name":"project_id","description":"\n\u003cp\u003eProject ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent Order ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/content_orders/workflow_assign","name":"workflow_assign","apis":[{"api_url":"/api/project2s/:project_id/content_orders/:id/workflow_assign","http_method":"PATCH","short_description":"Assigns actor to a workflow task.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Project Not Found.","metadata":null},{"code":404,"description":"ContentOrder Not Found.","metadata":null},{"code":422,"description":"Unprocessable ContentOrder.","metadata":null}],"params":[{"name":"project_id","full_name":"project_id","description":"\n\u003cp\u003eProject ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent Order ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"task_type","full_name":"task_type","description":"\n\u003cp\u003etask type\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"actor_id","full_name":"actor_id","description":"\n\u003cp\u003eactor_id to be assigned\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"cancel_msg","full_name":"cancel_msg","description":"\n\u003cp\u003eCancel Message when reassigning.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"reasons","full_name":"reasons","description":"\n\u003cp\u003eCancel reasons\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/content_orders/toggle_published","name":"toggle_published","apis":[{"api_url":"/api/project2s/:project_id/content_orders/:id/toggle_published","http_method":"PATCH","short_description":"Toggles between approved and published states","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Project Not Found.","metadata":null},{"code":404,"description":"ContentOrder Not Found.","metadata":null},{"code":422,"description":"Unprocessable ContentOrder.","metadata":null}],"params":[{"name":"project_id","full_name":"project_id","description":"\n\u003cp\u003eProject ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent Order ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/content_orders/destroy","name":"destroy","apis":[{"api_url":"/api/project2s/:project_id/content_orders/:id","http_method":"DELETE","short_description":"Delete ContentOrder for Project","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Project Not Found.","metadata":null},{"code":404,"description":"Project Task Not Found.","metadata":null},{"code":422,"description":"Unprocessable ContentOrder.","metadata":null}],"params":[{"name":"project_id","full_name":"project_id","description":"\n\u003cp\u003eProject ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent Order ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[]},"credit_cards":{"doc_url":"/docs/1.0/credit_cards","api_url":"","name":"Credit cards","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/credit_cards/index","name":"index","apis":[{"api_url":"/api/accounts/:account_id/credit_cards","http_method":"GET","short_description":"Lists account saved credit cards","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Account Not Found","metadata":null}],"params":[{"name":"account_id","full_name":"account_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/credit_cards/create","name":"create","apis":[{"api_url":"/api/accounts/:account_id/credit_cards","http_method":"POST","short_description":"Creates saved credit card data","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Account Not Found","metadata":null},{"code":422,"description":"Unprocessable Entity","metadata":null}],"params":[{"name":"account_id","full_name":"account_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"credit_card","full_name":"credit_card","description":"\n\u003cp\u003eCredit Card Parameter container\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"intent_id","full_name":"credit_card[intent_id]","description":"\n\u003cp\u003eSetup Intent Id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"aliased_name","full_name":"credit_card[aliased_name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/credit_cards/update","name":"update","apis":[{"api_url":"/api/accounts/:account_id/credit_cards/:id","http_method":"POST","short_description":"Updates credit card data","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Account Not Found","metadata":null},{"code":404,"description":"CreditCard Not Found","metadata":null},{"code":422,"description":"Unprocessable Entity","metadata":null}],"params":[{"name":"account_id","full_name":"account_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/credit_cards/destroy","name":"destroy","apis":[{"api_url":"/api/accounts/:account_id/credit_cards/:id","http_method":"DELETE","short_description":"Destroys saved credit card","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Account Not Found","metadata":null},{"code":404,"description":"Credit Card Notf Found","metadata":null},{"code":422,"description":"Unprocessable Entity","metadata":null}],"params":[{"name":"account_id","full_name":"account_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/credit_cards/activate","name":"activate","apis":[{"api_url":"/api/accounts/:account_id/credit_cards/:id/activate","http_method":"PATCH","short_description":"Activates saved credit card","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Account Not Found","metadata":null},{"code":404,"description":"Credit Card Notf Found","metadata":null},{"code":422,"description":"Unprocessable Entity","metadata":null}],"params":[{"name":"account_id","full_name":"account_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/credit_cards/deactivate","name":"deactivate","apis":[{"api_url":"/api/accounts/:account_id/credit_cards/:id/deactivate","http_method":"PATCH","short_description":"Deactivates saved credit card","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Account Not Found","metadata":null},{"code":404,"description":"Credit Card Notf Found","metadata":null},{"code":422,"description":"Unprocessable Entity","metadata":null}],"params":[{"name":"account_id","full_name":"account_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/credit_cards/mark_as_default","name":"mark_as_default","apis":[{"api_url":"/api/accounts/:account_id/credit_cards/:id/mark_as_default","http_method":"PATCH","short_description":"Marks the card as default.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Account Not Found","metadata":null},{"code":404,"description":"Credit Card Notf Found","metadata":null},{"code":422,"description":"Unprocessable Entity","metadata":null}],"params":[{"name":"account_id","full_name":"account_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[]},"invoices":{"doc_url":"/docs/1.0/invoices","api_url":"","name":"Invoices","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/invoices/summary","name":"summary","apis":[{"api_url":"/api/invoices/summary","http_method":"GET","short_description":"Returns invoice summaries","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"begin_date","full_name":"begin_date","description":"\n\u003cp\u003eBegin date\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Date","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"end_date","full_name":"end_date","description":"\n\u003cp\u003eEnd date (inclusive)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Date","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"country_scope","full_name":"country_scope","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eeu\u003c/code\u003e, \u003ccode\u003enon-eu\u003c/code\u003e, \u003ccode\u003enl\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePagination Parameter\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eDescribes how many transactions to show on the list. Default is 50\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[]},"account_invoices":{"doc_url":"/docs/1.0/account_invoices","api_url":"","name":"Account::Invoices","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/account_invoices/index","name":"index","apis":[{"api_url":"/api/accounts/:account_id/invoices","http_method":"GET","short_description":"Lists all account invoices","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Account Not found","metadata":null}],"params":[{"name":"account_id","full_name":"account_id","description":"\n\u003cp\u003eAccount Id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePagination Parameter\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eDescribes how many invoices to show on the list. Default is 50\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/account_invoices/show","name":"show","apis":[{"api_url":"/api/accounts/:account_id/invoices/:id.pdf","http_method":"GET","short_description":"Download account invoice","deprecated":null}],"formats":["pdf","json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Account Id Not Found","metadata":null},{"code":404,"description":"Invoice Id Not Found","metadata":null}],"params":[{"name":"account_id","full_name":"account_id","description":"\n\u003cp\u003eAccount Id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eInvoice Id to download\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/account_invoices/create","name":"create","apis":[{"api_url":"/api/accounts/:account_id/invoices","http_method":"POST","short_description":"Creates invoice","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Account Id Not Found","metadata":null}],"params":[{"name":"account_id","full_name":"account_id","description":"\n\u003cp\u003eAccount Id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[]},"account_offline_credits":{"doc_url":"/docs/1.0/account_offline_credits","api_url":"","name":"Account::OfflineCredits","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/account_offline_credits/create","name":"create","apis":[{"api_url":"/api/accounts/:account_id/offline_credits","http_method":"POST","short_description":"Creates an offline credit for given account","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":422,"description":"Unprocessable Entity","metadata":null}],"params":[{"name":"account_id","full_name":"account_id","description":"\n\u003cp\u003eAccount ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"offline_credit","full_name":"offline_credit","description":"\n\u003cp\u003eParameter container\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"amount_cents","full_name":"offline_credit[amount_cents]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"amount_currency","full_name":"offline_credit[amount_currency]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"notes","full_name":"offline_credit[notes]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[]},"account_offline_services":{"doc_url":"/docs/1.0/account_offline_services","api_url":"","name":"Account::OfflineServices","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/account_offline_services/index","name":"index","apis":[{"api_url":"/api/accounts/:account_id/offline_services","http_method":"GET","short_description":"Lists Offline Services","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"account_id","full_name":"account_id","description":"\n\u003cp\u003eAccount ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/account_offline_services/create","name":"create","apis":[{"api_url":"/api/accounts/:account_id/offline_services","http_method":"POST","short_description":"Creates an offline payment for given account","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":422,"description":"Unprocessable Entity","metadata":null}],"params":[{"name":"account_id","full_name":"account_id","description":"\n\u003cp\u003eAccount ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"offline_service","full_name":"offline_service","description":"\n\u003cp\u003eParameter container\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"amount_cents","full_name":"offline_service[amount_cents]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"amount_currency","full_name":"offline_service[amount_currency]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"notes","full_name":"offline_service[notes]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[]},"payment_intents":{"doc_url":"/docs/1.0/payment_intents","api_url":"","name":"Payment intents","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/payment_intents/create","name":"create","apis":[{"api_url":"/api/accounts/:account_id/payment_intents","http_method":"POST","short_description":"Creates A payment intent","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Account Not Found","metadata":null},{"code":404,"description":"Transaction Not Found","metadata":null}],"params":[{"name":"account_id","full_name":"account_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"transaction_id","full_name":"transaction_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"amount_cents","full_name":"amount_cents","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"notes","full_name":"notes","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/payment_intents/validate","name":"validate","apis":[{"api_url":"/api/accounts/:account_id/payment_intents/validate","http_method":"POST","short_description":"Validates Payment Intent","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Account Not Found","metadata":null}],"params":[{"name":"account_id","full_name":"account_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"intent_id","full_name":"intent_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[]},"projects":{"doc_url":"/docs/1.0/projects","api_url":"","name":"Projects","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/projects/index","name":"index","apis":[{"api_url":"/api/accounts/:account_id/projects","http_method":"GET","short_description":"Lists all accounts's projects","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[]},"receipts":{"doc_url":"/docs/1.0/receipts","api_url":"","name":"Receipts","short_description":null,"full_description":null,"version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/docs/1.0/receipts/show","name":"show","apis":[{"api_url":"/api/accounts/:account_id/receipt/:id","http_method":"GET","short_description":"Shows receipt details","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":404,"description":"Account Not Found","metadata":null},{"code":404,"description":"Receipt Not Found","metadata":null}],"params":[{"name":"account_id","full_name":"account_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null},"setup_intents":{"doc_url":"/docs/1.0/setup_intents","api_url":"","name":"Setup intents","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/setup_intents/create","name":"create","apis":[{"api_url":"/api/accounts/:account_id/setup_intents","http_method":"POST","short_description":"Creates SetupIntent for credit card","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Account Not Found","metadata":null}],"params":[{"name":"account_id","full_name":"account_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[]},"account_transactions":{"doc_url":"/docs/1.0/account_transactions","api_url":"","name":"Account::Transactions","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/account_transactions/index","name":"index","apis":[{"api_url":"/api/accounts/:account_id/transactions","http_method":"GET","short_description":"Lists account transactions","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Account Not found","metadata":null}],"params":[{"name":"account_id","full_name":"account_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePagination Parameter\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eDescribes how many transactions to show on the list. Default is 50\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[]},"activities":{"doc_url":"/docs/1.0/activities","api_url":"","name":"Activities","short_description":null,"full_description":null,"version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/docs/1.0/activities/completed_tutorials","name":"completed_tutorials","apis":[{"api_url":"/api/activities/completed_tutorials","http_method":"GET","short_description":"Returns completed tutorials count though given date range","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"first_date","full_name":"first_date","description":"\n\u003cp\u003eFirst date\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"last_date","full_name":"last_date","description":"\n\u003cp\u003eSecond date\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null},"assets":{"doc_url":"/docs/1.0/assets","api_url":"","name":"Assets","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/assets/index","name":"index","apis":[{"api_url":"/api/assets","http_method":"GET","short_description":"Fetches Assets","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[],"examples":["GET /api/assets\n200"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[]},"cint_controller":{"doc_url":"/docs/1.0/cint_controller","api_url":"","name":"Cint controller","short_description":null,"full_description":null,"version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/docs/1.0/cint_controller/index","name":"index","apis":[{"api_url":"/api/cint/analytics/survey_attemp/:user_id/:survey_id","http_method":"GET","short_description":"Notify survey start.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eUser id\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"survey_id","full_name":"survey_id","description":"\n\u003cp\u003esurvey_id or project_id\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"survey_title","full_name":"survey_title","description":"\n\u003cp\u003esurvey_title\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null},"content_parts":{"doc_url":"/docs/1.0/content_parts","api_url":"","name":"Content parts","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/content_parts/update","name":"update","apis":[{"api_url":"/api/content_orders/:content_order_id/content_parts/:id","http_method":"PUT","short_description":"Updates content part.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Task not found","metadata":null},{"code":404,"description":"ContentPart not found","metadata":null},{"code":422,"description":"Unprocessable Content Part","metadata":null}],"params":[{"name":"content_order_id","full_name":"content_order_id","description":"\n\u003cp\u003eProduct order id.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent part id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"content_part","full_name":"content_part","description":"\n\u003cp\u003eContent part parameter container\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"text","full_name":"content_part[text]","description":"\n\u003cp\u003eContent part text\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"image","full_name":"content_part[image]","description":"\n\u003cp\u003eContent part image\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a File","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"remote_image_url","full_name":"content_part[remote_image_url]","description":"\n\u003cp\u003eRemote image for content part\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[]},"currencies":{"doc_url":"/docs/1.0/currencies","api_url":"","name":"Currencies","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/currencies/index","name":"index","apis":[{"api_url":"/api/currencies","http_method":"GET","short_description":"Lists currencies","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/currencies/convert_euro","name":"convert_euro","apis":[{"api_url":"/api/currencies/convert_euro","http_method":"GET","short_description":"Lists currencies","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"amount_to_convert","full_name":"amount_to_convert","description":"\n\u003cp\u003eAmount\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"currency_to_convert","full_name":"currency_to_convert","description":"\n\u003cp\u003eCurrency\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[]},"domains":{"doc_url":"/docs/1.0/domains","api_url":"","name":"Domains","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/domains/index","name":"index","apis":[{"api_url":"/api/domains","http_method":"GET","short_description":"Lists domains.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"mode","full_name":"mode","description":"\n\u003cp\u003eDomains listing mode\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"account_id","full_name":"account_id","description":"\n\u003cp\u003eDomains listing for given account\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"count","full_name":"count","description":"\n\u003cp\u003eitems count in payload\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"offset","full_name":"offset","description":"\n\u003cp\u003eitems start position\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order_by","full_name":"order_by","description":"\n\u003cp\u003eitems sort field\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order_asc","full_name":"order_asc","description":"\n\u003cp\u003eitems sort order\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"filter","full_name":"filter","description":"\n\u003cp\u003eFilter parameter\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/domains/show","name":"show","apis":[{"api_url":"/api/domains/:id","http_method":"GET","short_description":"Shows project domain.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eDomain ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/domains/update","name":"update","apis":[{"api_url":"/api/domains/:id","http_method":"PUT","short_description":"Update domain","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Domain Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eDomain ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/domains/create","name":"create","apis":[{"api_url":"/api/domains","http_method":"POST","short_description":"Creates new domain.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Domain Not Found.","metadata":null},{"code":422,"description":"Unprocessable Domain.","metadata":null}],"params":[{"name":"account_id","full_name":"account_id","description":"\n\u003cp\u003eBusiness Account Id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/domains/destroy","name":"destroy","apis":[{"api_url":"/api/domains/:id","http_method":"DELETE","short_description":"Delete domain","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Domain Not Found","metadata":null},{"code":422,"description":"Unprocessable Domain.","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eDomain ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/domains/upload_from_tsv","name":"upload_from_tsv","apis":[{"api_url":"/api/domains/upload_from_tsv","http_method":"POST","short_description":"Uploads domain from TSV file.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Domain Not Found.","metadata":null},{"code":422,"description":"Unprocessable Domain.","metadata":null}],"params":[{"name":"account_id","full_name":"account_id","description":"\n\u003cp\u003eBusiness Account Id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/domains/assumptions","name":"assumptions","apis":[{"api_url":"/api/domains/assumptions","http_method":"GET","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"term","full_name":"term","description":"\n\u003cp\u003ekeyword to be searched\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mode","full_name":"mode","description":"\n\u003cp\u003emode to retrieve templates from: account or library\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"account_id","full_name":"account_id","description":"\n\u003cp\u003eDomains listing for given account\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/domains/parse_meta","name":"parse_meta","apis":[{"api_url":"/api/domains/parse_meta","http_method":"GET","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"url","full_name":"url","description":"\n\u003cp\u003eUrl for meta\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/domains/invite_account","name":"invite_account","apis":[{"api_url":"/api/domains/invite_account","http_method":"POST","short_description":"Invite member for share domain","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eDomain ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"emails_or_ids","full_name":"emails_or_ids","description":"\n\u003cp\u003eUser email to send invitation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/domains/shared_accounts","name":"shared_accounts","apis":[{"api_url":"/api/domains/shared_accounts","http_method":"GET","short_description":"List accounts of domain","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eDomain ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"account_id","full_name":"account_id","description":"\n\u003cp\u003eAccount ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/domains/delete_shared_account","name":"delete_shared_account","apis":[{"api_url":"/api/domains/delete_shared_account","http_method":"DELETE","short_description":"Remove shared account","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"account_id","full_name":"account_id","description":"\n\u003cp\u003eAccount ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eDomain ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/domains/analytics","name":"analytics","apis":[{"api_url":"/api/domains/analytics","http_method":"GET","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"url","full_name":"url","description":"\n\u003cp\u003eUrl for analysis\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"token","full_name":"token","description":"\n\u003cp\u003eWordpress slimstat plugin token for url\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"revenue_per_visit","full_name":"revenue_per_visit","description":"\n\u003cp\u003eValue for calculating revenue\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/domains/projects","name":"projects","apis":[{"api_url":"/api/domains/projects","http_method":"GET","short_description":"Projects where the given domain is used","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Domain Not Found","metadata":null},{"code":422,"description":"Unprocessable Domain.","metadata":null}],"params":[{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eDomain Id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/domains/multiple_domain_action","name":"multiple_domain_action","apis":[{"api_url":"/api/domains/multiple_domain_action","http_method":"POST","short_description":"Performs an action on multiple domains.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":422,"description":"Unknown action.","metadata":null}],"params":[{"name":"batch_action","full_name":"batch_action","description":"\n\u003cp\u003eAction to be applied to domains\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain_ids","full_name":"domain_ids","description":"\n\u003cp\u003eArray of domain ids\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"shared_account_emails_or_ids","full_name":"shared_account_emails_or_ids","description":"\n\u003cp\u003eArray of shared account emails\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"select_all","full_name":"select_all","description":"\n\u003cp\u003eIf true select all domains\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/domains/domain_count","name":"domain_count","apis":[{"api_url":"/api/domains/domain_count","http_method":"GET","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"account_id","full_name":"account_id","description":"\n\u003cp\u003eDomains count for given account\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mode","full_name":"mode","description":"\n\u003cp\u003eDomains listing mode\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"filter","full_name":"filter","description":"\n\u003cp\u003eFilter\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/domains/whois","name":"whois","apis":[{"api_url":"/api/domains/whois","http_method":"GET","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"url","full_name":"url","description":"\n\u003cp\u003eUrl for whois data\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/domains/serpbook","name":"serpbook","apis":[{"api_url":"/api/domains/serpbook","http_method":"GET","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"url","full_name":"url","description":"\n\u003cp\u003eUrl for serpbook data\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/domains/regions_and_languages","name":"regions_and_languages","apis":[{"api_url":"/api/domains/regions_and_languages","http_method":"GET","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/domains/serpbook_actions","name":"serpbook_actions","apis":[{"api_url":"/api/domains/serpbook_actions","http_method":"POST","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eDomain ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"keyword","full_name":"keyword","description":"\n\u003cp\u003eKeywords for serpbook analytics\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"region","full_name":"region","description":"\n\u003cp\u003eGoogle region for serpbook analytics\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"language","full_name":"language","description":"\n\u003cp\u003eLanguage for serpbook analytics\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"tracking","full_name":"tracking","description":"\n\u003cp\u003eWhich platform for serpbook, should be desktop or mobile\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location","full_name":"location","description":"\n\u003cp\u003eLocation for serpbook\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"serpbook_action","full_name":"serpbook_action","description":"\n\u003cp\u003ePerforms an action on serpbook.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/domains/suggestion_keywords","name":"suggestion_keywords","apis":[{"api_url":"/api/domains/suggestion_keywords","http_method":"GET","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eDomain ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/domains/change_owner","name":"change_owner","apis":[{"api_url":"/api/domains/change_owner","http_method":"POST","short_description":"Change domain owners","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"mode","full_name":"mode","description":"\n\u003cp\u003eWhen mode is share, moved domain(s) would be shared with previous owner\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain_ids","full_name":"domain_ids","description":"\n\u003cp\u003eDomain Ids\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"email","full_name":"email","description":"\n\u003cp\u003eEmail of the owner of the account, where domains are to be moved\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/domains/serpbook_tmp_to_real","name":"serpbook_tmp_to_real","apis":[{"api_url":"/api/domains/serpbook_tmp_to_real","http_method":"GET","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eDomain ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/domains/save_scripts","name":"save_scripts","apis":[{"api_url":"/api/domains/save_scripts","http_method":"POST","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eDomain Id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"scripts","full_name":"scripts","description":"\n\u003cp\u003eScripts content in JSON format\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/domains/plugin_list","name":"plugin_list","apis":[{"api_url":"/api/domains/plugin_list","http_method":"GET","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eDomain Id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/domains/plugin_remote_actions","name":"plugin_remote_actions","apis":[{"api_url":"/api/domains/plugin_remote_actions","http_method":"POST","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eDomain Id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"plugin_action","full_name":"plugin_action","description":"\n\u003cp\u003eAction\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"plugin_name","full_name":"plugin_name","description":"\n\u003cp\u003ePlugin name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/domains/listing","name":"listing","apis":[{"api_url":"/api/domains/listing","http_method":"GET","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eDomain Id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/domains/listing_action","name":"listing_action","apis":[{"api_url":"/api/domains/listing_action","http_method":"POST","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eDomain Id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"listing_action","full_name":"listing_action","description":"\n\u003cp\u003eListing action\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"listing_data","full_name":"listing_data","description":"\n\u003cp\u003eListing data\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/domains/export","name":"export","apis":[{"api_url":"/api/domains/export","http_method":"GET","short_description":"Exports domain's in tsv format","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"columns","full_name":"columns","description":"\n\u003cp\u003eCould be all or preferred\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"format","full_name":"format","description":"\n\u003cp\u003eShould be tsv\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain_ids","full_name":"domain_ids","description":"\n\u003cp\u003eArray of domain ids\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"select_all","full_name":"select_all","description":"\n\u003cp\u003eIf true select all domains\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mode","full_name":"mode","description":"\n\u003cp\u003eWhich table users come from (admin, account, hamburger)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"filter","full_name":"filter","description":"\n\u003cp\u003eSpecifies which domain table\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"url_account_id","full_name":"url_account_id","description":"\n\u003cp\u003eNeeds if mode equals account\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/domains/update_google_ads","name":"update_google_ads","apis":[{"api_url":"/api/domains/update_google_ads","http_method":"POST","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eDomain Id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/domains/update_google_analytics","name":"update_google_analytics","apis":[{"api_url":"/api/domains/update_google_analytics","http_method":"POST","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eDomain Id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/domains/save_filter","name":"save_filter","apis":[{"api_url":"/api/domains/save_filter","http_method":"POST","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"filter","full_name":"filter","description":"\n\u003cp\u003eFilter parameter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"is_share_with_account","full_name":"is_share_with_account","description":"\n\u003cp\u003eIs shared with account\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/domains/filters","name":"filters","apis":[{"api_url":"/api/domains/filters","http_method":"GET","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/domains/multiple_tag_actions","name":"multiple_tag_actions","apis":[{"api_url":"/api/domains/multiple_tag_actions","http_method":"POST","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"domain_tags","full_name":"domain_tags","description":"\n\u003cp\u003eFilter parameter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/domains/change_date_range_of_google_data","name":"change_date_range_of_google_data","apis":[{"api_url":"/api/domains/change_date_range_of_google_data","http_method":"POST","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"start_date","full_name":"start_date","description":"\n\u003cp\u003eStart date of the data that fetch from google. Format should be: YYYY-MM-DD\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"end_date","full_name":"end_date","description":"\n\u003cp\u003eEnd date of the data that fetch from google. Format should be: YYYY-MM-DD\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/domains/tags","name":"tags","apis":[{"api_url":"/api/domains/tags","http_method":"POST","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"domain_ids","full_name":"domain_ids","description":"\n\u003cp\u003eArray of domain ids\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/domains/status_percentage","name":"status_percentage","apis":[{"api_url":"/api/domains/status_percentage","http_method":"POST","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eDomain Id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[]},"financial_statuses":{"doc_url":"/docs/1.0/financial_statuses","api_url":"","name":"Financial statuses","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/financial_statuses/index","name":"index","apis":[{"api_url":"/api/financial_statuses","http_method":"GET","short_description":"Lists of financial status.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[]},"gads":{"doc_url":"/docs/1.0/gads","api_url":"","name":"Gads","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/gads/accounts","name":"accounts","apis":[{"api_url":"/api/gads/accounts","http_method":"GET","short_description":"Get list of Google Ads accounts","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"account_id","full_name":"account_id","description":"\n\u003cp\u003eBusiness Account Id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/gads/add_account","name":"add_account","apis":[{"api_url":"/api/gads/add_account","http_method":"POST","short_description":"Add a new Google Ads account","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"page_url","full_name":"page_url","description":"\n\u003cp\u003eRedirection url after permissions processing\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"account_id","full_name":"account_id","description":"\n\u003cp\u003eBusiness Account Id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"gads_account_id","full_name":"gads_account_id","description":"\n\u003cp\u003eGoogle Ads account id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/gads/update_account","name":"update_account","apis":[{"api_url":"/api/gads/update_account","http_method":"POST","short_description":"Update an existing Google Ads account","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"account_id","full_name":"account_id","description":"\n\u003cp\u003eBusiness Account Id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"gads_account_id","full_name":"gads_account_id","description":"\n\u003cp\u003eGoogle Ads account id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"matched_domain_id","full_name":"matched_domain_id","description":"\n\u003cp\u003eDomain Id\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/gads/authorize","name":"authorize","apis":[{"api_url":"/api/gads/authorize","http_method":"POST","short_description":"Authorize Google ads account","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Google Ads account not found","metadata":null},{"code":422,"description":"Unprocessable entry","metadata":null}],"params":[{"name":"account_credential_id","full_name":"account_credential_id","description":"\n\u003cp\u003eAccount Credential Id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/gads/delete_account","name":"delete_account","apis":[{"api_url":"/api/gads/delete_account","http_method":"DELETE","short_description":"Delete Google Ads account","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Google Ads account not found","metadata":null},{"code":422,"description":"Unprocessable entry","metadata":null}],"params":[{"name":"account_credential_id","full_name":"account_credential_id","description":"\n\u003cp\u003eAccount Credential Id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/gads/campaigns","name":"campaigns","apis":[{"api_url":"/api/gads/campaigns","http_method":"GET","short_description":"Get list of Google Ads campaigns","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"account_credential_id","full_name":"account_credential_id","description":"\n\u003cp\u003eAccount Credential Id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/gads/ad_groups","name":"ad_groups","apis":[{"api_url":"/api/gads/ad_groups","http_method":"GET","short_description":"Get list of Google Ads ad groups","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"account_credential_id","full_name":"account_credential_id","description":"\n\u003cp\u003eAccount Credential Id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"gads_campaign_id","full_name":"gads_campaign_id","description":"\n\u003cp\u003eGoogle Ads Campaign Id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/gads/selected_text_ad_items","name":"selected_text_ad_items","apis":[{"api_url":"/api/gads/selected_text_ad_items","http_method":"GET","short_description":"Get list of selected text ads","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"account_credential_id","full_name":"account_credential_id","description":"\n\u003cp\u003eAccount Credential Id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subscription_id","full_name":"subscription_id","description":"\n\u003cp\u003eSubscription Id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"gads_campaigns","full_name":"gads_campaigns","description":"\n\u003cp\u003eGoogle Ads Campaigns Array\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/gads/exp_text_ad_items","name":"exp_text_ad_items","apis":[{"api_url":"/api/gads/exp_text_ad_items","http_method":"GET","short_description":"Get list of expanded text ads","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"account_credential_id","full_name":"account_credential_id","description":"\n\u003cp\u003eAccount Credential Id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"gads_ad_group_id","full_name":"gads_ad_group_id","description":"\n\u003cp\u003eGoogle Ads Ad Group Id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/gads/upload_exp_text_ad_orders","name":"upload_exp_text_ad_orders","apis":[{"api_url":"/api/gads/upload_exp_text_ad_orders","http_method":"POST","short_description":"Upload new expanded text ad orders","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"language","full_name":"language","description":"\n\u003cp\u003eLanguage\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"account_credential_id","full_name":"account_credential_id","description":"\n\u003cp\u003eAccount Credential Id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"gads_campaign_id","full_name":"gads_campaign_id","description":"\n\u003cp\u003eGoogle Ads Campaign Id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"gads_ad_group_id","full_name":"gads_ad_group_id","description":"\n\u003cp\u003eGoogle Ads Ad Group Id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"gads_ad_ids","full_name":"gads_ad_ids","description":"\n\u003cp\u003eGoogle Ads ExpandedTextAd Ids\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"subscription_id","full_name":"subscription_id","description":"\n\u003cp\u003eThe Subscription Id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/gads/subscriptions","name":"subscriptions","apis":[{"api_url":"/api/gads/subscriptions","http_method":"GET","short_description":"Get list of subscriptions","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/gads/goals","name":"goals","apis":[{"api_url":"/api/gads/goals","http_method":"GET","short_description":"Get list of goals","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/gads/samples","name":"samples","apis":[{"api_url":"/api/gads/samples","http_method":"GET","short_description":"Get list of sample ads","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"content_order_id","full_name":"content_order_id","description":"\n\u003cp\u003eContent Order Id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/gads/order","name":"order","apis":[{"api_url":"/api/gads/order","http_method":"POST","short_description":"Google Ads order wizard","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"account_id","full_name":"account_id","description":"\n\u003cp\u003eBusiness Account Id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003eCurrent page identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"direction","full_name":"direction","description":"\n\u003cp\u003eNext page direction: forward, back\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page_params","full_name":"page_params","description":"\n\u003cp\u003eOrder parameters for the page\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[]},"goals":{"doc_url":"/docs/1.0/goals","api_url":"","name":"Goals","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/goals/index","name":"index","apis":[{"api_url":"/api/goals","http_method":"GET","short_description":"Lists Goals","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"year","full_name":"year","description":"\n\u003cp\u003eDefault is current year\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/goals/create","name":"create","apis":[{"api_url":"/api/goals","http_method":"POST","short_description":"Creates goal","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":422,"description":"Unprocessable Entity","metadata":null}],"params":[{"name":"goal","full_name":"goal","description":"\n\u003cp\u003eParameter Container\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"date","full_name":"goal[date]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Date","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"cents","full_name":"goal[cents]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/goals/update","name":"update","apis":[{"api_url":"/api/goals/:id","http_method":"PUT","short_description":"Updates goal","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"goal","full_name":"goal","description":"\n\u003cp\u003eParameter Container\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"date","full_name":"goal[date]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Date","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"cents","full_name":"goal[cents]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[]},"google_analytics":{"doc_url":"/docs/1.0/google_analytics","api_url":"","name":"Google analytics","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/google_analytics/credentials","name":"credentials","apis":[{"api_url":"/api/google_analytics/credentials","http_method":"GET","short_description":"Get credentials of connected google analytics account","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"account_id","full_name":"account_id","description":"\n\u003cp\u003eAccount Id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/google_analytics/connect","name":"connect","apis":[{"api_url":"/api/google_analytics/connect","http_method":"POST","short_description":"Add a new Google Analytics account","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"page_url","full_name":"page_url","description":"\n\u003cp\u003eRedirection url after permissions processing\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"account_id","full_name":"account_id","description":"\n\u003cp\u003eBusiness Account Id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/google_analytics/disconnect","name":"disconnect","apis":[{"api_url":"/api/google_analytics/disconnect","http_method":"POST","short_description":"Disconnect google analytics account","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"account_id","full_name":"account_id","description":"\n\u003cp\u003eBusiness Account Id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/google_analytics/accounts","name":"accounts","apis":[{"api_url":"/api/google_analytics/accounts","http_method":"GET","short_description":"Get all google analytics account","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"account_id","full_name":"account_id","description":"\n\u003cp\u003eBusiness Account Id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/google_analytics/properties","name":"properties","apis":[{"api_url":"/api/google_analytics/properties","http_method":"GET","short_description":"Get properties of connected google analytics account","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"account_id","full_name":"account_id","description":"\n\u003cp\u003eBusiness Account Id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"google_analytics_account_id","full_name":"google_analytics_account_id","description":"\n\u003cp\u003eGoogle Analytics Account Id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/google_analytics/update_google_analytics_ids","name":"update_google_analytics_ids","apis":[{"api_url":"/api/google_analytics/update_google_analytics_ids","http_method":"PATCH","short_description":"Google analytics account, view and web property id","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"account_id","full_name":"account_id","description":"\n\u003cp\u003eBusiness Account Id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eDomain Id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/google_analytics/connected_domains","name":"connected_domains","apis":[{"api_url":"/api/google_analytics/connected_domains","http_method":"GET","short_description":"Get connected domains","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"account_id","full_name":"account_id","description":"\n\u003cp\u003eBusiness Account Id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/google_analytics/metric","name":"metric","apis":[{"api_url":"/api/google_analytics/metric","http_method":"GET","short_description":"Google Analytics Metrics","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"account_id","full_name":"account_id","description":"\n\u003cp\u003eBusiness Account Id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eDomain Id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"metric","full_name":"metric","description":"\n\u003cp\u003eGoogle Analytics metric\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"end_date","full_name":"end_date","description":"\n\u003cp\u003eEnd Date\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"start_date","full_name":"start_date","description":"\n\u003cp\u003eStart Date\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/google_analytics/goals","name":"goals","apis":[{"api_url":"/api/google_analytics/goals","http_method":"GET","short_description":"Google Analytics Goals","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"account_id","full_name":"account_id","description":"\n\u003cp\u003eBusiness Account Id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eDomain Id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"end_date","full_name":"end_date","description":"\n\u003cp\u003eEnd Date\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"start_date","full_name":"start_date","description":"\n\u003cp\u003eStart Date\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[]},"intercom":{"doc_url":"/docs/1.0/intercom","api_url":"","name":"Intercom","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/intercom/data","name":"data","apis":[{"api_url":"/api/intercom/data","http_method":"GET","short_description":"Required data for front office","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[]},"invoice_profiles":{"doc_url":"/docs/1.0/invoice_profiles","api_url":"","name":"Invoice profiles","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/invoice_profiles/update","name":"update","apis":[{"api_url":"/api/invoice_profiles/:user_id","http_method":"PUT","short_description":"Updates a user profile.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"User Not Found.","metadata":null},{"code":422,"description":"Unprocessable Entity.","metadata":null}],"params":[{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eUser Id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"invoice_profile","full_name":"invoice_profile","description":"\n\u003cp\u003eInvoice Profile parameter container\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"profile_type","full_name":"invoice_profile[profile_type]","description":"\n\u003cp\u003eINDIVIDUAL/BUSINESS\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"address_line_1","full_name":"invoice_profile[address_line_1]","description":"\n\u003cp\u003e…\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"address_line_2","full_name":"invoice_profile[address_line_2]","description":"\n\u003cp\u003e…\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"business_contact_role","full_name":"invoice_profile[business_contact_role]","description":"\n\u003cp\u003eDIRECTOR/OWNER/OTHER\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"business_name","full_name":"invoice_profile[business_name]","description":"\n\u003cp\u003e…\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"business_registration_country","full_name":"invoice_profile[business_registration_country]","description":"\n\u003cp\u003e2 letter ISO 3166-1 country code\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"business_registration_id","full_name":"invoice_profile[business_registration_id]","description":"\n\u003cp\u003e…\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"business_registration_state_province","full_name":"invoice_profile[business_registration_state_province]","description":"\n\u003cp\u003e…\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"business_type","full_name":"invoice_profile[business_type]","description":"\n\u003cp\u003e…\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"city","full_name":"invoice_profile[city]","description":"\n\u003cp\u003e…\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"country","full_name":"invoice_profile[country]","description":"\n\u003cp\u003e2 letter ISO 3166-1 country code\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"country_of_birth","full_name":"invoice_profile[country_of_birth]","description":"\n\u003cp\u003e2 letter ISO 3166-1 country code\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"date_of_birth","full_name":"invoice_profile[date_of_birth]","description":"\n\u003cp\u003e…\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"driver_licence_id","full_name":"invoice_profile[driver_licence_id]","description":"\n\u003cp\u003e…\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"email","full_name":"invoice_profile[email]","description":"\n\u003cp\u003e…\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"employer_id","full_name":"invoice_profile[employer_id]","description":"\n\u003cp\u003e…\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"first_name","full_name":"invoice_profile[first_name]","description":"\n\u003cp\u003e…\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"gender","full_name":"invoice_profile[gender]","description":"\n\u003cp\u003eMALE/FEMALE\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"government_id","full_name":"invoice_profile[government_id]","description":"\n\u003cp\u003e…\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"language","full_name":"invoice_profile[language]","description":"\n\u003cp\u003e2 letter ISO 639-1 language code\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"last_name","full_name":"invoice_profile[last_name]","description":"\n\u003cp\u003e…\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"middle_name","full_name":"invoice_profile[middle_name]","description":"\n\u003cp\u003e…\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mobile_number","full_name":"invoice_profile[mobile_number]","description":"\n\u003cp\u003e…\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"passport_id","full_name":"invoice_profile[passport_id]","description":"\n\u003cp\u003e…\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"phone_number","full_name":"invoice_profile[phone_number]","description":"\n\u003cp\u003e…\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"postal_code","full_name":"invoice_profile[postal_code]","description":"\n\u003cp\u003e…\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"state_province","full_name":"invoice_profile[state_province]","description":"\n\u003cp\u003e…\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"tax_id","full_name":"invoice_profile[tax_id]","description":"\n\u003cp\u003e…\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/invoice_profiles/show","name":"show","apis":[{"api_url":"/api/invoice_profiles/:user_id","http_method":"GET","short_description":"Returns invoice profile.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"User Not Found.","metadata":null}],"params":[{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eUser Id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/invoice_profiles/required_fields","name":"required_fields","apis":[{"api_url":"/api/invoice_profiles/required_fields","http_method":"GET","short_description":"Returns required fields.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"country","full_name":"country","description":"\n\u003cp\u003eCountry Code\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"profile_type","full_name":"profile_type","description":"\n\u003cp\u003eProfile Type\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[]},"notifications":{"doc_url":"/docs/1.0/notifications","api_url":"","name":"Notifications","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/notifications/index","name":"index","apis":[{"api_url":"/api/notifications","http_method":"GET","short_description":"Notifications of current user.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eFor pagination. Default is 10.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003eFor pagination. Page number\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"examples":["GET /api/notifications\n200"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/notifications/show","name":"show","apis":[{"api_url":"/notifications/:id","http_method":"GET","short_description":"Notification detail","deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eReturns notification and marks it as read.\u003c/p\u003e\n","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Notification Not Found.","metadata":null}],"params":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/notifications/destroy","name":"destroy","apis":[{"api_url":"/notifications/:id","http_method":"DELETE","short_description":"Deletes the notification","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Notification Not Found.","metadata":null},{"code":422,"description":"Unprocessable Notification.","metadata":null}],"params":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/notifications/unread_counts","name":"unread_counts","apis":[{"api_url":"/notifications/unread-counts","http_method":"GET","short_description":"Unread notification count","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/notifications/read_all","name":"read_all","apis":[{"api_url":"/notifications/read-all","http_method":"PATCH","short_description":"Marks as read all unread notifications","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[]},"applications":{"doc_url":"/docs/1.0/applications","api_url":"","name":"Applications","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/applications/index","name":"index","apis":[{"api_url":"/api/oauth/applications","http_method":"GET","short_description":"Lists current_user's open auth applications","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[],"examples":["GET /api/oauth/applications\n200"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/applications/show","name":"show","apis":[{"api_url":"/api/oauth/applications/:id","http_method":"GET","short_description":"Represents appliaction's detail","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Application Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eApplication ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"application","full_name":"application","description":"\n\u003cp\u003eApplication parameter container\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"application[name]","description":"\n\u003cp\u003eApplication Name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"redirect_uri","full_name":"application[redirect_uri]","description":"\n\u003cp\u003eApplication’s redirect uri\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"examples":["GET /api/oauth/applications/59c241e5a83dc1219d4f3181\n200"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/applications/create","name":"create","apis":[{"api_url":"/api/oauth/applications","http_method":"POST","short_description":"Creates Oauth Application","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":422,"description":"Unprocessable Document","metadata":null}],"params":[{"name":"application","full_name":"application","description":"\n\u003cp\u003eApplication parameter container\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"application[name]","description":"\n\u003cp\u003eApplication Name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"redirect_uri","full_name":"application[redirect_uri]","description":"\n\u003cp\u003eApplication’s redirect uri\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"examples":["PUT /api/oauth/applications\n{\n  \"application\": {\n    \"name\": \"\"\n  }\n}\n401"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/applications/update","name":"update","apis":[{"api_url":"/api/oauth/applications/:id","http_method":"PUT","short_description":"Updates Oauth Application","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Application Not Found","metadata":null},{"code":422,"description":"Unprocessable Document","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eApplication ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"application","full_name":"application","description":"\n\u003cp\u003eApplication parameter container\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"application[name]","description":"\n\u003cp\u003eApplication Name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"redirect_uri","full_name":"application[redirect_uri]","description":"\n\u003cp\u003eApplication’s redirect uri\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"examples":["PUT /api/oauth/applications/59c241e6a83dc1219d4f3192\n{\n  \"application\": {\n    \"name\": \"\"\n  }\n}\n403"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/applications/destroy","name":"destroy","apis":[{"api_url":"/api/oauth/applications/:id","http_method":"DELETE","short_description":"Destroys Oauth Application","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Application Not Found","metadata":null},{"code":422,"description":"Unprocessable Document","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eApplication ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["PUT /api/oauth/applications/59c241e6a83dc1219d4f31b0\n{\n  \"application\": {}\n}\n401"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[]},"authorizations":{"doc_url":"/docs/1.0/authorizations","api_url":"","name":"Authorizations","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/authorizations/new","name":"new","apis":[{"api_url":"/api/oauth/authorize/new","http_method":"GET","short_description":"Application authorization intermediate url.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"client_id","full_name":"client_id","description":"\n\u003cp\u003eApplication Client ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"redirect_uri","full_name":"redirect_uri","description":"\n\u003cp\u003eApplication Redirect URI\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"response_type","full_name":"response_type","description":"\n\u003cp\u003eResponse Type. Should be code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["GET /api/oauth/authorize/new\n200"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[]},"payments":{"doc_url":"/docs/1.0/payments","api_url":"","name":"Payments","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/payments/index","name":"index","apis":[{"api_url":"/api/payments","http_method":"GET","short_description":"Lists Payments","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"state","full_name":"state","description":"\n\u003cp\u003eState of Transactions\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eUser Id\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"begin_date","full_name":"begin_date","description":"\n\u003cp\u003eBegin date\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Date","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"end_date","full_name":"end_date","description":"\n\u003cp\u003eEnd date\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Date","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/payments/reprocess","name":"reprocess","apis":[{"api_url":"/api/payments/:id/reprocess","http_method":"POST","short_description":"Reprocess the payment if it is failed","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Payment Not found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003ePayment ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/payments/mass_pay","name":"mass_pay","apis":[{"api_url":"/api/payments/mass_pay","http_method":"POST","short_description":"This does mass payment","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"payment_ids","full_name":"payment_ids","description":"\n\u003cp\u003ePayment IDS\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/payments/mass_cancel","name":"mass_cancel","apis":[{"api_url":"/api/payments/mass_cancel","http_method":"POST","short_description":"This does mass cancel","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"payment_ids","full_name":"payment_ids","description":"\n\u003cp\u003ePayment IDS\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[]},"pdx2":{"doc_url":"/docs/1.0/pdx2","api_url":"","name":"Pdx2","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/pdx2/op","name":"op","apis":[{"api_url":"/api/pdx/op","http_method":"POST","short_description":"PDX Endpoint","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":422,"description":"Unprocessable","metadata":null}],"params":[{"name":"op","full_name":"op","description":"\n\u003cp\u003eOperation code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"url","description":"\n\u003cp\u003eUrl for site analyze\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eDomain id\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"data","full_name":"data","description":"\n\u003cp\u003eMix of options possible\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/pdx2/tickets","name":"tickets","apis":[{"api_url":"/api/pdx/tickets","http_method":"POST","short_description":"PDX Tickets Processing Endpoint","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":422,"description":"Unprocessable","metadata":null}],"params":[{"name":"ticket_id","full_name":"ticket_id","description":"\n\u003cp\u003eTicket Id to process\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/pdx2/message","name":"message","apis":[{"api_url":"/api/pdx/notify","http_method":"POST","short_description":"PDX Notification Processing Endpoint","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":422,"description":"Unprocessable","metadata":null}],"params":[{"name":"domain_url","full_name":"domain_url","description":"\n\u003cp\u003eDomain url\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ticket_id","full_name":"ticket_id","description":"\n\u003cp\u003eTicket Id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"message_id","full_name":"message_id","description":"\n\u003cp\u003eMessage Id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"message_json","full_name":"message_json","description":"\n\u003cp\u003eMessage in JSON Text Format\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[]},"invite_urls":{"doc_url":"/docs/1.0/invite_urls","api_url":"","name":"Invite urls","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/invite_urls/index","name":"index","apis":[{"api_url":"/api/project2s/:project_id/invite_urls","http_method":"GET","short_description":"Lists invitation link for the project","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Project Not Found.","metadata":null}],"params":[{"name":"project_id","full_name":"project_id","description":"\n\u003cp\u003eProject ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/invite_urls/create","name":"create","apis":[{"api_url":"/api/project2s/:project_id/invite_urls","http_method":"POST","short_description":"Creates invitation link for the project","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Project Not Found.","metadata":null},{"code":422,"description":"Unprocessable Entity.","metadata":null}],"params":[{"name":"project_id","full_name":"project_id","description":"\n\u003cp\u003eProject ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"project_roles","full_name":"project_roles","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/invite_urls/email","name":"email","apis":[{"api_url":"/api/project2s/:project_id/invite_urls/:id/email","http_method":"POST","short_description":"Sends invitation e-mail","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Project Not Found.","metadata":null},{"code":404,"description":"Project Link Not Found.","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"project_id","full_name":"project_id","description":"\n\u003cp\u003eProject ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"emails","full_name":"emails","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[]},"invitees":{"doc_url":"/docs/1.0/invitees","api_url":"","name":"Invitees","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/invitees/create","name":"create","apis":[{"api_url":"/api/project2s/:project_id/invitees","http_method":"POST","short_description":"Creates invitation for the project","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Project Not Found.","metadata":null},{"code":422,"description":"Unprocessable Invitees.","metadata":null}],"params":[{"name":"project_id","full_name":"project_id","description":"\n\u003cp\u003eProject ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"email","full_name":"email","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"project_roles","full_name":"project_roles","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[]},"pending_tasks":{"doc_url":"/docs/1.0/pending_tasks","api_url":"","name":"Pending tasks","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/pending_tasks/show","name":"show","apis":[{"api_url":"/api/project2s/:project_id/pending_tasks","http_method":"GET","short_description":"Shows project pending task.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Project Not Found.","metadata":null}],"params":[{"name":"project_id","full_name":"project_id","description":"\n\u003cp\u003eProject ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"pending_task_type","full_name":"pending_task_type","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[]},"project2s":{"doc_url":"/docs/1.0/project2s","api_url":"","name":"Project2s","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/project2s/index","name":"index","apis":[{"api_url":"/api/project2s","http_method":"GET","short_description":"Lists projects for the session user.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Project Not Found.","metadata":null}],"params":[{"name":"filter_type","full_name":"filter_type","description":"\n\u003cp\u003eFor specific project listing\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"filter","full_name":"filter","description":"\n\u003cp\u003ecomma separated filter to apply e.g. “admin_list,status:running”\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"fields","full_name":"fields","description":"\n\u003cp\u003ecomma separated fields wanted in payload\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"status","description":"\n\u003cp\u003eStatus of projects\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"extended_version","full_name":"extended_version","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/project2s/show","name":"show","apis":[{"api_url":"/api/project2s/:id","http_method":"GET","short_description":"Shows project details.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Project Not Found.","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eProject ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fields","full_name":"fields","description":"\n\u003cp\u003ecomma separated fields wanted in payload\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/project2s/create","name":"create","apis":[{"api_url":"/api/project2s","http_method":"POST","short_description":"Creates new project.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Project Not Found.","metadata":null},{"code":422,"description":"Unprocessable Project2.","metadata":null}],"params":[{"name":"fields","full_name":"fields","description":"\n\u003cp\u003ecomma separated fields wanted in payload\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/project2s/destroy","name":"destroy","apis":[{"api_url":"/api/project2s/:id","http_method":"DELETE","short_description":"Delete project","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Project Not Found","metadata":null},{"code":422,"description":"Unprocessable Project2.","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eProject ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/project2s/statistics","name":"statistics","apis":[{"api_url":"/api/project2s/:id/statistics","http_method":"POST","short_description":"Project statistics","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Project Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eProject ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fields","full_name":"fields","description":"\n\u003cp\u003ecomma separated fields wanted in payload\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/project2s/export","name":"export","apis":[{"api_url":"/api/project2s/:id/export","http_method":"GET","short_description":"Exports project's content orders in given format such as xml,json, csv or markdown","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Project Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eProject ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["GET /api/project2s/59c241e8a83dc1219d4f3249/export.xml\n200\n\u003c?xml version=\"1.0\" encoding=\"UTF-8\"?\u003e\n\u003cproject id=\"59c241e8a83dc1219d4f3249\"\u003e\n\u003c/project\u003e\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/project2s/copy","name":"copy","apis":[{"api_url":"/api/project2s/:id/copy","http_method":"POST","short_description":"Copies Project2","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Project Not Found","metadata":null},{"code":422,"description":"Unprocessable Project2.","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eProject ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fields","full_name":"fields","description":"\n\u003cp\u003ecomma separated fields wanted in payload\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/project2s/update","name":"update","apis":[{"api_url":"/api/project2s/:id","http_method":"PUT","short_description":"Update Project","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Project Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eProject ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fields","full_name":"fields","description":"\n\u003cp\u003ecomma separated fields wanted in payload\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"project","full_name":"project","description":"\n\u003cp\u003eProject parameter container\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"project[name]","description":"\n\u003cp\u003eProject name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"account_id","full_name":"project[account_id]","description":"\n\u003cp\u003eAccount ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"default_template_id","full_name":"project[default_template_id]","description":"\n\u003cp\u003eDefault template ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"project[status]","description":"\n\u003cp\u003erunning, paused, archived\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"public","full_name":"project[public]","description":"\n\u003cp\u003enot private\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"max_in_progress","full_name":"project[max_in_progress]","description":"\n\u003cp\u003eMaximum number of tasks allowed to be in progress\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"plagiarism_percentage","full_name":"project[plagiarism_percentage]","description":"\n\u003cp\u003ePlagiarism Percentage\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"spellchecker","full_name":"project[spellchecker]","description":"\n\u003cp\u003eSpellchecker name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"rule_check_for","full_name":"project[rule_check_for]","description":"\n\u003cp\u003eRule check for :writer, :editor, :client, :manager\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"time_frame","full_name":"project[time_frame]","description":"\n\u003cp\u003eSets for minimum time between tasks\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/project2s/available_task","name":"available_task","apis":[{"api_url":"/api/project2s/:id/available_task","http_method":"PUT","short_description":"Update Project available task per person","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eProject ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"external_id","full_name":"external_id","description":"\n\u003cp\u003eTask external Id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"amount","full_name":"amount","description":"\n\u003cp\u003eamount\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/project2s/available_tasks","name":"available_tasks","apis":[{"api_url":"/api/project2s/:id/available_tasks","http_method":"GET","short_description":"Get all available task per persons of Project","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eProject ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/project2s/change_account","name":"change_account","apis":[{"api_url":"/api/project2s/:id/change_account","http_method":"POST","short_description":"Change account of project","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Project Not Found","metadata":null},{"code":422,"description":"Unprocessable Project2.","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eProject ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"account_id","full_name":"account_id","description":"\n\u003cp\u003eNew account id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/project2s/confirm_upload_duplicates","name":"confirm_upload_duplicates","apis":[{"api_url":"/api/project2s/confirm_upload_duplicates","http_method":"POST","short_description":"Confirming of upload duplicates","deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eThis route confirms duplicate cases of uploading content orders\u003c/p\u003e\n","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Project Not Found","metadata":null}],"params":[{"name":"upload_id","full_name":"upload_id","description":"\n\u003cp\u003eUpload Id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"confirmations","full_name":"confirmations","description":"\n\u003cp\u003eDuplicate items confirmation data\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/project2s/upload_content_orders","name":"upload_content_orders","apis":[{"api_url":"/api/project2s/:id/upload_content_orders","http_method":"PUT","short_description":"Upload Content Orders","deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eThis route uploads content orders to given project id.\u003c/p\u003e\n","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Project Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eProject ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"file","full_name":"file","description":"\n\u003cp\u003eFile that includes orders as tsv format\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/project2s/_upload_content_text","name":"_upload_content_text","apis":[{"api_url":"/api/project2s/upload_content_text","http_method":"POST","short_description":"Upload Content Orders Text","deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eThis route uploads content orders without a project id in the route. Project id should be in the tsv text.\u003c/p\u003e\n","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Project Not Found","metadata":null}],"params":[{"name":"text","full_name":"text","description":"\n\u003cp\u003eText that includes orders in TSV format\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/project2s/_upload_content_orders","name":"_upload_content_orders","apis":[{"api_url":"/api/project2s/upload_content_orders","http_method":"PUT","short_description":"Upload Content Orders","deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eThis route uploads content orders without a project id in the route. Project id should be in tsv file.\u003c/p\u003e\n","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Project Not Found","metadata":null}],"params":[{"name":"file","full_name":"file","description":"\n\u003cp\u003eFile that includes orders as tsv format\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/project2s/block_user","name":"block_user","apis":[{"api_url":"/api/project2s/:id/block_user","http_method":"POST","short_description":"Blocks user for specific roles","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"roles","full_name":"roles","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ewriter\u003c/code\u003e, \u003ccode\u003eeditor\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"reasons","full_name":"reasons","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"message","full_name":"message","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/project2s/unblock_user","name":"unblock_user","apis":[{"api_url":"/api/project2s/:id/unblock_user","http_method":"POST","short_description":"Unblocks user for specific roles or for all roles","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"roles","full_name":"roles","description":"\n\u003cp\u003eRoles to unblock\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ewriter\u003c/code\u003e, \u003ccode\u003eeditor\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/project2s/blocked_users","name":"blocked_users","apis":[{"api_url":"/api/project2s/:id/blocked_users","http_method":"GET","short_description":"Returns blocked user list","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[]},"project_filters":{"doc_url":"/docs/1.0/project_filters","api_url":"","name":"Project filters","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/project_filters/index","name":"index","apis":[{"api_url":"/api/project_filters","http_method":"GET","short_description":"Lists filters.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eFilters listing for given user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/project_filters/show","name":"show","apis":[{"api_url":"/api/project_filters/:id","http_method":"GET","short_description":"Shows project filter.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eProject Filter ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/project_filters/update","name":"update","apis":[{"api_url":"/api/project_filters/:id","http_method":"PUT","short_description":"Update filter","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Filter Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eFilter ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003eName of filter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"filter","full_name":"filter","description":"\n\u003cp\u003eFilter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"is_shared_with_account","full_name":"is_shared_with_account","description":"\n\u003cp\u003eTrue or false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/project_filters/create","name":"create","apis":[{"api_url":"/api/project_filters","http_method":"POST","short_description":"Creates new project filter.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Filter Not Found.","metadata":null}],"params":[{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eUser Id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003eName of filter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"filter","full_name":"filter","description":"\n\u003cp\u003eFilter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"is_shared_with_account","full_name":"is_shared_with_account","description":"\n\u003cp\u003eTrue or false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/project_filters/destroy","name":"destroy","apis":[{"api_url":"/api/project_filters/:id","http_method":"DELETE","short_description":"Delete filter","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Filter Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eFilter ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[]},"connections":{"doc_url":"/docs/1.0/connections","api_url":"","name":"Connections","short_description":null,"full_description":null,"version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/docs/1.0/connections/index","name":"index","apis":[{"api_url":"/api/project2s/:project_id/connections","http_method":"GET","short_description":"Lists project's connections.","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":404,"description":"Project Not Found","metadata":null}],"params":[{"name":"project_id","full_name":"project_id","description":"\n\u003cp\u003eProject ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/connections/revoke","name":"revoke","apis":[{"api_url":"/api/project2s/:project_id/connections/:id","http_method":"DELETE","short_description":"Removes connection.","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":404,"description":"Project Not Found","metadata":null},{"code":404,"description":"Connection Not Found","metadata":null},{"code":422,"description":"Unprocessable EventHook.","metadata":null}],"params":[{"name":"project_id","full_name":"project_id","description":"\n\u003cp\u003eProject ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eConnection ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/connections/retrigger","name":"retrigger","apis":[{"api_url":"/api/project2s/:project_id/connections/:id","http_method":"POST","short_description":"Re triggers project's hooks.","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":404,"description":"Project Not Found","metadata":null},{"code":404,"description":"Connection Not Found","metadata":null},{"code":422,"description":"Unprocessable Project.","metadata":null}],"params":[{"name":"project_id","full_name":"project_id","description":"\n\u003cp\u003eProject ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eConnection ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/connections/retrigger_for_selected_tasks","name":"retrigger_for_selected_tasks","apis":[{"api_url":"/api/project2s/:project_id/connections/:id/retrigger_for_selected_tasks","http_method":"POST","short_description":"Re triggers only selected orders.","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":404,"description":"Project Not Found","metadata":null},{"code":404,"description":"Connection Not Found","metadata":null},{"code":422,"description":"Unprocessable Project.","metadata":null}],"params":[{"name":"project_id","full_name":"project_id","description":"\n\u003cp\u003eProject ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eConnection ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"content_order_ids","full_name":"content_order_ids","description":"\n\u003cp\u003eContent order ids\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null},"participants":{"doc_url":"/docs/1.0/participants","api_url":"","name":"Participants","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/participants/index","name":"index","apis":[{"api_url":"/api/project2s/:project_id/participants","http_method":"GET","short_description":"Lists project participants","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Project Not Found.","metadata":null}],"params":[{"name":"project_id","full_name":"project_id","description":"\n\u003cp\u003eProject ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/participants/create","name":"create","apis":[{"api_url":"/api/project2s/:project_id/participants","http_method":"POST","short_description":"Creates project participant","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Project Not Found.","metadata":null},{"code":422,"description":"Unprocessable Participant.","metadata":null}],"params":[{"name":"project_id","full_name":"project_id","description":"\n\u003cp\u003eProject ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"participant","full_name":"participant","description":"\n\u003cp\u003eParticipant parameter container\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"user_id","full_name":"participant[user_id]","description":"\n\u003cp\u003eUser ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"roles","full_name":"participant[roles]","description":"\n\u003cp\u003eRoles of user\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"examples":["POST /api/projects/59c241dba83dc1219d4f29f1/participants\n{\n  \"roles\": [\n    \"writer\"\n  ],\n  \"user_id\": \"59c241daa83dc1219d4f29ee\",\n  \"participant\": {\n    \"roles\": [\n      \"writer\"\n    ],\n    \"user_id\": \"59c241daa83dc1219d4f29ee\"\n  }\n}\n201"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/participants/update","name":"update","apis":[{"api_url":"/api/project2s/:project_id/participants/:id","http_method":"PUT","short_description":"Updates project participant","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Participant / Project Not Found.","metadata":null},{"code":422,"description":"Unprocessable Participant.","metadata":null}],"params":[{"name":"project_id","full_name":"project_id","description":"\n\u003cp\u003eProject ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eParticipant ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"participant","full_name":"participant","description":"\n\u003cp\u003eParticipant parameter container\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"roles","full_name":"participant[roles]","description":"\n\u003cp\u003eRoles of user\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/participants/destroy","name":"destroy","apis":[{"api_url":"/api/project2s/:project_id/participants/:id","http_method":"DELETE","short_description":"Deletes project participant","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Project Not Found.","metadata":null},{"code":404,"description":"Participant Not Found.","metadata":null},{"code":422,"description":"Unprocessable Participant.","metadata":null}],"params":[{"name":"project_id","full_name":"project_id","description":"\n\u003cp\u003eProject ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eParticipant ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/participants/pause","name":"pause","apis":[{"api_url":"/api/project2s/:project_id/participants/:id/pause","http_method":"PATCH","short_description":"Pauses project participant.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Project Not Found.","metadata":null},{"code":404,"description":"Participant Not Found.","metadata":null},{"code":422,"description":"Unprocessable Participant.","metadata":null}],"params":[{"name":"project_id","full_name":"project_id","description":"\n\u003cp\u003eProject ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eParticipant ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[]},"template_details":{"doc_url":"/docs/1.0/template_details","api_url":"","name":"Template details","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/template_details/index","name":"index","apis":[{"api_url":"/api/project_templates/:project_template_id/details","http_method":"GET","short_description":"Returns project template's details.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"project_template_id","full_name":"project_template_id","description":"\n\u003cp\u003eProject template id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["GET /api/project_templates/59c241d4a83dc1219d4f2931/details\n401"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/template_details/multi_persist","name":"multi_persist","apis":[{"api_url":"/api/project_templates/:project_template_id/details/multi_persist","http_method":"POST","short_description":"Push multiple detail items for 1 template","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"project_template_id","full_name":"project_template_id","description":"\n\u003cp\u003eProject template id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template_detail","full_name":"template_detail","description":"\n\u003cp\u003eProject template detail parameter container.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"item_id","full_name":"template_detail[item_id]","description":"\n\u003cp\u003eItem id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"instruction","full_name":"template_detail[instruction]","description":"\n\u003cp\u003eInstruction of detail.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"rules","full_name":"template_detail[rules]","description":"\n\u003cp\u003eRule container\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"type","full_name":"template_detail[rules][type]","description":"\n\u003cp\u003eThe type of rule. Available types are: \u003cb\u003eword_count,character_count,main_keyword,sub_keyword,alternative_keywords,pixel_size,list_item,negative_keywords\u003c/b\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameters","full_name":"template_detail[rules][parameters]","description":"\n\u003cp\u003eRule parameter container\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"template_detail[rules][parameters][name]","description":"\n\u003cp\u003eThe name of parameter. Available parameters are: \u003cb\u003eminimum,maximum,repetition,location,match,index,indexes,current,keyword,keywords,height,width,list_type,current_width,min_width,max_width,current_height,min_height,max_height\u003c/b\u003e\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"template_detail[rules][parameters][value]","description":"\n\u003cp\u003eThe value of parameter name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: String, Boolean, Integer.","expected_type":"string","metadata":null,"show":true,"validations":[]}]}]},{"name":"custom_attributes","full_name":"template_detail[custom_attributes]","description":"\n\u003cp\u003ecustom attributes of item\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"item_id","full_name":"item_id","description":"\n\u003cp\u003eItem id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["POST /api/project_templates/59c241d4a83dc1219d4f290a/details/multi_persist\n{\n  \"template_details\": [\n    {\n      \"html_type\": \"h1\",\n      \"instruction\": \"instruction\"\n    },\n    {\n      \"html_type\": \"h2\",\n      \"instruction\": \"instruction c\",\n      \"detail_id\": {\n        \"$oid\": \"59c241d4a83dc1219d4f290c\"\n      }\n    },\n    {\n      \"html_type\": \"h2\",\n      \"instruction\": \"instruction 2\"\n    }\n  ],\n  \"template_detail\": {\n    \"template_details\": [\n      {\n        \"html_type\": \"h1\",\n        \"instruction\": \"instruction\"\n      },\n      {\n        \"html_type\": \"h2\",\n        \"instruction\": \"instruction c\",\n        \"detail_id\": {\n          \"$oid\": \"59c241d4a83dc1219d4f290c\"\n        }\n      },\n      {\n        \"html_type\": \"h2\",\n        \"instruction\": \"instruction 2\"\n      }\n    ]\n  }\n}\n200"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[]},"template_items":{"doc_url":"/docs/1.0/template_items","api_url":"","name":"Template items","short_description":null,"full_description":null,"version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/docs/1.0/template_items/index","name":"index","apis":[{"api_url":"/api/template_items","http_method":"GET","short_description":"Returns project template's items.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null},"templates":{"doc_url":"/docs/1.0/templates","api_url":"","name":"Templates","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/templates/index","name":"index","apis":[{"api_url":"/api/project_templates","http_method":"GET","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"offset","full_name":"offset","description":"\n\u003cp\u003eitems start position\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"count","full_name":"count","description":"\n\u003cp\u003eitems count in payload\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order_by","full_name":"order_by","description":"\n\u003cp\u003eitems sort field\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order_asc","full_name":"order_asc","description":"\n\u003cp\u003eitems sort order\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mode","full_name":"mode","description":"\n\u003cp\u003eretrieve templates from: account or library\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"q","full_name":"q","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"assumption","full_name":"assumption","description":"\n\u003cp\u003eFind the exact match(s) for the assumption\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}],"examples":["GET /api/project_templates\n401"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/templates/show","name":"show","apis":[{"api_url":"/api/project_templates/:id","http_method":"GET","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Template Not Found.","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eTemplate Id.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/templates/create","name":"create","apis":[{"api_url":"/api/project_templates","http_method":"POST","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":422,"description":"Unprocessable Project Template","metadata":null}],"params":[{"name":"template","full_name":"template","description":"\n\u003cp\u003eTemplate attributes container\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"template[name]","description":"\n\u003cp\u003eThe name of template\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"template[description]","description":"\n\u003cp\u003eThe description of template\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"instructions","full_name":"template[instructions]","description":"\n\u003cp\u003eThe instructions of template\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"language","full_name":"template[language]","description":"\n\u003cp\u003eThe language of template\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"professions","full_name":"template[professions]","description":"\n\u003cp\u003eThe professions(topics) of template\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"difficulty_level","full_name":"template[difficulty_level]","description":"\n\u003cp\u003eDifficult level of template.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"price_amount","full_name":"template[price_amount]","description":"\n\u003cp\u003ePrice in Cent\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"price_currency","full_name":"template[price_currency]","description":"\n\u003cp\u003ePrice currency code\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ready_to_use","full_name":"template[ready_to_use]","description":"\n\u003cp\u003eReady to use\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"details","full_name":"template[details]","description":"\n\u003cp\u003eTemplate details attributes container\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"html_type","full_name":"template[details][html_type]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"instruction","full_name":"template[details][instruction]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"read_only","full_name":"template[details][read_only]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"locked","full_name":"template[details][locked]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"rules","full_name":"template[details][rules]","description":"\n\u003cp\u003eDetail rules attributes container\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"type","full_name":"template[details][rules][type]","description":"\n\u003cp\u003eThe type of rule. Available types are: \u003cb\u003eword_count,character_count,main_keyword,sub_keyword,alternative_keywords,pixel_size,list_item,negative_keywords\u003c/b\u003e\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameters","full_name":"template[details][rules][parameters]","description":"\n\u003cp\u003eRule parameters attributes container\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"template[details][rules][parameters][name]","description":"\n\u003cp\u003eThe name of parameter. Available parameters are: \u003cb\u003eminimum,maximum,repetition,location,match,index,indexes,current,keyword,keywords,height,width,list_type,current_width,min_width,max_width,current_height,min_height,max_height\u003c/b\u003e\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"template[details][rules][parameters][value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}]},{"name":"custom_attributes","full_name":"template[details][custom_attributes]","description":"\n\u003cp\u003ecustom attributes of item\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}]}],"examples":["POST /api/project_templates\n{\n  \"template\": {\n    \"name\": \"Madiga\"\n  }\n}\n201"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/templates/update","name":"update","apis":[{"api_url":"/api/project_templates/:id","http_method":"PUT","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":422,"description":"Unprocessable Project Template","metadata":null},{"code":404,"description":"Template Not Found.","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eTemplate ID.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"template","description":"\n\u003cp\u003eProject template parameter container\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"template[name]","description":"\n\u003cp\u003eTemplate name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"examples":["PUT /api/project_templates/59c241f9a83dc1219d4f4e70\n{\n  \"template\": {\n    \"name\": \"agidaM\"\n  }\n}\n204"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/templates/export","name":"export","apis":[{"api_url":"/api/project_templates/:id/export","http_method":"GET","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":422,"description":"Unprocessable Project Template","metadata":null},{"code":404,"description":"Template Not Found.","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eTemplate ID.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/templates/empty_sheet","name":"empty_sheet","apis":[{"api_url":"/api/project_templates/:id/empty_sheet","http_method":"GET","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":422,"description":"Unprocessable Project Template","metadata":null},{"code":404,"description":"Template Not Found.","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eTemplate Id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"project_id","full_name":"project_id","description":"\n\u003cp\u003eProject Id\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eDomain Id\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/templates/destroy","name":"destroy","apis":[{"api_url":"/api/project_templates/:id","http_method":"DELETE","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":422,"description":"Unprocessable Project Template","metadata":null},{"code":404,"description":"Template Not Found.","metadata":null},{"code":422,"description":"Unprocessable Project Template","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eTemplate ID.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["DELETE /api/project_templates/59c241f9a83dc1219d4f4e7b\n204"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/templates/assumptions","name":"assumptions","apis":[{"api_url":"/api/project_templates/assumptions","http_method":"GET","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"term","full_name":"term","description":"\n\u003cp\u003ekeyword to be searched\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mode","full_name":"mode","description":"\n\u003cp\u003emode to retrieve templates from: account or library\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/templates/save_to_my_templates","name":"save_to_my_templates","apis":[{"api_url":"/api/project_templates/:id/my_templates","http_method":"POST","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Template Not Found.","metadata":null},{"code":422,"description":"Unprocessable Account","metadata":null},{"code":422,"description":"Unprocessable Project Template","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eTemplate ID.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/templates/delete_from_my_templates","name":"delete_from_my_templates","apis":[{"api_url":"/api/project_templates/:id/my_templates","http_method":"DELETE","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Template Not Found.","metadata":null},{"code":422,"description":"Unprocessable Account","metadata":null},{"code":422,"description":"Unprocessable Project Template","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eTemplate ID.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/templates/content_cache","name":"content_cache","apis":[{"api_url":"/api/project_templates/content_cache","http_method":"GET","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Template Not Found.","metadata":null}],"params":[{"name":"content_order_id","full_name":"content_order_id","description":"\n\u003cp\u003eContent Order Id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/templates/upload_prices","name":"upload_prices","apis":[{"api_url":"/api/project_templates/upload_prices","http_method":"POST","short_description":"Upload Prices","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":422,"description":"Unprocessable entry","metadata":null}],"params":[{"name":"file","full_name":"file","description":"\n\u003cp\u003eFile that contains prices\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a File","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/templates/prices","name":"prices","apis":[{"api_url":"/api/project_templates/prices","http_method":"GET","short_description":"Shows templates prices","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/templates/upload","name":"upload","apis":[{"api_url":"/api/project_templates/upload","http_method":"POST","short_description":"Upload and create template.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":422,"description":"Unprocessable entry","metadata":null}],"params":[{"name":"file","full_name":"file","description":"\n\u003cp\u003eFile that contains json data\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a File","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/templates/instructions","name":"instructions","apis":[{"api_url":"/api/project_templates/instructions","http_method":"GET","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/templates/save_instructions","name":"save_instructions","apis":[{"api_url":"/api/project_templates/save_instructions","http_method":"POST","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"html_type","full_name":"html_type","description":"\n\u003cp\u003ehtml type of the instruction\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"language","full_name":"language","description":"\n\u003cp\u003elanguage of the instruction\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"instructions","full_name":"instructions","description":"\n\u003cp\u003eInstructions array of text\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/templates/validate_template","name":"validate_template","apis":[{"api_url":"/api/project_templates/validate_template","http_method":"POST","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"details","full_name":"details","description":"\n\u003cp\u003edetails of the template\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"template","description":"\n\u003cp\u003etemplate to be validate\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/templates/build_from_html","name":"build_from_html","apis":[{"api_url":"/api/project_templates/build_from_html","http_method":"POST","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"name","full_name":"name","description":"\n\u003cp\u003eTemplate name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order_type","full_name":"order_type","description":"\n\u003cp\u003eTemplate order type\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"language","full_name":"language","description":"\n\u003cp\u003eTemplate language\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"genre","full_name":"genre","description":"\n\u003cp\u003eTemplate genre\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"html_text","full_name":"html_text","description":"\n\u003cp\u003ehtml text to parse into template\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/templates/by_domain","name":"by_domain","apis":[{"api_url":"/api/project_templates/by_domain","http_method":"GET","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Template Not Found.","metadata":null}],"params":[{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eDomain Id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[]},"quote_forms":{"doc_url":"/docs/1.0/quote_forms","api_url":"","name":"Quote forms","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/quote_forms/translation_order","name":"translation_order","apis":[{"api_url":"/api/quote_forms/translation_order","http_method":"POST","short_description":"Uploads files regarding translation","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"files","full_name":"files","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"source_lang","full_name":"source_lang","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"target_langs","full_name":"target_langs","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[]},"reports":{"doc_url":"/docs/1.0/reports","api_url":"","name":"Reports","short_description":null,"full_description":null,"version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/docs/1.0/reports/zip_account_invoices","name":"zip_account_invoices","apis":[{"api_url":"/api/reports/zip_account_invoices","http_method":"GET","short_description":"Returns 202 status code","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":404,"description":"Account Not Found","metadata":null},{"code":422,"description":"Invalid E-mail","metadata":null}],"params":[{"name":"begin_date","full_name":"begin_date","description":"\n\u003cp\u003eBegin date\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Date","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"end_date","full_name":"end_date","description":"\n\u003cp\u003eEnd date (inclusive)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Date","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"email","full_name":"email","description":"\n\u003cp\u003eE-mail that zip file goes to.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"account_id","full_name":"account_id","description":"\n\u003cp\u003eAccount Id\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"country_scope","full_name":"country_scope","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eeu\u003c/code\u003e, \u003ccode\u003enon-eu\u003c/code\u003e, \u003ccode\u003enl\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"invoice_ids","full_name":"invoice_ids","description":"\n\u003cp\u003eSelected Invoice ids\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null},"rules":{"doc_url":"/docs/1.0/rules","api_url":"","name":"Rules","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/rules/index","name":"index","apis":[{"api_url":"/api/rules","http_method":"GET","short_description":"Lists content rules.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[]},"self_invoices":{"doc_url":"/docs/1.0/self_invoices","api_url":"","name":"Self invoices","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/self_invoices/destroy","name":"destroy","apis":[{"api_url":"/api/self_invoices/:id","http_method":"DELETE","short_description":"Delete self invoice","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Invoice Id Not Found","metadata":null},{"code":422,"description":"Unprocessable Entity.","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eInvoice Id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/self_invoices/mass_delete","name":"mass_delete","apis":[{"api_url":"/api/self_invoices/mass_delete","http_method":"POST","short_description":"This does mass payment","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":422,"description":"Unprocessable Entity","metadata":null}],"params":[{"name":"invoice_ids","full_name":"invoice_ids","description":"\n\u003cp\u003eInvoice Ids\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/self_invoices/pay","name":"pay","apis":[{"api_url":"/api/self_invoices/:id/pay","http_method":"POST","short_description":"Pays an invoice and returns Offline Payment","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Invoice Id Not Found","metadata":null},{"code":422,"description":"Unprocessable Entity","metadata":null}],"params":[{"name":"notes","full_name":"notes","description":"\n\u003cp\u003ePayment Notes\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/self_invoices/summary","name":"summary","apis":[{"api_url":"/api/self_invoices/summary","http_method":"GET","short_description":"Returns invoice summaries","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"begin_date","full_name":"begin_date","description":"\n\u003cp\u003eBegin date\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Date","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"end_date","full_name":"end_date","description":"\n\u003cp\u003eEnd date (inclusive)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Date","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"country_scope","full_name":"country_scope","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eeu\u003c/code\u003e, \u003ccode\u003enon-eu\u003c/code\u003e, \u003ccode\u003enl\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"payment_state","full_name":"payment_state","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003epaid\u003c/code\u003e, \u003ccode\u003ecancelled\u003c/code\u003e, \u003ccode\u003efailed\u003c/code\u003e, \u003ccode\u003eprocessing\u003c/code\u003e, \u003ccode\u003epending\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/self_invoices/zip_summary","name":"zip_summary","apis":[{"api_url":"/api/self_invoices/zip_summary","http_method":"GET","short_description":"Returns 202 status code","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"begin_date","full_name":"begin_date","description":"\n\u003cp\u003eBegin date\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Date","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"end_date","full_name":"end_date","description":"\n\u003cp\u003eEnd date (inclusive)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Date","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"country_scope","full_name":"country_scope","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eeu\u003c/code\u003e, \u003ccode\u003enon-eu\u003c/code\u003e, \u003ccode\u003enl\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/self_invoices/index","name":"index","apis":[{"api_url":"/api/users/:user_id/self_invoices","http_method":"GET","short_description":"List user invoices","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"User Not Found","metadata":null}],"params":[{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eUser Id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/self_invoices/create","name":"create","apis":[{"api_url":"/api/users/:user_id/self_invoices","http_method":"POST","short_description":"Creates Invoice","deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eThere are 4 kinds of error messages for now. Those messages comes under \u003ccode\u003ebase\u003c/code\u003e attribute in JSON. Those errors are: \u003ccode\u003einvoice_profile_needs_to_be_created\u003c/code\u003e, \u003ccode\u003einvoice_profile_has_required_fields\u003c/code\u003e \u003ccode\u003edutch_citizen_cannot_create_invoice\u003c/code\u003e, \u003ccode\u003etransaction_not_found\u003c/code\u003e\u003c/p\u003e\n","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"User Not Found","metadata":null},{"code":422,"description":"Unprocessable Entity","metadata":null}],"params":[{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eUser Id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"from_accountant","full_name":"from_accountant","description":"\n\u003cp\u003eTells that if user is accountant or not.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003e0\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/self_invoices/show","name":"show","apis":[{"api_url":"/api/users/:user_id/self_invoices/:id","http_method":"GET","short_description":"Returns invoice detail","deprecated":null}],"formats":["pdf","json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"User Id Not Found","metadata":null},{"code":404,"description":"Invoice Id Not Found","metadata":null}],"params":[{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eUser id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eInvoice Id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[]},"stats":{"doc_url":"/docs/1.0/stats","api_url":"","name":"Stats","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/stats/revenues","name":"revenues","apis":[{"api_url":"/api/stats/revenues","http_method":"GET","short_description":"Lists revenues","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"start_date","full_name":"start_date","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Date","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"end_date","full_name":"end_date","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Date","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/stats/deposits","name":"deposits","apis":[{"api_url":"/api/stats/deposits","http_method":"GET","short_description":"Lists deposits","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"start_date","full_name":"start_date","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Date","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"end_date","full_name":"end_date","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Date","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/stats/active_accounts","name":"active_accounts","apis":[{"api_url":"/api/stats/active_accounts","http_method":"GET","short_description":"Lists active accounts","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"start_date","full_name":"start_date","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Date","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"end_date","full_name":"end_date","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Date","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/stats/projects_by_language","name":"projects_by_language","apis":[{"api_url":"/api/stats/projects_by_language","http_method":"GET","short_description":"Lists projects","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"language","full_name":"language","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/stats/show","name":"show","apis":[{"api_url":"/api/users/:user_id/stats","http_method":"GET","short_description":"Returns user stats","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"user_id","full_name":"user_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[]},"surveys":{"doc_url":"/docs/1.0/surveys","api_url":"","name":"Surveys","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/surveys/start_survey_task","name":"start_survey_task","apis":[{"api_url":"/api/surveys/start_survey_task","http_method":"GET","short_description":"Start survey task","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Item is not found","metadata":null}],"params":[{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eUser identifier for starting survey task.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"survey_id","full_name":"survey_id","description":"\n\u003cp\u003esurveyId to start the task\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[]},"transaction_fee_invoices":{"doc_url":"/docs/1.0/transaction_fee_invoices","api_url":"","name":"Transaction fee invoices","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/transaction_fee_invoices/summary","name":"summary","apis":[{"api_url":"/api/transaction_fee_invoices/summary","http_method":"GET","short_description":"Returns transaction fee invoice summaries","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"begin_date","full_name":"begin_date","description":"\n\u003cp\u003eBegin date\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Date","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"end_date","full_name":"end_date","description":"\n\u003cp\u003eEnd date (inclusive)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Date","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"country_scope","full_name":"country_scope","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eeu\u003c/code\u003e, \u003ccode\u003enon-eu\u003c/code\u003e, \u003ccode\u003enl\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/transaction_fee_invoices/zip_summary","name":"zip_summary","apis":[{"api_url":"/api/transaction_fee_invoices/zip_summary","http_method":"GET","short_description":"Returns 202 status code","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"begin_date","full_name":"begin_date","description":"\n\u003cp\u003eBegin date\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Date","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"end_date","full_name":"end_date","description":"\n\u003cp\u003eEnd date (inclusive)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Date","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/transaction_fee_invoices/index","name":"index","apis":[{"api_url":"/api/users/:user_id/transaction_fee_invoices","http_method":"GET","short_description":"List transaction fee invoices","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"User Not Found","metadata":null}],"params":[{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eUser Id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/transaction_fee_invoices/show","name":"show","apis":[{"api_url":"/api/users/:user_id/transaction_fee_invoices/:id","http_method":"GET","short_description":"Returns invoice detail","deprecated":null}],"formats":["pdf","json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"User Id Not Found","metadata":null},{"code":404,"description":"Invoice Id Not Found","metadata":null}],"params":[{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eUser id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eInvoice Id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[]},"accounts":{"doc_url":"/docs/1.0/accounts","api_url":"","name":"Accounts","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/accounts/serpbook_key","name":"serpbook_key","apis":[{"api_url":"/api/users/:user_id/accounts/:id/serpbook_key","http_method":"PATCH","short_description":"Add serpbook key","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Account Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eAccount ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eUser Id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"serpbook_api_key","full_name":"serpbook_api_key","description":"\n\u003cp\u003eSerpbook Key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/accounts/tags","name":"tags","apis":[{"api_url":"/api/users/:user_id/accounts/:id/tags","http_method":"PATCH","short_description":"Add or remove tag","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Account Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eAccount ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eUser Id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"tags","full_name":"tags","description":"\n\u003cp\u003eTags\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/accounts/serpbook_account_info","name":"serpbook_account_info","apis":[{"api_url":"/api/users/:user_id/accounts/:id/serpbook_account_info","http_method":"GET","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Account Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eAccount ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eUser Id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/accounts/invite_member","name":"invite_member","apis":[{"api_url":"/api/users/:user_id/accounts/:id/invite_member","http_method":"POST","short_description":"Invite member to the account","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Account Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eAccount ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"email","full_name":"email","description":"\n\u003cp\u003eUser email to send invitation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/accounts/member_role","name":"member_role","apis":[{"api_url":"/api/users/:user_id/accounts/:id/member_role","http_method":"PUT","short_description":"Modify member role in the account","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Account Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eAccount ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"member_id","full_name":"member_id","description":"\n\u003cp\u003eUser ID to modify role\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"role","full_name":"role","description":"\n\u003cp\u003eMember role name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"granted","full_name":"granted","description":"\n\u003cp\u003eMember role permission\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/accounts/pending_member_invitations","name":"pending_member_invitations","apis":[{"api_url":"/api/users/:user_id/accounts/:id/pending_member_invitations","http_method":"GET","short_description":"Lists pending member invitations","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Account Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eAccount ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/accounts/delete_member_invitation","name":"delete_member_invitation","apis":[{"api_url":"/api/users/:user_id/accounts/:id/delete_member_invitation","http_method":"DELETE","short_description":"Deletes pending member invitations","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Account Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eAccount ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"affiliate_id","full_name":"affiliate_id","description":"\n\u003cp\u003eAffiliate ID to remove from invitations\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/accounts/members","name":"members","apis":[{"api_url":"/api/users/:user_id/accounts/:id/members","http_method":"GET","short_description":"Lists account members","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Account Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eAccount ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/accounts/delete_member","name":"delete_member","apis":[{"api_url":"/api/users/:user_id/accounts/:id/delete_member","http_method":"DELETE","short_description":"Remove account member","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Account Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eAccount ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"member_id","full_name":"member_id","description":"\n\u003cp\u003eUser ID to remove from membership\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/accounts/all","name":"all","apis":[{"api_url":"/api/users/accounts/all","http_method":"GET","short_description":"Lists all accounts","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003eSkip page number\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eRows count to be displayed\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"q","full_name":"q","description":"\n\u003cp\u003eSearch term\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/accounts/index","name":"index","apis":[{"api_url":"/api/users/:user_id/accounts","http_method":"GET","short_description":"Lists current_user's accounts","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eUser ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/accounts/registered","name":"registered","apis":[{"api_url":"/api/users/:user_id/accounts/registered","http_method":"GET","short_description":"Lists given user's registered accounts.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eUser ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/accounts/show","name":"show","apis":[{"api_url":"/api/users/:user_id/accounts/:id","http_method":"GET","short_description":"Represents account's detail","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Account Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eAccount ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eUser ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"account","full_name":"account","description":"\n\u003cp\u003eAccount parameter container\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"account[name]","description":"\n\u003cp\u003eAccount Name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"vat_no","full_name":"account[vat_no]","description":"\n\u003cp\u003eVat number\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"crm_id","full_name":"account[crm_id]","description":"\n\u003cp\u003eCRM ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"billing_street","full_name":"account[billing_street]","description":"\n\u003cp\u003eBilling Street\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"billing_city","full_name":"account[billing_city]","description":"\n\u003cp\u003eBilling City\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"billing_province","full_name":"account[billing_province]","description":"\n\u003cp\u003eBilling Province\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"billing_code","full_name":"account[billing_code]","description":"\n\u003cp\u003eBilling Code\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"billing_country","full_name":"account[billing_country]","description":"\n\u003cp\u003eBilling Country\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"customer_id","full_name":"account[customer_id]","description":"\n\u003cp\u003eCustomer Id for accounting\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"email","full_name":"account[email]","description":"\n\u003cp\u003eE-mail address\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"cp_username","full_name":"account[cp_username]","description":"\n\u003cp\u003eCopyscape Username\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"cp_token","full_name":"account[cp_token]","description":"\n\u003cp\u003eCopyscape Token\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"cp_private_search","full_name":"account[cp_private_search]","description":"\n\u003cp\u003eAllow private search\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"cp_public_search","full_name":"account[cp_public_search]","description":"\n\u003cp\u003eAllow public search\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"cp_writer_upload","full_name":"account[cp_writer_upload]","description":"\n\u003cp\u003eAllow writer to private upload\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"cp_editor_upload","full_name":"account[cp_editor_upload]","description":"\n\u003cp\u003eAllow editor to private upload\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"cp_publisher_upload","full_name":"account[cp_publisher_upload]","description":"\n\u003cp\u003eAllow publisher to private upload\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"discount","full_name":"account[discount]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"balance_limit","full_name":"account[balance_limit]","description":"\n\u003cp\u003eCents\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"is_company","full_name":"account[is_company]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/accounts/create","name":"create","apis":[{"api_url":"/api/users/:user_id/accounts","http_method":"POST","short_description":"Creates User Account","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":422,"description":"Unprocessable Document","metadata":null},{"code":404,"description":"User Not Found","metadata":null}],"params":[{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eUser ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"account","full_name":"account","description":"\n\u003cp\u003eAccount parameter container\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"account[name]","description":"\n\u003cp\u003eAccount Name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"vat_no","full_name":"account[vat_no]","description":"\n\u003cp\u003eVat number\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"crm_id","full_name":"account[crm_id]","description":"\n\u003cp\u003eCRM ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"billing_street","full_name":"account[billing_street]","description":"\n\u003cp\u003eBilling Street\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"billing_city","full_name":"account[billing_city]","description":"\n\u003cp\u003eBilling City\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"billing_province","full_name":"account[billing_province]","description":"\n\u003cp\u003eBilling Province\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"billing_code","full_name":"account[billing_code]","description":"\n\u003cp\u003eBilling Code\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"billing_country","full_name":"account[billing_country]","description":"\n\u003cp\u003eBilling Country\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"customer_id","full_name":"account[customer_id]","description":"\n\u003cp\u003eCustomer Id for accounting\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"email","full_name":"account[email]","description":"\n\u003cp\u003eE-mail address\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"cp_username","full_name":"account[cp_username]","description":"\n\u003cp\u003eCopyscape Username\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"cp_token","full_name":"account[cp_token]","description":"\n\u003cp\u003eCopyscape Token\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"cp_private_search","full_name":"account[cp_private_search]","description":"\n\u003cp\u003eAllow private search\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"cp_public_search","full_name":"account[cp_public_search]","description":"\n\u003cp\u003eAllow public search\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"cp_writer_upload","full_name":"account[cp_writer_upload]","description":"\n\u003cp\u003eAllow writer to private upload\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"cp_editor_upload","full_name":"account[cp_editor_upload]","description":"\n\u003cp\u003eAllow editor to private upload\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"cp_publisher_upload","full_name":"account[cp_publisher_upload]","description":"\n\u003cp\u003eAllow publisher to private upload\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"discount","full_name":"account[discount]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"balance_limit","full_name":"account[balance_limit]","description":"\n\u003cp\u003eCents\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"is_company","full_name":"account[is_company]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/accounts/update","name":"update","apis":[{"api_url":"/api/users/:user_id/accounts/:id","http_method":"PUT","short_description":"Updates User Account","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Account Not Found","metadata":null},{"code":404,"description":"User Not Found","metadata":null},{"code":422,"description":"Unprocessable Document","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eAccount ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eUser ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"account","full_name":"account","description":"\n\u003cp\u003eAccount parameter container\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"account[name]","description":"\n\u003cp\u003eAccount Name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"vat_no","full_name":"account[vat_no]","description":"\n\u003cp\u003eVat number\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"crm_id","full_name":"account[crm_id]","description":"\n\u003cp\u003eCRM ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"billing_street","full_name":"account[billing_street]","description":"\n\u003cp\u003eBilling Street\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"billing_city","full_name":"account[billing_city]","description":"\n\u003cp\u003eBilling City\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"billing_province","full_name":"account[billing_province]","description":"\n\u003cp\u003eBilling Province\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"billing_code","full_name":"account[billing_code]","description":"\n\u003cp\u003eBilling Code\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"billing_country","full_name":"account[billing_country]","description":"\n\u003cp\u003eBilling Country\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"customer_id","full_name":"account[customer_id]","description":"\n\u003cp\u003eCustomer Id for accounting\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"email","full_name":"account[email]","description":"\n\u003cp\u003eE-mail address\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"cp_username","full_name":"account[cp_username]","description":"\n\u003cp\u003eCopyscape Username\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"cp_token","full_name":"account[cp_token]","description":"\n\u003cp\u003eCopyscape Token\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"cp_private_search","full_name":"account[cp_private_search]","description":"\n\u003cp\u003eAllow private search\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"cp_public_search","full_name":"account[cp_public_search]","description":"\n\u003cp\u003eAllow public search\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"cp_writer_upload","full_name":"account[cp_writer_upload]","description":"\n\u003cp\u003eAllow writer to private upload\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"cp_editor_upload","full_name":"account[cp_editor_upload]","description":"\n\u003cp\u003eAllow editor to private upload\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"cp_publisher_upload","full_name":"account[cp_publisher_upload]","description":"\n\u003cp\u003eAllow publisher to private upload\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"discount","full_name":"account[discount]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"balance_limit","full_name":"account[balance_limit]","description":"\n\u003cp\u003eCents\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"is_company","full_name":"account[is_company]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/accounts/destroy","name":"destroy","apis":[{"api_url":"/api/users/:user_id/accounts/:id","http_method":"DELETE","short_description":"Destroys User account","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Account Not Found","metadata":null},{"code":404,"description":"User Not Found","metadata":null},{"code":422,"description":"Unprocessable Document","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eAccount ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eUser ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[]},"badges":{"doc_url":"/docs/1.0/badges","api_url":"","name":"Badges","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/badges/index","name":"index","apis":[{"api_url":"/api/users/:user_id/badges","http_method":"GET","short_description":"List user badges","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"User Not Found","metadata":null}],"params":[{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eUser Id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/badges/show","name":"show","apis":[{"api_url":"/api/users/:user_id/badges/:id","http_method":"GET","short_description":"Returns Badge","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"User Id Not Found","metadata":null},{"code":404,"description":"Payment Method Id Not Found","metadata":null}],"params":[{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eUser id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003ePayment Method Id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/badges/create","name":"create","apis":[{"api_url":"/api/users/:user_id/badges","http_method":"POST","short_description":"Creates Badge","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"User Not Found","metadata":null},{"code":422,"description":"Unprocessable Entity","metadata":null}],"params":[{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eUser Id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"type","description":"\n\u003cp\u003eType of badge\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003eName of badge\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"languages","full_name":"languages","description":"\n\u003cp\u003eLanguages of badge\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription of badge\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/badges/update","name":"update","apis":[{"api_url":"/api/users/:user_id/badges/:id","http_method":"PUT","short_description":"Returns Badge","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"User Id Not Found","metadata":null},{"code":404,"description":"Badge Id Not Found","metadata":null}],"params":[{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eUser id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eBadge Id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"type","description":"\n\u003cp\u003eType of badge\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003eName of badge\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"languages","full_name":"languages","description":"\n\u003cp\u003eLanguages of badge\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription of badge\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/badges/destroy","name":"destroy","apis":[{"api_url":"/api/users/:user_id/badges/:id","http_method":"DELETE","short_description":"Delete Badge","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"User Id Not Found","metadata":null},{"code":404,"description":"Badge Id Not Found","metadata":null}],"params":[{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eUser id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eBadge Id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[]},"offline_payments":{"doc_url":"/docs/1.0/offline_payments","api_url":"","name":"Offline payments","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/offline_payments/create","name":"create","apis":[{"api_url":"/api/users/:user_id/offline_payments","http_method":"POST","short_description":"Creates an offline payment record.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"User Not Found.","metadata":null},{"code":422,"description":"Unprocessable request.","metadata":null}],"params":[{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eUser ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"offline_payment","full_name":"offline_payment","description":"\n\u003cp\u003eOffline payment parameter container\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"amount","full_name":"offline_payment[amount]","description":"\n\u003cp\u003eAmount\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Float","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"currency","full_name":"offline_payment[currency]","description":"\n\u003cp\u003eAmount Currency\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"converted","full_name":"offline_payment[converted]","description":"\n\u003cp\u003ePayment\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Float","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]},{"name":"notes","full_name":"notes","description":"\n\u003cp\u003ePayment Notes\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["POST /api/users/59c241daa83dc1219d4f29ea/offline_payments\n{\n  \"offline_payment\": {}\n}\n401"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/offline_payments/approved_balance","name":"approved_balance","apis":[{"api_url":"/api/users/:id/approved_balance","http_method":"GET","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"User Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eUser’s ID.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/offline_payments/reward_points_action","name":"reward_points_action","apis":[{"api_url":"/api/users/:user_id/offline_payments/reward_points_action","http_method":"POST","short_description":"Add and Deduct reward points","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eUser ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"reward_points","full_name":"reward_points","description":"\n\u003cp\u003eHow many RP will be add or deduct\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"reward_points_action","full_name":"reward_points_action","description":"\n\u003cp\u003eAdd or Deduct\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"note","full_name":"note","description":"\n\u003cp\u003eNote for manual action\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[]},"offline_services":{"doc_url":"/docs/1.0/offline_services","api_url":"","name":"Offline services","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/offline_services/create","name":"create","apis":[{"api_url":"/api/users/:user_id/offline_services","http_method":"POST","short_description":"Creates an offline service.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"User Not Found.","metadata":null},{"code":422,"description":"Unprocessable User document.","metadata":null}],"params":[{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eUser ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"offline_service","full_name":"offline_service","description":"\n\u003cp\u003eOffline service parameter container\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"amount","full_name":"offline_service[amount]","description":"\n\u003cp\u003eAmount\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Float","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"amount_currency","full_name":"offline_service[amount_currency]","description":"\n\u003cp\u003eAmount Currency\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"client_account_id","full_name":"offline_service[client_account_id]","description":"\n\u003cp\u003eAccount ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"notes","full_name":"offline_service[notes]","description":"\n\u003cp\u003ePayment Notes\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"reward_points","full_name":"offline_service[reward_points]","description":"\n\u003cp\u003eReward Points\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"examples":["POST /api/users/59c241f1a83dc1219d4f4617/offline_services\n{\n  \"offline_service\": {}\n}\n401"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[]},"passwords":{"doc_url":"/docs/1.0/passwords","api_url":"","name":"Passwords","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/passwords/create","name":"create","apis":[{"api_url":"/api/users/passwords","http_method":"POST","short_description":"Creates new reset password token","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":422,"description":"Unprocessable User.","metadata":null}],"params":[{"name":"user","full_name":"user","description":"\n\u003cp\u003eUser parameter container\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"login","full_name":"user[login]","description":"\n\u003cp\u003eShould be e-mail or username\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"forgot_type","full_name":"user[forgot_type]","description":"\n\u003cp\u003eShould be password or login\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"examples":["POST /api/users/passwords\n{\n  \"user\": {\n    \"login\": \"test1393@test.com\",\n    \"forgot_type\": \"password\"\n  },\n  \"password\": {\n    \"user\": {\n      \"login\": \"test1393@test.com\",\n      \"forgot_type\": \"password\"\n    }\n  }\n}\n422"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/passwords/renew","name":"renew","apis":[{"api_url":"/api/users/passwords/renew","http_method":"POST","short_description":"Updates user password with reset password token","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":422,"description":"Unprocessable User.","metadata":null}],"params":[{"name":"user","full_name":"user","description":"\n\u003cp\u003eUser parameter container\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"password","full_name":"user[password]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password_confirmation","full_name":"user[password_confirmation]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"reset_password_token","full_name":"user[reset_password_token]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"examples":["POST /api/users/passwords/renew\n{\n  \"user\": {\n    \"password\": \"123456\",\n    \"reset_password_token\": \"7qWNKaNYy1RGKXwLtxnS\"\n  },\n  \"password\": {\n    \"user\": {\n      \"password\": \"123456\",\n      \"reset_password_token\": \"7qWNKaNYy1RGKXwLtxnS\"\n    }\n  }\n}\n422"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[]},"payment_methods":{"doc_url":"/docs/1.0/payment_methods","api_url":"","name":"Payment methods","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/payment_methods/index","name":"index","apis":[{"api_url":"/api/users/:user_id/payment_methods","http_method":"GET","short_description":"List user payment methods","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"User Not Found","metadata":null}],"params":[{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eUser Id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/payment_methods/show","name":"show","apis":[{"api_url":"/api/users/:user_id/payment_methods/:id","http_method":"GET","short_description":"Returns Payment Method","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"User Id Not Found","metadata":null},{"code":404,"description":"Payment Method Id Not Found","metadata":null}],"params":[{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eUser id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003ePayment Method Id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/payment_methods/create","name":"create","apis":[{"api_url":"/api/users/:user_id/payment_methods","http_method":"POST","short_description":"Creates Payment Method","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"User Not Found","metadata":null},{"code":422,"description":"Unprocessable Entity","metadata":null}],"params":[{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eUser Id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"payment_method","full_name":"payment_method","description":"\n\u003cp\u003ePayment Method Parameter Container\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"payment_type","full_name":"payment_method[payment_type]","description":"\n\u003cp\u003ePayment Type\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"country","full_name":"payment_method[country]","description":"\n\u003cp\u003eFoo\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"currency","full_name":"payment_method[currency]","description":"\n\u003cp\u003eCurrency\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"bank_account_id","full_name":"payment_method[bank_account_id]","description":"\n\u003cp\u003ebank_account_id\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"bank_account_purpose","full_name":"payment_method[bank_account_purpose]","description":"\n\u003cp\u003ebank_account_purpose\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"bank_account_relationship","full_name":"payment_method[bank_account_relationship]","description":"\n\u003cp\u003ebank_account_relationship\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"bank_id","full_name":"payment_method[bank_id]","description":"\n\u003cp\u003ebank_id\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"bank_name","full_name":"payment_method[bank_name]","description":"\n\u003cp\u003ebank_name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"branch_address_line_1","full_name":"payment_method[branch_address_line_1]","description":"\n\u003cp\u003ebranch_address_line_1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"branch_address_line_2","full_name":"payment_method[branch_address_line_2]","description":"\n\u003cp\u003ebranch_address_line_2\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"branch_city","full_name":"payment_method[branch_city]","description":"\n\u003cp\u003ebranch_city\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"branch_country","full_name":"payment_method[branch_country]","description":"\n\u003cp\u003ebranch_country\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"branch_postal_code","full_name":"payment_method[branch_postal_code]","description":"\n\u003cp\u003ebranch_postal_code\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"branch_state_province","full_name":"payment_method[branch_state_province]","description":"\n\u003cp\u003ebranch_state_province\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"branch_id","full_name":"payment_method[branch_id]","description":"\n\u003cp\u003ebranch_id\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"branch_name","full_name":"payment_method[branch_name]","description":"\n\u003cp\u003ebranch_name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"wire_instructions","full_name":"payment_method[wire_instructions]","description":"\n\u003cp\u003ewire_instructions\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"intermediary_account_id","full_name":"payment_method[intermediary_account_id]","description":"\n\u003cp\u003eintermediary_account_id\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"intermediary_address_line_1","full_name":"payment_method[intermediary_address_line_1]","description":"\n\u003cp\u003eintermediary_address_line_1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"intermediary_address_line_2","full_name":"payment_method[intermediary_address_line_2]","description":"\n\u003cp\u003eintermediary_address_line_2\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"intermediary_city","full_name":"payment_method[intermediary_city]","description":"\n\u003cp\u003eintermediary_city\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"intermediary_country","full_name":"payment_method[intermediary_country]","description":"\n\u003cp\u003eintermediary_country\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"intermediary_postal_code","full_name":"payment_method[intermediary_postal_code]","description":"\n\u003cp\u003eintermediary_postal_code\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"intermediary_state_province","full_name":"payment_method[intermediary_state_province]","description":"\n\u003cp\u003eintermediary_state_province\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"intermediary_id","full_name":"payment_method[intermediary_id]","description":"\n\u003cp\u003eintermediary_id\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"intermediary_name","full_name":"payment_method[intermediary_name]","description":"\n\u003cp\u003eintermediary_name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/payment_methods/update","name":"update","apis":[{"api_url":"/api/users/:user_id/payment_methods/:id","http_method":"PUT","short_description":"Returns Payment Method","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"User Id Not Found","metadata":null},{"code":404,"description":"Payment Method Id Not Found","metadata":null}],"params":[{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eUser id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003ePayment Method Id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"payment_method","full_name":"payment_method","description":"\n\u003cp\u003ePayment Method Parameter Container\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"payment_type","full_name":"payment_method[payment_type]","description":"\n\u003cp\u003ePayment Type\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"country","full_name":"payment_method[country]","description":"\n\u003cp\u003eFoo\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"currency","full_name":"payment_method[currency]","description":"\n\u003cp\u003eCurrency\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"bank_account_id","full_name":"payment_method[bank_account_id]","description":"\n\u003cp\u003ebank_account_id\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"bank_account_purpose","full_name":"payment_method[bank_account_purpose]","description":"\n\u003cp\u003ebank_account_purpose\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"bank_account_relationship","full_name":"payment_method[bank_account_relationship]","description":"\n\u003cp\u003ebank_account_relationship\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"bank_id","full_name":"payment_method[bank_id]","description":"\n\u003cp\u003ebank_id\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"bank_name","full_name":"payment_method[bank_name]","description":"\n\u003cp\u003ebank_name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"branch_address_line_1","full_name":"payment_method[branch_address_line_1]","description":"\n\u003cp\u003ebranch_address_line_1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"branch_address_line_2","full_name":"payment_method[branch_address_line_2]","description":"\n\u003cp\u003ebranch_address_line_2\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"branch_city","full_name":"payment_method[branch_city]","description":"\n\u003cp\u003ebranch_city\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"branch_country","full_name":"payment_method[branch_country]","description":"\n\u003cp\u003ebranch_country\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"branch_postal_code","full_name":"payment_method[branch_postal_code]","description":"\n\u003cp\u003ebranch_postal_code\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"branch_state_province","full_name":"payment_method[branch_state_province]","description":"\n\u003cp\u003ebranch_state_province\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"branch_id","full_name":"payment_method[branch_id]","description":"\n\u003cp\u003ebranch_id\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"branch_name","full_name":"payment_method[branch_name]","description":"\n\u003cp\u003ebranch_name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"wire_instructions","full_name":"payment_method[wire_instructions]","description":"\n\u003cp\u003ewire_instructions\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"intermediary_account_id","full_name":"payment_method[intermediary_account_id]","description":"\n\u003cp\u003eintermediary_account_id\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"intermediary_address_line_1","full_name":"payment_method[intermediary_address_line_1]","description":"\n\u003cp\u003eintermediary_address_line_1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"intermediary_address_line_2","full_name":"payment_method[intermediary_address_line_2]","description":"\n\u003cp\u003eintermediary_address_line_2\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"intermediary_city","full_name":"payment_method[intermediary_city]","description":"\n\u003cp\u003eintermediary_city\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"intermediary_country","full_name":"payment_method[intermediary_country]","description":"\n\u003cp\u003eintermediary_country\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"intermediary_postal_code","full_name":"payment_method[intermediary_postal_code]","description":"\n\u003cp\u003eintermediary_postal_code\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"intermediary_state_province","full_name":"payment_method[intermediary_state_province]","description":"\n\u003cp\u003eintermediary_state_province\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"intermediary_id","full_name":"payment_method[intermediary_id]","description":"\n\u003cp\u003eintermediary_id\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"intermediary_name","full_name":"payment_method[intermediary_name]","description":"\n\u003cp\u003eintermediary_name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/payment_methods/toggle","name":"toggle","apis":[{"api_url":"/api/users/:user_id/payment_methods/:id/toggle","http_method":"PATCH","short_description":"Toggles pm_approval","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"User Id Not Found","metadata":null},{"code":404,"description":"Payment Method Id Not Found","metadata":null}],"params":[{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eUser id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003ePayment Method Id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/payment_methods/destroy","name":"destroy","apis":[{"api_url":"/api/users/:user_id/payment_methods/:id","http_method":"DELETE","short_description":"Delete Payment Method","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"User Id Not Found","metadata":null},{"code":404,"description":"Payment Method Id Not Found","metadata":null}],"params":[{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eUser id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003ePayment Method Id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/payment_methods/required_fields","name":"required_fields","apis":[{"api_url":"/api/users/:user_id/payment_methods/required_fields","http_method":"GET","short_description":"Returns Required Fields","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"User Id Not Found","metadata":null},{"code":422,"description":"Unprocessable Entity","metadata":null}],"params":[{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eUser id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"payment_type","full_name":"payment_type","description":"\n\u003cp\u003ePayment Method Type\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"currency","full_name":"currency","description":"\n\u003cp\u003eCurrency\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[]},"preferences":{"doc_url":"/docs/1.0/preferences","api_url":"","name":"Preferences","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/preferences/index","name":"index","apis":[{"api_url":"/api/users/:user_id/preferences","http_method":"GET","short_description":"Lists user preferences","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"User Not Found.","metadata":null}],"params":[{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eUser ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["GET /api/users/59c241f6a83dc1219d4f4a9f/preferences\n401"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/preferences/update","name":"update","apis":[{"api_url":"/api/users/:user_id/preferences/:id","http_method":"PUT","short_description":"Update user preference","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"User Not Found.","metadata":null},{"code":404,"description":"Preference Not Found","metadata":null},{"code":422,"description":"Unprocessable UserPreference.","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003ePreference ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eUser Id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_preference","full_name":"user_preference","description":"\n\u003cp\u003eUserPreference parameter container\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"value","full_name":"user_preference[value]","description":"\n\u003cp\u003ePreference value\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"examples":["PUT /api/users/59c241f6a83dc1219d4f4b84/preferences/59c241f6a83dc1219d4f4b86\n{\n  \"preference\": {}\n}\n403"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[]},"transactions":{"doc_url":"/docs/1.0/transactions","api_url":"","name":"Transactions","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/transactions/index","name":"index","apis":[{"api_url":"/api/users/:user_id/transactions","http_method":"GET","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"User Not Found","metadata":null}],"params":[{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eUser’s ID.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["GET /api/users/59c241f5a83dc1219d4f4a88/transactions\n200"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[]},"works":{"doc_url":"/docs/1.0/works","api_url":"","name":"Works","short_description":null,"full_description":null,"version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/docs/1.0/works/index","name":"index","apis":[{"api_url":"/api/users/:user_id/works","http_method":"GET","short_description":"Lists user works","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"user_id","full_name":"user_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eFor pagination. Default is 10.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003eFor pagination. Page number\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"term","full_name":"term","description":"\n\u003cp\u003eProject Name or focus keyword to be filtered\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order_by","full_name":"order_by","description":"\n\u003cp\u003eOrder by field\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/works/history","name":"history","apis":[{"api_url":"/api/users/:user_id/works/:id/history","http_method":"GET","short_description":"Shows history of work.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"user_id","full_name":"user_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/works/text_difference","name":"text_difference","apis":[{"api_url":"/api/users/works/text_difference","http_method":"GET","short_description":"Calculates text difference.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"text1","full_name":"text1","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"text2","full_name":"text2","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null},"users":{"doc_url":"/docs/1.0/users","api_url":"","name":"Users","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/users/me","name":"me","apis":[{"api_url":"/api/me","http_method":"GET","short_description":"Returns the details of current user.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[],"examples":["GET /api/me\n200"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/users/index","name":"index","apis":[{"api_url":"/api/users","http_method":"GET","short_description":"Lists users.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"q","full_name":"q","description":"\n\u003cp\u003eKeyword to be searched\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/users/show","name":"show","apis":[{"api_url":"/api/users/:id","http_method":"GET","short_description":"Shows the given user details.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"User Not Found.","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eUser ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/users/update","name":"update","apis":[{"api_url":"/api/users/:id","http_method":"PUT","short_description":"Updates current user.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"User Not Found.","metadata":null},{"code":422,"description":"Unprocessable User.","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eUser ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user","full_name":"user","description":"\n\u003cp\u003eUser parameter container\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"first_name","full_name":"user[first_name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"middle_name","full_name":"user[middle_name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"last_name","full_name":"user[last_name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"languages","full_name":"user[languages]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"gender","full_name":"user[gender]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"categories","full_name":"user[categories]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"education_level","full_name":"user[education_level]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"freelancer_type","full_name":"user[freelancer_type]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"birth_date","full_name":"user[birth_date]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"customer","full_name":"user[customer]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"is_survey_subscribe","full_name":"user[is_survey_subscribe]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"zip_code","full_name":"user[zip_code]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"country","full_name":"user[country]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"has_intro_task","full_name":"user[has_intro_task]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"examples":["PUT /api/users/59c241d7a83dc1219d4f299b\n{\n  \"user\": {}\n}\n401"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/users/update_password","name":"update_password","apis":[{"api_url":"/api/users/:id/update_password","http_method":"PATCH","short_description":"Updates user password","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"User not found","metadata":null},{"code":422,"description":"Unprocessable User","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eUser ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user","full_name":"user","description":"\n\u003cp\u003eUser parameter container\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"current_password","full_name":"user[current_password]","description":"\n\u003cp\u003eUser’s current password.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"user[password]","description":"\n\u003cp\u003eUser’s new password\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password_confirmation","full_name":"user[password_confirmation]","description":"\n\u003cp\u003eThe confirmation of new password\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"examples":["PATCH /api/users/59c241d6a83dc1219d4f2989/update_password\n{\n  \"user\": {}\n}\n401"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/users/accept_tnc","name":"accept_tnc","apis":[{"api_url":"/api/users/:id/accept_tnc","http_method":"PATCH","short_description":"Accepts Terms \u0026 Conditions","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"User not found","metadata":null},{"code":422,"description":"Unprocessable User","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eUser Id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/users/update_email","name":"update_email","apis":[{"api_url":"/api/users/:id/update_email","http_method":"PATCH","short_description":"Updates user e-mail. This requires current password of user.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"User not found","metadata":null},{"code":422,"description":"Unprocessable User","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eUser ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user","full_name":"user","description":"\n\u003cp\u003eUser parameter container\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"email","full_name":"user[email]","description":"\n\u003cp\u003eE-mail to be changed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"current_password","full_name":"user[current_password]","description":"\n\u003cp\u003eUser’s current password\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"examples":["PATCH /api/users/59c241d5a83dc1219d4f294a/update_email\n{\n  \"user\": {}\n}\n401"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/users/send_confirmation_instructions","name":"send_confirmation_instructions","apis":[{"api_url":"/api/users/:id/send_confirmation_instructions","http_method":"POST","short_description":"Send confirmation instructions","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"User Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eUser ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["POST /api/users/59c241d6a83dc1219d4f297d/send_confirmation_instructions\n{\n  \"user\": {}\n}\n401"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/users/check_email","name":"check_email","apis":[{"api_url":"/api/users/check_email","http_method":"POST","short_description":"Checks whether an e-mail exists or not","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":422,"description":"Unprocessable User","metadata":null}],"params":[{"name":"email","full_name":"email","description":"\n\u003cp\u003eEmail to be searched\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["POST /api/users/check_email\n{\n  \"email\": \"test@test.com\"\n}\n204"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/users/check_username","name":"check_username","apis":[{"api_url":"/api/users/check_username","http_method":"POST","short_description":"Checks whether a username exists or not","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":422,"description":"Unprocessable User","metadata":null}],"params":[{"name":"username","full_name":"username","description":"\n\u003cp\u003eUsername to be searched\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/users/approved_balances","name":"approved_balances","apis":[{"api_url":"/api/users/approved_balances","http_method":"GET","short_description":"Download approved balances in given format","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/users/upload_approved_balances","name":"upload_approved_balances","apis":[{"api_url":"/api/users/upload_approved_balances","http_method":"POST","short_description":"Bulk upload for approved balances in Euro.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[],"examples":["POST /api/users/upload_approved_balances\n{\n  \"file\": \"\u003cFILE CONTENT 'approved_balances.tsv'\u003e\"\n}\n403"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/users/confirm_account","name":"confirm_account","apis":[{"api_url":"/api/users/confirm_account","http_method":"POST","short_description":"Confirms user account with confirmation token","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":422,"description":"Invalid confirmation token","metadata":null}],"params":[{"name":"confirmation_token","full_name":"confirmation_token","description":"\n\u003cp\u003eConfirmation Token\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["POST /api/users/confirm_account\n{\n  \"confirmation_token\": null,\n  \"user\": {\n    \"confirmation_token\": null\n  }\n}\n204"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/users/authorized_applications","name":"authorized_applications","apis":[{"api_url":"/api/users/:id/authorized_applications","http_method":"GET","short_description":"List current users's authorized applications.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"User Not Found.","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eUser ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/users/revoke_application","name":"revoke_application","apis":[{"api_url":"/api/users/:id/authorized_applications","http_method":"DELETE","short_description":"Revoke current users's authorized application.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"User Not Found.","metadata":null},{"code":404,"description":"Application Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eUser ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"application_id","full_name":"application_id","description":"\n\u003cp\u003eApplication ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/users/scores","name":"scores","apis":[{"api_url":"/api/users/:id/scores","http_method":"GET","short_description":"Shows the given user's scores.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"User Not Found.","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eUser ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["GET /api/users/59c24193a83dc1219d4eeafe/scores\n200"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/users/quality_score_graph","name":"quality_score_graph","apis":[{"api_url":"/api/users/:id/quality_score_graph","http_method":"GET","short_description":"Returns quality score time series to draw graph.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"User Not Found.","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eUser Id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/users/quality_score_details","name":"quality_score_details","apis":[{"api_url":"/api/users/:id/quality_score_details","http_method":"GET","short_description":"Returns quality score time series to draw graph.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"User Not Found.","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eUser Id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"language","full_name":"language","description":"\n\u003cp\u003eDate in the format of YYYY-MM-DD\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"score_date","full_name":"score_date","description":"\n\u003cp\u003eDate in the format of YYYY-MM-DD\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/users/statistics","name":"statistics","apis":[{"api_url":"/api/users/:id/statistics","http_method":"GET","short_description":"Shows the given user statistics.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"User Not Found.","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eUser ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"daily_activity_counts","full_name":"daily_activity_counts","description":"\n\u003cp\u003edaily_activity_counts=all if statistics needed\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"daily_activity_seconds","full_name":"daily_activity_seconds","description":"\n\u003cp\u003edaily_activity_seconds=all if statistics needed\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"daily_hourly_rates","full_name":"daily_hourly_rates","description":"\n\u003cp\u003edaily_hourly_rates=all if statistics needed\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"activities","full_name":"activities","description":"\n\u003cp\u003eactivities=all if statistics needed\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"levels","full_name":"levels","description":"\n\u003cp\u003elevels=all if statistics needed\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/users/user_signup_statistics","name":"user_signup_statistics","apis":[{"api_url":"/api/users/user_signup_statistics","http_method":"GET","short_description":"Returns new user count though given date range","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"first_date","full_name":"first_date","description":"\n\u003cp\u003eFirst date\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"last_date","full_name":"last_date","description":"\n\u003cp\u003eSecond date\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/users/daily_active_users","name":"daily_active_users","apis":[{"api_url":"/api/users/daily_active_users","http_method":"GET","short_description":"Returns daily active users in give range","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"first_date","full_name":"first_date","description":"\n\u003cp\u003eFirst date\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"last_date","full_name":"last_date","description":"\n\u003cp\u003eLast date\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/users/free_sample_statistics","name":"free_sample_statistics","apis":[{"api_url":"/api/users/free_sample_statistics","http_method":"GET","short_description":"Get free sample statistics","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"first_date","full_name":"first_date","description":"\n\u003cp\u003eFirst date of query\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a DateTime","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"last_date","full_name":"last_date","description":"\n\u003cp\u003eLast date of query\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a DateTime","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"type","description":"\n\u003cp\u003eStorage type\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/users/language_levels_statistics","name":"language_levels_statistics","apis":[{"api_url":"/api/users/language_levels_statistics","http_method":"GET","short_description":"Get lang level stat on daily basis","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"first_date","full_name":"first_date","description":"\n\u003cp\u003eFirst date of query\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a DateTime","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"last_date","full_name":"last_date","description":"\n\u003cp\u003eLast date of query\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a DateTime","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"language","full_name":"language","description":"\n\u003cp\u003eAsk a language to retrieve results\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/users/update_reward_points","name":"update_reward_points","apis":[{"api_url":"/api/users/:id/update_reward_points","http_method":"PATCH","short_description":"Update reward points of user","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"User Not Found.","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eUser Id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/users/pending_rp","name":"pending_rp","apis":[{"api_url":"/api/users/:id/pending_rp","http_method":"GET","short_description":"Get pending reward points of the current user","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"User Not Found.","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eUser Id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/users/transfer_reward_points","name":"transfer_reward_points","apis":[{"api_url":"/api/users/:id/transfer_reward_points","http_method":"POST","short_description":"Transfer reward points to another user","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"User Not Found.","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eUser Id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"to_user_id","full_name":"to_user_id","description":"\n\u003cp\u003eTo User Id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"count","full_name":"count","description":"\n\u003cp\u003eCount of reward points\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"note","full_name":"note","description":"\n\u003cp\u003eNote\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[]},"website_filters":{"doc_url":"/docs/1.0/website_filters","api_url":"","name":"Website filters","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/website_filters/index","name":"index","apis":[{"api_url":"/api/website_filters","http_method":"GET","short_description":"Lists filters.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eFilters listing for given user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/website_filters/show","name":"show","apis":[{"api_url":"/api/website_filters/:id","http_method":"GET","short_description":"Shows website filter.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eWebsite Filter ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/website_filters/update","name":"update","apis":[{"api_url":"/api/website_filters/:id","http_method":"PUT","short_description":"Update filter","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Filter Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eFilter ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003eName of filter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"filter","full_name":"filter","description":"\n\u003cp\u003eFilter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"is_shared_with_account","full_name":"is_shared_with_account","description":"\n\u003cp\u003eTrue or false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/website_filters/create","name":"create","apis":[{"api_url":"/api/website_filters","http_method":"POST","short_description":"Creates new domain.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Filter Not Found.","metadata":null}],"params":[{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eUser Id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003eName of filter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"filter","full_name":"filter","description":"\n\u003cp\u003eFilter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"is_shared_with_account","full_name":"is_shared_with_account","description":"\n\u003cp\u003eTrue or false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/website_filters/destroy","name":"destroy","apis":[{"api_url":"/api/website_filters/:id","http_method":"DELETE","short_description":"Delete filter","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Filter Not Found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eFilter ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[]},"withdraw":{"doc_url":"/docs/1.0/withdraw","api_url":"","name":"Withdraw","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/withdraw/create","name":"create","apis":[{"api_url":"/api/withdraw","http_method":"POST","short_description":"Hits for withdraw","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"User Not Found","metadata":null}],"params":[{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eUser id\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"payment_type","full_name":"payment_type","description":"\n\u003cp\u003eTypeof of payment\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ePAYPAL\u003c/code\u003e, \u003ccode\u003eBANK_ACCOUNT\u003c/code\u003e, \u003ccode\u003eWIRE_ACCOUNT\u003c/code\u003e, \u003ccode\u003ePAYPAL_ACCOUNT\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"amount_cents","full_name":"amount_cents","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/withdraw/transaction_fees","name":"transaction_fees","apis":[{"api_url":"/api/withdraw/transaction_fees","http_method":"GET","short_description":"Returns transaction fees","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"User Not Found","metadata":null}],"params":[{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eUser id\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/withdraw/totals","name":"totals","apis":[{"api_url":"/api/withdraw/totals","http_method":"GET","short_description":"Returns pending / withdrawable / requested / hyper_wallet totals","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/withdraw/recently_approved","name":"recently_approved","apis":[{"api_url":"/api/withdraw/recently_approved","http_method":"GET","short_description":"Returns recently approved requests (last 1 hour)","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null}],"params":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/withdraw/transfer","name":"transfer","apis":[{"api_url":"/api/withdraw/transfer","http_method":"POST","short_description":"Transfer money from freelancer account to business account","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"User Not Found","metadata":null}],"params":[{"name":"account_id","full_name":"account_id","description":"\n\u003cp\u003eBusiness account ID to transfer money\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"notes","full_name":"notes","description":"\n\u003cp\u003eTransfer notes\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[]}}}}