Skip to content

Commit e193388

Browse files
authored
Update README.md
1 parent 980ae90 commit e193388

1 file changed

Lines changed: 49 additions & 6 deletions

File tree

README.md

Lines changed: 49 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,52 @@ pip install git+git://github.com/GearPlug/typeform-python.git
1010
- requests
1111

1212

13-
## EndPoints
14-
- base: The base endpoint response contains information about the API. It is useful for testing or making sure you have access.
15-
- forms: The form endpoint is the main endpoint that you will be dealing with. It is the endpoint you use to create new typeforms. You have parameters to set the title, webhook URL and of course, the fields. The form endpoint will also return you a hash of URLs that you can use to distribute your typeform or delete it.
16-
- images: Due to existing constraints, we cannot process all images on the fly when creating typeforms containing the 'Picture Choice' question type. Therefore, we provide an endpoint for creating images for Picture Choices before creating your typeform.
17-
- designs: A design is what you see when you load your typeform. It contains information that is related to the styling of your typeform.
18-
- urls: The url endpoint creates a new URL linking to a typeform.
13+
## Usage
14+
```
15+
from typeform.client import Client
16+
17+
client = Client('API_KEY')
18+
```
19+
20+
Get form ID
21+
```
22+
client.get_form_uid('URL_FORM')
23+
```
24+
25+
Get form information
26+
```
27+
client.get_form_information('UID, URL')
28+
```
29+
30+
Get form stats
31+
```
32+
client.get_form_stats('UID, URL')
33+
```
34+
35+
Get form questions
36+
```
37+
client.get_form_questions('UID, URL')
38+
```
39+
40+
Get form metadata
41+
```
42+
client.get_form_metadata('UID, URL')
43+
```
44+
45+
## TODO
46+
- create_form
47+
- Update_form
48+
- delete_form
49+
- get_custom_form_messages
50+
- update_custom_messages
51+
- create_image
52+
- get_images_collection
53+
- get_image
54+
- delete_image
55+
- get_image_by_size
56+
- get_background_by_size
57+
- get_choice_image_by_size
58+
- create_theme
59+
- get_themes
60+
- update_themes
61+
- delete_themes

0 commit comments

Comments
 (0)