It looks like the API endpoint have evolved and the library is not compatible anymore.

https://developer.typeform.com/responses/reference/retrieve-responses

import typeform
form = typeform.Form(api_key='*********', form_id='***')
responses = form.get_responses()
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "C:\Python34\lib\site-packages\typeform\form.py", line 62, in get_responses
    return FormResponses(stats=resp.get('stats'), responses=resp.get('responses'), questions=resp.get('questions'))
  File "C:\Python34\lib\site-packages\typeform\form_response.py", line 81, in __init__
    FormQuestion(**question) for question in questions
  File "C:\Python34\lib\site-packages\typeform\form_response.py", line 81, in <listcomp>
    FormQuestion(**question) for question in questions
TypeError: __init__() got an unexpected keyword argument 'group'

I keep getting this error. I tried installing using pip as well as installing from source.

Any chance we can add the webhooks API into this SDK as well? Seems like it'd follow the same structure as the others.

Hi Michael,

Thanks for the package it's great. I'm super new to development and I'm trying to create a tool that generates some forms automatically. Specifically, I need to add images to these forms.
I don't see any support to the images endpoint in your package. Do you plan to build it some time?
Otherwise, I may just give it a shot and send it to you for review when it's done. I've just forked the repo and will start working on it.

Thanks in advance

The current test suite deletes all your forms in your account.

Double-check everything runs on mock servers.

Are we interested in a method which pulls responses in the format below.

{
 'question name':'answer'
}

This seems a lot easier for developing with the typeform responses in the backend.

Came across with the project accidentally (actually use TypeForm API in production (but my own implementation)).
After reading the code, I decided that it should be refactored a little, as I noticed many cases that, in my opinion, need to be rewritten:

• functions in utils seem to me pretty strange and even a little redundant (e.g. mergeDict: since starting with python 3.9 it's enought to use "|" for dicts union), naming of the functions etc.
• PEP-8 violations: naming of variables (it is preferable to use lower case with underscores), max line length, docstrings, etc
• There are unused constants in constants.py. And actually it seems like it's better to name it settings.py instead.
• string formatting. Much more readable (IMHO) use f-strings there (since python 3.6)

actually already have a commit with all these changes: 7910ba4
So I can make a PR

Hi,

I have been using this python since a few months without any problem. But since last 2 days its not being able to collect new data.

Couldn't find how to get the responses, so I've added get_responses function to class Forms

The code reads like this:

 def get_responses(self, uid: str) -> dict:
        """Retrieves the results"""
        return self.__client.request('get', '/forms/%s/responses' % uid)

Problem is, this does not deal with pagination and will not work with more than 25 answers according to the documentation.

Invalid payload error when I try to create a new Typeform.

Expected Behavior

A new form on Typeform should be created.

Current Behavior

No form is created because of an issue I can't fix.

Steps to Reproduce

1. Copy and paste the code down below in any IDE.
2. Run the code.
3. See the error.

Context (Environment)

I've been trying to solve this by myself for hours but I can't find a way to fix this.
This issue is the only problem I have to accomplish my work : I am trying to make a Python application to create a form using the data (questions) in an Excel file.

my_typeform = typeform.Typeform(getpass('Token (text will be hidden): '))

# Create a new form
my_typeform.forms.create({
    'type': 'quiz',
    'title': 'My typeform',
    'fields': [
        {
            'title': 'Nice to meet you, how is your day going?',
            'properties': {
                'randomize': False,
                'allow_multiple_selection': False,
                'allow_other_choice': False,
                'vertical_alignment': True,
                'choices': [
                    {'label': 'Terrific!'},
                    {'label': 'Not so well...'}
                ]
            }
        }
    ]
})

Following the docs, I can't get the following to work:

forms = Typeform('<api_key>').forms

result: str = forms.update('abc123', { 'title': 'Hello World, Again' }, patch=True)

I get a 'The payload is invalid.' error telling me it should be an array in body.

Without setting patch to true I did get a successful update.

Description:

When providing an incorect request body, the error messge is not descriptive enough.

Example:

from typeform import Typeform

r = Typeform("XXXXXXXX").forms.create(data={
    "title": "Incorrect form payload",
    "type": "quiz",
    "theme": https://api.typeform.com/themes/GKFi5U"
})

Raises the following exception:

...
File ~/Projects/coef/typeform-python-sdk/typeform/client.py:41, in Client.__validator(self, result)
     39 if type(body) is dict and body.get('code', None) is not None:
     40     print(body)
---> 41     raise Exception(body.get('description'))
     42 elif result.status_code >= 400:
     43     raise Exception(result.reason)

Exception: The payload is invalid.

If you are to intercept the HTTP response, you will receive a much more verbose error message:

{
    "code": "VALIDATION_ERROR",
    "description": "The payload is invalid.",
    "details": [
        {
            "code": "WRONG_TYPE",
            "description": "should be object,null",
            "field": "/theme",
            "in": "body"
        }
    ]
}

Motivation for or Use Case:

I'd like to handle errors better and understand where the issue is

Related Issues - has a similar issue been reported before?:

#16 Invalid payload error when creating a new Typeform

Environment Configuration:

Latest revision at: ccfe1ec

Suggest a Fix:

# in typeform/client.py L39:
if type(body) is dict and body.get('code', None) is not None:
            print(f"Error code: {body.get('code')}")
            print(f"Error details: {body.get('details')}")
            raise Exception(body.get('description'))

Hi Team, hopefully this is right place to ask, if not, I'd appreciate if you can direct me.

I'm the founder of cloudquery.io, a high performance open source ELT framework.

Our users are interested in a Typeform plugin, but as we cannot maintain all the plugins ourselves, I was curious if this would be an interesting collaboration, where we would help implement an initial source plugin, and you will help maintain it.

This will give your users the ability to sync Typeform data to any of their datalakes/data-warehouses/databases easily using any of the growing list of CQ destination plugins.

Best,
Yevgeny

Hi, when I'm constructing the oauth link:

https://api.typeform.com/oauth/authorize?client_id={your_client_id}&redirect_uri=https://results-example.herokuapp.com/callback&scope={scope1}+{scope2}+{scope3}

like this, how can I send user_id above so that I receive the same user_id in the callback request? I have a condition where I want to associate typeform data with the users data I have in my db.

Hello, I've been able to play around with the data using the query methods but I was wondering how one might go updating question fields using orms_object.update(i.id, {"fields": payload},patch=True), I keep getting payload errors and I'm not sure how to generate correct new ids for each response option.

The documentation mentions an excluded_response_id field but the param doesn't seem to be available. In fact it's not showing here.

My use case is to retrieve only the responses that I have not seen yet (aka new responses) and this flag makes perfect sense.

The response I get back is

TypeError: list() got an unexpected keyword argument 'excludedResponseIds'