@@ -72,20 +72,22 @@ Client returns the following properties:
72
72
- ` teams `
73
73
- ` workspaces `
74
74
- ` themes `
75
+ - ` responses `
76
+ - ` webhooks `
75
77
76
78
Each one of them encapsulates the operations related to it (like listing, updating, deleting the resource).
77
79
78
80
### Forms
79
81
80
- #### ` forms.list({ page: 1, page_size: 10, search: '' }) `
82
+ #### ` forms.list({ page: 1, page_size = 10, search = '' }) `
81
83
- Get a list of your typeforms
82
84
- Returns a list of typeform with the payload [ refenced here] ( https://developer.typeform.com/create/reference/retrieve-forms/ ) .
83
85
84
86
#### ` forms.get({ uid }) `
85
87
- Get a typeform by UID
86
88
- Returns a typeform with the payload [ refenced here] ( https://developer.typeform.com/create/reference/retrieve-form/ ) .
87
89
88
- #### ` forms.update({ uid, data = {}, override: false }) `
90
+ #### ` forms.update({ uid, data = {}, override = false }) `
89
91
- Get a typeform by UID
90
92
- Returns a typeform with the payload [ refenced here] ( https://developer.typeform.com/create/reference/retrieve-form/ ) .
91
93
@@ -182,6 +184,39 @@ Each one of them encapsulates the operations related to it (like listing, updati
182
184
- ` members ` : ` string ` or an ` array ` and should be the email fo the user
183
185
- Removing multiple members at once is possible using an array of emails
184
186
187
+ ### Responses
188
+
189
+ #### ` responses.list({ uid, page_size, since, until, after, before, completed, sort, query, fields }) `
190
+ - List responses from the given ID
191
+ - ` uid ` : typeform UID
192
+ - For parameter details check [ the documentation] ( https://developer.typeform.com/responses/reference/retrieve-responses/ )
193
+
194
+ ## Webhooks
195
+
196
+ #### ` webhook.get({ uid, tag }) `
197
+ - Get detailf for a webhook with the given tag
198
+ - ` uid ` : typeform UID
199
+ - ` tag ` : tag of the webhook created
200
+
201
+ #### ` webhook.create({ uid, tag, url, enable = false }) `
202
+ - Create a webhook with the given tag
203
+ - ` uid ` : typeform UID
204
+ - ` tag ` : (string) tag of the webhook, how are you going to identify it
205
+ - ` url ` : (string) url of the service you want to notify
206
+ - ` enable ` : (bool)
207
+
208
+ #### ` webhook.update({ uid, tag, url, enable = false }) `
209
+ - Update a webhook with the given tag
210
+ - ` uid ` : typeform UID
211
+ - ` tag ` : (string) tag of the webhook, how are you going to identify it
212
+ - ` url ` : (string) url of the service you want to notify
213
+ - ` enable ` : (bool)
214
+
215
+ #### ` webhook.delete({ uid, tag }) `
216
+ - Delete for a webhook with the given tag
217
+ - ` uid ` : typeform UID
218
+ - ` tag ` : (string) tag of the webhook
219
+
185
220
## Examples
186
221
187
222
##### Update specific typeform property, as [ referenced here] ( https://developer.typeform.com/create/reference/update-form-patch/ )
@@ -254,7 +289,6 @@ The theme property applies a `theme` to the form. If you don't specify a value f
254
289
255
290
```
256
291
257
-
258
292
### Testing
259
293
260
294
The project has implemeted unit and integration tests.
0 commit comments