类型api的python客户端包装器
typeform的Python项目详细描述
字体
目录
安装
pip install typeform
用法
初始化
1-导入客户端库
fromtypeformimportTypeform
2-使用您的个人令牌创建一个实例
typeform=Typeform('<api_key>')
3-使用reference中提供的任何方法
# will retrieve all formsforms:dict=typeform.forms.list()
参考
Typeform('<api_key>')
- 创建typeform的python客户端的新实例
- 返回具有以下方法的实例
typeform=Typeform('<api_key>')
客户端返回以下属性：
formsresponses
它们中的每一个都封装了与之相关的操作（比如列出、更新、删除资源）。
表格
forms.create(data: dict = {})
创建窗体。返回已创建窗体的dict。See docs。
forms=Typeform('<api_key>').formsresult:dict=forms.create({'title':'Hello World'})
forms.delete(uid: str)
删除具有给定窗体ID的窗体和窗体的所有响应。基于删除成功返回str，成功返回OK，否则返回错误消息。See docs。
forms=Typeform('<api_key>').formsresult:str=forms.delete('abc123')
forms.get(uid: str)
按给定的窗体ID检索窗体。包括作为引用附加到窗体的任何主题和图像。See docs。
forms=Typeform('<api_key>').formsresult:dict=forms.get('abc123')
forms.list(page: int = None, pageSize: int = None, search: str = None, workspaceId: str = None)
检索typeform帐户（public和private）中所有表单的json描述列表。表格按照最后修改日期的倒序排列。See docs。
forms=Typeform('<api_key>').formsresult:dict=forms.list()
forms.update(uid: str, patch: bool = False, data: dict = {})
更新现有的窗体。默认为put。put将以dict对象的形式返回修改后的表单。patch将根据更改成功返回str，成功返回OK，否则返回错误消息。See ^{
forms=Typeform('<api_key>').formsresult:dict=forms.update('abc123',{'title':'Hello World, Again'})result:str=forms.update('abc123',{'title':'Hello World, Again'},patch=True)
forms.messages.get(uid: str)
使用表单的指定语言检索表单（由表单id指定）的可自定义消息。您可以使用粗体（bold）和斜体（italic）文本格式化消息。禁止使用HTML标记。See docs。
forms=Typeform('<api_key>').formsresult:dict=forms.messages.get('abc123')
forms.messages.update(uid: str, data={})
为窗体中的可自定义消息指定新值（由窗体ID指定）。您可以使用粗体（bold）和斜体（italic）文本格式化消息。禁止使用HTML标记。根据更改成功返回str，成功返回OK，否则返回错误消息。See docs。
forms=Typeform('<api_key>').formsresult:str=forms.messages.update('abc123',{'label.buttonHint.default':'New Button Hint'})
反应
responses.list(uid: str, pageSize: int = None, since: str = None, until: str = None, after: str = None, before: str = None, includedResponseIds: str = None, completed: bool = None, sort: str = None, query: str = None, fields: List[str] = None)
返回表单响应以及表单登录和提交的日期和时间。See docs。
responses=Typeform('<api_key>').responsesresult:dict=responses.list('abc123')
responses.delete(uid: str, includedTokens: Union[str, List[str]])
删除对表单的响应。必须指定included_tokens参数。基于删除成功返回str，成功返回OK，否则返回错误消息。See docs。
responses=Typeform('<api_key>').responsesresult:str=responses.delete('abc123''token1')result:str=responses.delete('abc123'['token2','token3'])
欢迎加入QQ群-->： 979659372
