Package: helpscout-wrapper
Help Scout API WrapperThis package provide wrapper for Help Scout API 2.0. It gives access to all mailbox endpoints.InstalationYou can install it from pypi:pip install helpscout-wrapperAuthenticationTo use API you need to create app and getapp_idandapp_secret.
InstructionshereUsageAll endpoint commands and coresponding parameters you can find indocumentationConversationsAPI EndpointWrapper commandList conversationclient.conversation.list(kwargs)Get conversationclient.conversation.get(conv_id, kwargs)Create conversationclient.conversation.create(kwargs)Update conversationclient.conversation.update(conv_id, op, path, value)Delete conversationclient.conversation.delete(conv_id)Get attachemnt dataclient.conversation.attachment.get(conv_id, attach_id)Upload attachmentclient.conversation.attachment.upload(conv_id, thread_id, file_name, mime_type, data)Delete attachmentclient.conversation.attachment.delete(conv_id, attach_id)Update custom fieldsclient.conversation.custom_field.update(conv_id, fields)Update tagsclient.conversation.tag.update(conv_id, tags)List threadsclient.conversation.thread.list(conv_id)Update threadclient.conversation.thread.update(conv_id, thread_id, op, path, value)Create reply threadclient.conversation.thread.create_reply_thread(conv_id, kwargs)Create phone threadclient.conversation.thread.create_phone_thread(conv_id, kwargs)Create noteclient.conversation.thread.create_note(conv_id, kwargs)Create customer threadclient.conversation.thread.create_customer_thread(conv_id, kwargs)Create chat threadclient.conversation.thread.create_chat_thread(conv_id, kwargs)CustomersAPI EndpointWrapper commandList customersclient.customer.list(kwargs)Get customerclient.customer.get(cust_id, kwargs)Create customerclient.customer.create(first_name, kwargs)Update customersclient.customer.update(cust_id, first_name, kwargs)Get addressclient.customer.address.get(cust_id)Create addressclient.customer.address.create(cust_id, city, state, postal_code, country, lines)Update addressclient.customer.address.update(cust_id, city, state, postal_code, country, lines)Delete addressclient.customer.address.delete(cust_id)List chat handlerclient.customer.chat_handler.list(cust_id)Create chat handlerclient.customer.chat_handler.create(cust_id, type_, value)Update chat handlerclient.customer.chat_handler.update(cust_id, chat_id, type_, value)Delete chat handlerclient.customer.chat_handler.delete(cust_id, chat_id)List emailclient.customer.email.list(cust_id)Create emailclient.customer.email.create(cust_id, type_, value)Update emailclient.customer.email.update(cust_id, email_id, type_, value)Delete emailclient.customer.email.delete(cust_id, email_id)List phoneclient.customer.phone.list(cust_id)Create phoneclient.customer.phone.create(cust_id, type_, value)Update phoneclient.customer.phone.update(cust_id, phone_id, type_, value)Delete phoneclient.customer.phone.delete(cust_id, phone_id)List social profileclient.customer.social_profile.list(cust_id)Create social profileclient.customer.social_profile.create(cust_id, type_, value)Update social profileclient.customer.social_profile.update(cust_id, profile_id, type_, value)Delete social profileclient.customer.social_profile.delete(cust_id, profile_id)List websiteclient.customer.website.list(cust_id)Create websiteclient.customer.website.create(cust_id, type_, value)Update websiteclient.customer.website.update(cust_id, website_id, type_, value)Delete websiteclient.customer.website.delete(cust_id, website_id)MailboxesAPI EndpointWrapper commandList mailboxesclient.mailbox.list()Get mailboxclient.mailbox.get(mailbox_id)List mailbox custom fieldsclient.mailbox.mailbox_fields(mailbox_id)List mailbox foldersclient.mailbox.mailbox_folders(mailbox_id)ReportsAPI EndpointWrapper commandChat reportclient.report.chat_report(start, end, kwargs)Email reportclient.report.email_report(start, end, kwargs)Phone reportclient.report.phone_report(start, end, kwargs)Company overall reportclient.report.company.overall_report(start, end, kwargs)Company customers helpedclient.report.company.customers_helped(start, end, kwargs)Company drilldownclient.report.company.drilldown(start, end, range_, kwargs)Conversation overall reportclient.report.conversation.overall_report(start, end, kwargs)Conversation volumes by channelclient.report.conversation.volumes_by_channel(start, end, kwargs)Conversation busiest time of dayclient.report.conversation.busiest_time_of_day(start, end, kwargs)Conversation drilldownclient.report.conversation.drilldown(start, end, range_, kwargs)Conversation drilldown by fieldclient.report.conversation.drilldown_by_field(start, end, field, fieldid, kwargs)Conversation new drilldownclient.report.conversation.new(start, end, kwargs)Conversation received messages statisticsclient.report.conversation.received_messages(start, end, kwargs)Doc overall reportclient.report.doc.overall_report(start, end, kwargs)Happiness overall reportclient.report.happiness.overall_report(start, end, kwargs)Happiness ratings reportclient.report.happiness.ratings(start, end, kwargs)Productivity overall reportclient.report.productivity.overall_report(start, end, kwargs)Productivity first response timeclient.report.productivity.first_response_time(start, end, kwargs)Productivity replies sentclient.report.productivity.replies_sent(start, end, kwargs)Productivity resolution timeclient.report.productivity.resolution_time(start, end, kwargs)Productivity resolvedclient.report.productivity.resolved(start, end, kwargs)Productivity response timeclient.report.productivity.response_time(start, end, kwargs)User overall reportclient.report.user.overall_report(user, start, end, kwargs)User conversation historyclient.report.user.conversation_history(user, start, end, kwargs)User customers helpedclient.report.user.customers_helped(user, start, end, kwargs)User drilldownclient.report.user.drilldown(user, start, end, kwargs)User happinessclient.report.user.happiness(user, start, end, kwargs)User happiness drilldownclient.report.user.happiness_drilldown(user, start, end, kwargs)User repliesclient.report.user.replies(user, start, end, kwargs)User resolutionclient.report.user.resolution(user, start, end, kwargs)TagsAPI EndpointWrapper commandList tagsclient.tag.list(kwargs)TeamsAPI EndpointWrapper commandList teamsclient.team.list(kwargs)List team membersclient.team.members(team_id, kwargs)TagsAPI EndpointWrapper commandList tagsclient.tag.list(kwargs)TagsAPI EndpointWrapper commandList usersclient.user.list(kwargs)Get userclient.user.user(user_id)Get resource ownerclient.user.resource_owner()WebhookAPI EndpointWrapper commandList webhooksclient.webhook.list()Get webhookclient.webhook.get(webhook_id)Create webhookclient.webhook.create(url, events, secret, notification)Update webhookclient.webhook.update(webhook_id, url, events, secret, notification)Delete webhookclient.webhook.delete(webhook_id)WorkflowAPI EndpointWrapper commandList workflowsclient.workflow.list(kwargs)Update workflow statusclient.workflow.update_status(workflow_id, op, value, path)Run manual workflowclient.workflow.run_manual(workflow_id, conversation_ids)ExamplesList all conversations>>>fromhelpscoutimportClient>>>client=Client('<YOUR_APP_ID>','<YOUR_APP_SECRET>')>>>client.conversation.list(){"_embedded":{"conversations":[{"id":10,"number":12,"threads":2,"type":"email","folderId":11,"status":"closed","state":"published","subject":"Help","preview":"Preview","mailboxId":13,...