Skip to content

Commit 73ac999

Browse files
fern-api[bot]jverce
fern-api[bot]
and
jverce
authored
Fix the reload props response schema (#81)
* Fix the reload props response schema * Add endpoint descriptions --------- Co-authored-by: fern-api <115122769+fern-api[bot]@users.noreply.github.com> Co-authored-by: Jay Vercellone <[email protected]>
1 parent 40079c5 commit 73ac999

File tree

26 files changed

+368
-3
lines changed

26 files changed

+368
-3
lines changed

‎src/pipedream/accounts/client.py

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,8 @@ def list(
4040
request_options: typing.Optional[RequestOptions] = None,
4141
) -> SyncPager[Account]:
4242
"""
43+
Retrieve all connected accounts for the project with optional filtering
44+
4345
Parameters
4446
----------
4547
app_id : typing.Optional[str]
@@ -111,6 +113,8 @@ def create(
111113
request_options: typing.Optional[RequestOptions] = None,
112114
) -> Account:
113115
"""
116+
Connect a new account for an external user in the project
117+
114118
Parameters
115119
----------
116120
app_slug : str
@@ -177,6 +181,8 @@ def retrieve(
177181
request_options: typing.Optional[RequestOptions] = None,
178182
) -> Account:
179183
"""
184+
Get the details for a specific connected account
185+
180186
Parameters
181187
----------
182188
account_id : str
@@ -213,6 +219,8 @@ def retrieve(
213219

214220
def delete(self, account_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> None:
215221
"""
222+
Remove a connected account and its associated credentials
223+
216224
Parameters
217225
----------
218226
account_id : str
@@ -243,6 +251,8 @@ def delete(self, account_id: str, *, request_options: typing.Optional[RequestOpt
243251

244252
def delete_by_app(self, app_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> None:
245253
"""
254+
Remove all connected accounts for a specific app
255+
246256
Parameters
247257
----------
248258
app_id : str
@@ -300,6 +310,8 @@ async def list(
300310
request_options: typing.Optional[RequestOptions] = None,
301311
) -> AsyncPager[Account]:
302312
"""
313+
Retrieve all connected accounts for the project with optional filtering
314+
303315
Parameters
304316
----------
305317
app_id : typing.Optional[str]
@@ -380,6 +392,8 @@ async def create(
380392
request_options: typing.Optional[RequestOptions] = None,
381393
) -> Account:
382394
"""
395+
Connect a new account for an external user in the project
396+
383397
Parameters
384398
----------
385399
app_slug : str
@@ -454,6 +468,8 @@ async def retrieve(
454468
request_options: typing.Optional[RequestOptions] = None,
455469
) -> Account:
456470
"""
471+
Get the details for a specific connected account
472+
457473
Parameters
458474
----------
459475
account_id : str
@@ -498,6 +514,8 @@ async def main() -> None:
498514

499515
async def delete(self, account_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> None:
500516
"""
517+
Remove a connected account and its associated credentials
518+
501519
Parameters
502520
----------
503521
account_id : str
@@ -536,6 +554,8 @@ async def main() -> None:
536554

537555
async def delete_by_app(self, app_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> None:
538556
"""
557+
Remove all connected accounts for a specific app
558+
539559
Parameters
540560
----------
541561
app_id : str

‎src/pipedream/accounts/raw_client.py

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,8 @@ def list(
3434
request_options: typing.Optional[RequestOptions] = None,
3535
) -> SyncPager[Account]:
3636
"""
37+
Retrieve all connected accounts for the project with optional filtering
38+
3739
Parameters
3840
----------
3941
app_id : typing.Optional[str]
@@ -124,6 +126,8 @@ def create(
124126
request_options: typing.Optional[RequestOptions] = None,
125127
) -> HttpResponse[Account]:
126128
"""
129+
Connect a new account for an external user in the project
130+
127131
Parameters
128132
----------
129133
app_slug : str
@@ -197,6 +201,8 @@ def retrieve(
197201
request_options: typing.Optional[RequestOptions] = None,
198202
) -> HttpResponse[Account]:
199203
"""
204+
Get the details for a specific connected account
205+
200206
Parameters
201207
----------
202208
account_id : str
@@ -237,6 +243,8 @@ def retrieve(
237243

238244
def delete(self, account_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> HttpResponse[None]:
239245
"""
246+
Remove a connected account and its associated credentials
247+
240248
Parameters
241249
----------
242250
account_id : str
@@ -265,6 +273,8 @@ def delete_by_app(
265273
self, app_id: str, *, request_options: typing.Optional[RequestOptions] = None
266274
) -> HttpResponse[None]:
267275
"""
276+
Remove all connected accounts for a specific app
277+
268278
Parameters
269279
----------
270280
app_id : str
@@ -307,6 +317,8 @@ async def list(
307317
request_options: typing.Optional[RequestOptions] = None,
308318
) -> AsyncPager[Account]:
309319
"""
320+
Retrieve all connected accounts for the project with optional filtering
321+
310322
Parameters
311323
----------
312324
app_id : typing.Optional[str]
@@ -400,6 +412,8 @@ async def create(
400412
request_options: typing.Optional[RequestOptions] = None,
401413
) -> AsyncHttpResponse[Account]:
402414
"""
415+
Connect a new account for an external user in the project
416+
403417
Parameters
404418
----------
405419
app_slug : str
@@ -473,6 +487,8 @@ async def retrieve(
473487
request_options: typing.Optional[RequestOptions] = None,
474488
) -> AsyncHttpResponse[Account]:
475489
"""
490+
Get the details for a specific connected account
491+
476492
Parameters
477493
----------
478494
account_id : str
@@ -515,6 +531,8 @@ async def delete(
515531
self, account_id: str, *, request_options: typing.Optional[RequestOptions] = None
516532
) -> AsyncHttpResponse[None]:
517533
"""
534+
Remove a connected account and its associated credentials
535+
518536
Parameters
519537
----------
520538
account_id : str
@@ -543,6 +561,8 @@ async def delete_by_app(
543561
self, app_id: str, *, request_options: typing.Optional[RequestOptions] = None
544562
) -> AsyncHttpResponse[None]:
545563
"""
564+
Remove all connected accounts for a specific app
565+
546566
Parameters
547567
----------
548568
app_id : str

‎src/pipedream/actions/client.py

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,8 @@ def list(
4242
request_options: typing.Optional[RequestOptions] = None,
4343
) -> SyncPager[Component]:
4444
"""
45+
Retrieve available actions with optional search and app filtering
46+
4547
Parameters
4648
----------
4749
after : typing.Optional[str]
@@ -90,6 +92,8 @@ def list(
9092

9193
def retrieve(self, component_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> Component:
9294
"""
95+
Get detailed configuration for a specific action by its key
96+
9397
Parameters
9498
----------
9599
component_id : str
@@ -135,6 +139,8 @@ def configure_prop(
135139
request_options: typing.Optional[RequestOptions] = None,
136140
) -> ConfigurePropResponse:
137141
"""
142+
Retrieve remote options for a given prop for a action
143+
138144
Parameters
139145
----------
140146
id : str
@@ -213,6 +219,8 @@ def reload_props(
213219
request_options: typing.Optional[RequestOptions] = None,
214220
) -> ReloadPropsResponse:
215221
"""
222+
Reload the prop definition based on the currently configured props
223+
216224
Parameters
217225
----------
218226
id : str
@@ -274,6 +282,8 @@ def run(
274282
request_options: typing.Optional[RequestOptions] = None,
275283
) -> RunActionResponse:
276284
"""
285+
Execute an action with the provided configuration and return results
286+
277287
Parameters
278288
----------
279289
id : str
@@ -350,6 +360,8 @@ async def list(
350360
request_options: typing.Optional[RequestOptions] = None,
351361
) -> AsyncPager[Component]:
352362
"""
363+
Retrieve available actions with optional search and app filtering
364+
353365
Parameters
354366
----------
355367
after : typing.Optional[str]
@@ -409,6 +421,8 @@ async def retrieve(
409421
self, component_id: str, *, request_options: typing.Optional[RequestOptions] = None
410422
) -> Component:
411423
"""
424+
Get detailed configuration for a specific action by its key
425+
412426
Parameters
413427
----------
414428
component_id : str
@@ -462,6 +476,8 @@ async def configure_prop(
462476
request_options: typing.Optional[RequestOptions] = None,
463477
) -> ConfigurePropResponse:
464478
"""
479+
Retrieve remote options for a given prop for a action
480+
465481
Parameters
466482
----------
467483
id : str
@@ -548,6 +564,8 @@ async def reload_props(
548564
request_options: typing.Optional[RequestOptions] = None,
549565
) -> ReloadPropsResponse:
550566
"""
567+
Reload the prop definition based on the currently configured props
568+
551569
Parameters
552570
----------
553571
id : str
@@ -617,6 +635,8 @@ async def run(
617635
request_options: typing.Optional[RequestOptions] = None,
618636
) -> RunActionResponse:
619637
"""
638+
Execute an action with the provided configuration and return results
639+
620640
Parameters
621641
----------
622642
id : str

‎src/pipedream/actions/raw_client.py

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,8 @@ def list(
3838
request_options: typing.Optional[RequestOptions] = None,
3939
) -> SyncPager[Component]:
4040
"""
41+
Retrieve available actions with optional search and app filtering
42+
4143
Parameters
4244
----------
4345
after : typing.Optional[str]
@@ -110,6 +112,8 @@ def retrieve(
110112
self, component_id: str, *, request_options: typing.Optional[RequestOptions] = None
111113
) -> HttpResponse[Component]:
112114
"""
115+
Get detailed configuration for a specific action by its key
116+
113117
Parameters
114118
----------
115119
component_id : str
@@ -159,6 +163,8 @@ def configure_prop(
159163
request_options: typing.Optional[RequestOptions] = None,
160164
) -> HttpResponse[ConfigurePropResponse]:
161165
"""
166+
Retrieve remote options for a given prop for a action
167+
162168
Parameters
163169
----------
164170
id : str
@@ -242,6 +248,8 @@ def reload_props(
242248
request_options: typing.Optional[RequestOptions] = None,
243249
) -> HttpResponse[ReloadPropsResponse]:
244250
"""
251+
Reload the prop definition based on the currently configured props
252+
245253
Parameters
246254
----------
247255
id : str
@@ -309,6 +317,8 @@ def run(
309317
request_options: typing.Optional[RequestOptions] = None,
310318
) -> HttpResponse[RunActionResponse]:
311319
"""
320+
Execute an action with the provided configuration and return results
321+
312322
Parameters
313323
----------
314324
id : str
@@ -382,6 +392,8 @@ async def list(
382392
request_options: typing.Optional[RequestOptions] = None,
383393
) -> AsyncPager[Component]:
384394
"""
395+
Retrieve available actions with optional search and app filtering
396+
385397
Parameters
386398
----------
387399
after : typing.Optional[str]
@@ -457,6 +469,8 @@ async def retrieve(
457469
self, component_id: str, *, request_options: typing.Optional[RequestOptions] = None
458470
) -> AsyncHttpResponse[Component]:
459471
"""
472+
Get detailed configuration for a specific action by its key
473+
460474
Parameters
461475
----------
462476
component_id : str
@@ -506,6 +520,8 @@ async def configure_prop(
506520
request_options: typing.Optional[RequestOptions] = None,
507521
) -> AsyncHttpResponse[ConfigurePropResponse]:
508522
"""
523+
Retrieve remote options for a given prop for a action
524+
509525
Parameters
510526
----------
511527
id : str
@@ -589,6 +605,8 @@ async def reload_props(
589605
request_options: typing.Optional[RequestOptions] = None,
590606
) -> AsyncHttpResponse[ReloadPropsResponse]:
591607
"""
608+
Reload the prop definition based on the currently configured props
609+
592610
Parameters
593611
----------
594612
id : str
@@ -656,6 +674,8 @@ async def run(
656674
request_options: typing.Optional[RequestOptions] = None,
657675
) -> AsyncHttpResponse[RunActionResponse]:
658676
"""
677+
Execute an action with the provided configuration and return results
678+
659679
Parameters
660680
----------
661681
id : str

‎src/pipedream/app_categories/client.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,8 @@ def with_raw_response(self) -> RawAppCategoriesClient:
2626

2727
def list(self, *, request_options: typing.Optional[RequestOptions] = None) -> ListAppCategoriesResponse:
2828
"""
29+
Retrieve all available categories for integrated apps
30+
2931
Parameters
3032
----------
3133
request_options : typing.Optional[RequestOptions]
@@ -53,6 +55,8 @@ def list(self, *, request_options: typing.Optional[RequestOptions] = None) -> Li
5355

5456
def retrieve(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> GetAppCategoryResponse:
5557
"""
58+
Get details of a specific app category by its ID
59+
5660
Parameters
5761
----------
5862
id : str
@@ -101,6 +105,8 @@ def with_raw_response(self) -> AsyncRawAppCategoriesClient:
101105

102106
async def list(self, *, request_options: typing.Optional[RequestOptions] = None) -> ListAppCategoriesResponse:
103107
"""
108+
Retrieve all available categories for integrated apps
109+
104110
Parameters
105111
----------
106112
request_options : typing.Optional[RequestOptions]
@@ -138,6 +144,8 @@ async def retrieve(
138144
self, id: str, *, request_options: typing.Optional[RequestOptions] = None
139145
) -> GetAppCategoryResponse:
140146
"""
147+
Get details of a specific app category by its ID
148+
141149
Parameters
142150
----------
143151
id : str

0 commit comments

Comments
 (0)