composio 0.1.1 → 0.1.3
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +14 -18
- data/README.md +7 -611
- data/lib/composio/api/actions_api.rb +52 -634
- data/lib/composio/api/apps_api.rb +9 -2
- data/lib/composio/api/auth_api.rb +0 -257
- data/lib/composio/api/integrations_api.rb +8 -113
- data/lib/composio/api/triggers_api.rb +0 -197
- data/lib/composio/models/action_details.rb +18 -4
- data/lib/composio/models/action_details_minimal.rb +18 -4
- data/lib/composio/models/app_query_dto.rb +14 -4
- data/lib/composio/version.rb +1 -1
- data/lib/composio.rb +0 -9
- data/spec/api/actions_api_spec.rb +1 -77
- data/spec/api/apps_api_spec.rb +1 -0
- data/spec/api/auth_api_spec.rb +0 -33
- data/spec/api/integrations_api_spec.rb +2 -14
- data/spec/api/triggers_api_spec.rb +0 -25
- data/spec/models/action_details_minimal_spec.rb +6 -0
- data/spec/models/action_details_spec.rb +6 -0
- data/spec/models/app_query_dto_spec.rb +6 -0
- metadata +107 -116
- data/lib/composio/api/cli_api.rb +0 -266
- data/lib/composio/api/metadata_api.rb +0 -180
- data/lib/composio/api/team_api.rb +0 -188
- data/spec/api/cli_api_spec.rb +0 -63
- data/spec/api/metadata_api_spec.rb +0 -50
- data/spec/api/team_api_spec.rb +0 -50
data/README.md
CHANGED
@@ -6,7 +6,7 @@
|
|
6
6
|
|
7
7
|
Composio SDK: Equip your agent with high-quality tools and build your real-world usecase
|
8
8
|
|
9
|
-
[![npm](https://img.shields.io/badge/gem-v0.1.
|
9
|
+
[![npm](https://img.shields.io/badge/gem-v0.1.3-blue)](https://rubygems.org/gems/composio/versions/0.1.3)
|
10
10
|
[![More Info](https://img.shields.io/badge/More%20Info-Click%20Here-orange)](https://composio.dev)
|
11
11
|
|
12
12
|
</div>
|
@@ -23,24 +23,13 @@ Composio SDK: Equip your agent with high-quality tools and build your real-world
|
|
23
23
|
* [`composio.api_keys.list`](#composioapi_keyslist)
|
24
24
|
* [`composio.api_keys.remove`](#composioapi_keysremove)
|
25
25
|
* [`composio.actions.execute`](#composioactionsexecute)
|
26
|
-
* [`composio.actions.execute_0`](#composioactionsexecute_0)
|
27
26
|
* [`composio.actions.execute_action_proxy`](#composioactionsexecute_action_proxy)
|
28
|
-
* [`composio.actions.execute_proxy`](#composioactionsexecute_proxy)
|
29
|
-
* [`composio.actions.get`](#composioactionsget)
|
30
27
|
* [`composio.actions.get_action_by_id`](#composioactionsget_action_by_id)
|
31
28
|
* [`composio.actions.get_all_actions_based_on_query`](#composioactionsget_all_actions_based_on_query)
|
32
|
-
* [`composio.actions.list`](#composioactionslist)
|
33
|
-
* [`composio.actions.list_0`](#composioactionslist_0)
|
34
29
|
* [`composio.apps.get_details`](#composioappsget_details)
|
35
30
|
* [`composio.apps.list`](#composioappslist)
|
36
31
|
* [`composio.apps.list_open_api_specs`](#composioappslist_open_api_specs)
|
37
32
|
* [`composio.auth.identify_client_operation`](#composioauthidentify_client_operation)
|
38
|
-
* [`composio.auth.send_magic_link`](#composioauthsend_magic_link)
|
39
|
-
* [`composio.auth.user_logout`](#composioauthuser_logout)
|
40
|
-
* [`composio.auth.verify_magic_link`](#composioauthverify_magic_link)
|
41
|
-
* [`composio.cli.exchange_code`](#composiocliexchange_code)
|
42
|
-
* [`composio.cli.get_code`](#composiocliget_code)
|
43
|
-
* [`composio.cli.verify_code`](#composiocliverify_code)
|
44
33
|
* [`composio.connections.delete`](#composioconnectionsdelete)
|
45
34
|
* [`composio.connections.disable`](#composioconnectionsdisable)
|
46
35
|
* [`composio.connections.enable`](#composioconnectionsenable)
|
@@ -52,24 +41,17 @@ Composio SDK: Equip your agent with high-quality tools and build your real-world
|
|
52
41
|
* [`composio.integrations.get_connector_info`](#composiointegrationsget_connector_info)
|
53
42
|
* [`composio.integrations.list_global_connectors`](#composiointegrationslist_global_connectors)
|
54
43
|
* [`composio.integrations.update_integration`](#composiointegrationsupdate_integration)
|
55
|
-
* [`composio.integrations.update_status`](#composiointegrationsupdate_status)
|
56
44
|
* [`composio.logs.list`](#composiologslist)
|
57
|
-
* [`composio.metadata.get_toggle_info`](#composiometadataget_toggle_info)
|
58
|
-
* [`composio.metadata.toggle_trigger_state`](#composiometadatatoggle_trigger_state)
|
59
|
-
* [`composio.team.get_member_list`](#composioteamget_member_list)
|
60
|
-
* [`composio.team.send_invitation`](#composioteamsend_invitation)
|
61
45
|
* [`composio.triggers.delete_trigger_instance`](#composiotriggersdelete_trigger_instance)
|
62
46
|
* [`composio.triggers.disable_trigger_instance`](#composiotriggersdisable_trigger_instance)
|
63
47
|
* [`composio.triggers.enable`](#composiotriggersenable)
|
64
48
|
* [`composio.triggers.get_active_triggers`](#composiotriggersget_active_triggers)
|
65
|
-
* [`composio.triggers.get_by_id`](#composiotriggersget_by_id)
|
66
49
|
* [`composio.triggers.get_callback_url`](#composiotriggersget_callback_url)
|
67
50
|
* [`composio.triggers.get_logs_based_on_connection_and_integration_details`](#composiotriggersget_logs_based_on_connection_and_integration_details)
|
68
51
|
* [`composio.triggers.get_trigger_info`](#composiotriggersget_trigger_info)
|
69
52
|
* [`composio.triggers.list`](#composiotriggerslist)
|
70
53
|
* [`composio.triggers.set_callback_url`](#composiotriggersset_callback_url)
|
71
54
|
* [`composio.triggers.switch_instance_status`](#composiotriggersswitch_instance_status)
|
72
|
-
* [`composio.triggers.switch_post_instance_status`](#composiotriggersswitch_post_instance_status)
|
73
55
|
|
74
56
|
<!-- tocstop -->
|
75
57
|
|
@@ -78,7 +60,7 @@ Composio SDK: Equip your agent with high-quality tools and build your real-world
|
|
78
60
|
Add to Gemfile:
|
79
61
|
|
80
62
|
```ruby
|
81
|
-
gem 'composio', '~> 0.1.
|
63
|
+
gem 'composio', '~> 0.1.3'
|
82
64
|
```
|
83
65
|
|
84
66
|
## Getting Started<a id="getting-started"></a>
|
@@ -197,53 +179,12 @@ p result
|
|
197
179
|
|
198
180
|
### `composio.actions.execute`<a id="composioactionsexecute"></a>
|
199
181
|
|
200
|
-
Execute action
|
201
|
-
|
202
|
-
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
203
|
-
|
204
|
-
```ruby
|
205
|
-
result = composio.actions.execute(
|
206
|
-
action_id: "'+j>6",
|
207
|
-
connected_account_id: "string_example",
|
208
|
-
app_name: "string_example",
|
209
|
-
entity_id: "string_example",
|
210
|
-
endpoint: "string_example",
|
211
|
-
input: {},
|
212
|
-
text: "string_example",
|
213
|
-
)
|
214
|
-
p result
|
215
|
-
```
|
216
|
-
|
217
|
-
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
218
|
-
|
219
|
-
##### action_id: `String`<a id="action_id-string"></a>
|
220
|
-
##### connectedAccountId: `String`<a id="connectedaccountid-string"></a>
|
221
|
-
##### appName: `String`<a id="appname-string"></a>
|
222
|
-
##### entityId: `String`<a id="entityid-string"></a>
|
223
|
-
##### endpoint: `String`<a id="endpoint-string"></a>
|
224
|
-
##### input: `Object`<a id="input-object"></a>
|
225
|
-
##### text: `String`<a id="text-string"></a>
|
226
|
-
#### 🔄 Return<a id="🔄-return"></a>
|
227
|
-
|
228
|
-
[ActionExecutionResDto](./lib/composio/models/action_execution_res_dto.rb)
|
229
|
-
|
230
|
-
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
231
|
-
|
232
|
-
`/api/v1/actions/{actionId}/execute` `POST`
|
233
|
-
|
234
|
-
[🔙 **Back to Table of Contents**](#table-of-contents)
|
235
|
-
|
236
|
-
---
|
237
|
-
|
238
|
-
|
239
|
-
### `composio.actions.execute_0`<a id="composioactionsexecute_0"></a>
|
240
|
-
|
241
182
|
Execute an action. Support both connected account and no auth auth.
|
242
183
|
|
243
184
|
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
244
185
|
|
245
186
|
```ruby
|
246
|
-
result = composio.actions.
|
187
|
+
result = composio.actions.execute(
|
247
188
|
action_id: "'+j>6",
|
248
189
|
connected_account_id: "string_example",
|
249
190
|
app_name: "string_example",
|
@@ -308,66 +249,6 @@ p result
|
|
308
249
|
---
|
309
250
|
|
310
251
|
|
311
|
-
### `composio.actions.execute_proxy`<a id="composioactionsexecute_proxy"></a>
|
312
|
-
|
313
|
-
Execute action proxy
|
314
|
-
|
315
|
-
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
316
|
-
|
317
|
-
```ruby
|
318
|
-
result = composio.actions.execute_proxy(
|
319
|
-
endpoint: "endpoint_example",
|
320
|
-
connected_account_id: "connectedAccountId_example",
|
321
|
-
)
|
322
|
-
p result
|
323
|
-
```
|
324
|
-
|
325
|
-
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
326
|
-
|
327
|
-
##### endpoint: `String`<a id="endpoint-string"></a>
|
328
|
-
##### connected_account_id: `String`<a id="connected_account_id-string"></a>
|
329
|
-
#### 🔄 Return<a id="🔄-return"></a>
|
330
|
-
|
331
|
-
[ExecuteActionResDTO](./lib/composio/models/execute_action_res_dto.rb)
|
332
|
-
|
333
|
-
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
334
|
-
|
335
|
-
`/api/v1/actions/proxy` `POST`
|
336
|
-
|
337
|
-
[🔙 **Back to Table of Contents**](#table-of-contents)
|
338
|
-
|
339
|
-
---
|
340
|
-
|
341
|
-
|
342
|
-
### `composio.actions.get`<a id="composioactionsget"></a>
|
343
|
-
|
344
|
-
Get action
|
345
|
-
|
346
|
-
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
347
|
-
|
348
|
-
```ruby
|
349
|
-
result = composio.actions.get(
|
350
|
-
action_id: "'+j>6",
|
351
|
-
)
|
352
|
-
p result
|
353
|
-
```
|
354
|
-
|
355
|
-
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
356
|
-
|
357
|
-
##### action_id: `String`<a id="action_id-string"></a>
|
358
|
-
#### 🔄 Return<a id="🔄-return"></a>
|
359
|
-
|
360
|
-
[ActionDetails](./lib/composio/models/action_details.rb)
|
361
|
-
|
362
|
-
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
363
|
-
|
364
|
-
`/api/v1/actions/{actionId}` `GET`
|
365
|
-
|
366
|
-
[🔙 **Back to Table of Contents**](#table-of-contents)
|
367
|
-
|
368
|
-
---
|
369
|
-
|
370
|
-
|
371
252
|
### `composio.actions.get_action_by_id`<a id="composioactionsget_action_by_id"></a>
|
372
253
|
|
373
254
|
Get action details
|
@@ -444,100 +325,6 @@ p result
|
|
444
325
|
---
|
445
326
|
|
446
327
|
|
447
|
-
### `composio.actions.list`<a id="composioactionslist"></a>
|
448
|
-
|
449
|
-
List actions
|
450
|
-
|
451
|
-
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
452
|
-
|
453
|
-
```ruby
|
454
|
-
result = composio.actions.list(
|
455
|
-
app_names: "string_example",
|
456
|
-
use_case: "string_example",
|
457
|
-
show_enabled_only: true,
|
458
|
-
limit: 3.14,
|
459
|
-
apps: "string_example",
|
460
|
-
actions: "string_example",
|
461
|
-
tags: "string_example",
|
462
|
-
usecase_limit: 3.14,
|
463
|
-
filter_important_actions: true,
|
464
|
-
show_all: true,
|
465
|
-
)
|
466
|
-
p result
|
467
|
-
```
|
468
|
-
|
469
|
-
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
470
|
-
|
471
|
-
##### app_names: `String`<a id="app_names-string"></a>
|
472
|
-
##### use_case: `String`<a id="use_case-string"></a>
|
473
|
-
##### show_enabled_only: `Boolean`<a id="show_enabled_only-boolean"></a>
|
474
|
-
##### limit: `Float`<a id="limit-float"></a>
|
475
|
-
##### apps: `String`<a id="apps-string"></a>
|
476
|
-
##### actions: `String`<a id="actions-string"></a>
|
477
|
-
##### tags: `String`<a id="tags-string"></a>
|
478
|
-
##### usecase_limit: `Float`<a id="usecase_limit-float"></a>
|
479
|
-
##### filter_important_actions: `Boolean`<a id="filter_important_actions-boolean"></a>
|
480
|
-
##### show_all: `Boolean`<a id="show_all-boolean"></a>
|
481
|
-
#### 🔄 Return<a id="🔄-return"></a>
|
482
|
-
|
483
|
-
[ActionsListResponseDTO](./lib/composio/models/actions_list_response_dto.rb)
|
484
|
-
|
485
|
-
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
486
|
-
|
487
|
-
`/api/v1/actions` `GET`
|
488
|
-
|
489
|
-
[🔙 **Back to Table of Contents**](#table-of-contents)
|
490
|
-
|
491
|
-
---
|
492
|
-
|
493
|
-
|
494
|
-
### `composio.actions.list_0`<a id="composioactionslist_0"></a>
|
495
|
-
|
496
|
-
Retrieve a list of all actions based on query parameters.
|
497
|
-
|
498
|
-
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
499
|
-
|
500
|
-
```ruby
|
501
|
-
result = composio.actions.list_0(
|
502
|
-
app_names: "string_example",
|
503
|
-
use_case: "string_example",
|
504
|
-
show_enabled_only: true,
|
505
|
-
limit: 3.14,
|
506
|
-
apps: "string_example",
|
507
|
-
actions: "string_example",
|
508
|
-
tags: "string_example",
|
509
|
-
usecase_limit: 3.14,
|
510
|
-
filter_important_actions: true,
|
511
|
-
show_all: true,
|
512
|
-
)
|
513
|
-
p result
|
514
|
-
```
|
515
|
-
|
516
|
-
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
517
|
-
|
518
|
-
##### app_names: `String`<a id="app_names-string"></a>
|
519
|
-
##### use_case: `String`<a id="use_case-string"></a>
|
520
|
-
##### show_enabled_only: `Boolean`<a id="show_enabled_only-boolean"></a>
|
521
|
-
##### limit: `Float`<a id="limit-float"></a>
|
522
|
-
##### apps: `String`<a id="apps-string"></a>
|
523
|
-
##### actions: `String`<a id="actions-string"></a>
|
524
|
-
##### tags: `String`<a id="tags-string"></a>
|
525
|
-
##### usecase_limit: `Float`<a id="usecase_limit-float"></a>
|
526
|
-
##### filter_important_actions: `Boolean`<a id="filter_important_actions-boolean"></a>
|
527
|
-
##### show_all: `Boolean`<a id="show_all-boolean"></a>
|
528
|
-
#### 🔄 Return<a id="🔄-return"></a>
|
529
|
-
|
530
|
-
[ActionsListResponseDTO](./lib/composio/models/actions_list_response_dto.rb)
|
531
|
-
|
532
|
-
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
533
|
-
|
534
|
-
`/api/v2/actions` `GET`
|
535
|
-
|
536
|
-
[🔙 **Back to Table of Contents**](#table-of-contents)
|
537
|
-
|
538
|
-
---
|
539
|
-
|
540
|
-
|
541
328
|
### `composio.apps.get_details`<a id="composioappsget_details"></a>
|
542
329
|
|
543
330
|
Get app details
|
@@ -576,6 +363,7 @@ Retrieve a list of all applications based on query parameters.
|
|
576
363
|
```ruby
|
577
364
|
result = composio.apps.list(
|
578
365
|
category: "string_example",
|
366
|
+
include_local: "string_example",
|
579
367
|
)
|
580
368
|
p result
|
581
369
|
```
|
@@ -583,6 +371,7 @@ p result
|
|
583
371
|
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
584
372
|
|
585
373
|
##### category: `String`<a id="category-string"></a>
|
374
|
+
##### include_local: `String`<a id="include_local-string"></a>
|
586
375
|
#### 🔄 Return<a id="🔄-return"></a>
|
587
376
|
|
588
377
|
[AppListResDTO](./lib/composio/models/app_list_res_dto.rb)
|
@@ -655,182 +444,6 @@ The framework used by the client
|
|
655
444
|
---
|
656
445
|
|
657
446
|
|
658
|
-
### `composio.auth.send_magic_link`<a id="composioauthsend_magic_link"></a>
|
659
|
-
|
660
|
-
Send magic link
|
661
|
-
|
662
|
-
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
663
|
-
|
664
|
-
```ruby
|
665
|
-
result = composio.auth.send_magic_link(
|
666
|
-
email: "string_example",
|
667
|
-
verify_host: "string_example",
|
668
|
-
)
|
669
|
-
p result
|
670
|
-
```
|
671
|
-
|
672
|
-
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
673
|
-
|
674
|
-
##### email: `String`<a id="email-string"></a>
|
675
|
-
The email of the user
|
676
|
-
|
677
|
-
##### verifyHost: `String`<a id="verifyhost-string"></a>
|
678
|
-
The frontend host of the user
|
679
|
-
|
680
|
-
#### 🔄 Return<a id="🔄-return"></a>
|
681
|
-
|
682
|
-
[MagicLinkResDTO](./lib/composio/models/magic_link_res_dto.rb)
|
683
|
-
|
684
|
-
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
685
|
-
|
686
|
-
`/api/v1/client/auth/send_magic_link` `POST`
|
687
|
-
|
688
|
-
[🔙 **Back to Table of Contents**](#table-of-contents)
|
689
|
-
|
690
|
-
---
|
691
|
-
|
692
|
-
|
693
|
-
### `composio.auth.user_logout`<a id="composioauthuser_logout"></a>
|
694
|
-
|
695
|
-
Logout the user and clear the server side session
|
696
|
-
|
697
|
-
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
698
|
-
|
699
|
-
```ruby
|
700
|
-
result = composio.auth.user_logout
|
701
|
-
p result
|
702
|
-
```
|
703
|
-
|
704
|
-
#### 🔄 Return<a id="🔄-return"></a>
|
705
|
-
|
706
|
-
[LogoutResDTO](./lib/composio/models/logout_res_dto.rb)
|
707
|
-
|
708
|
-
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
709
|
-
|
710
|
-
`/api/v1/client/auth/logout` `POST`
|
711
|
-
|
712
|
-
[🔙 **Back to Table of Contents**](#table-of-contents)
|
713
|
-
|
714
|
-
---
|
715
|
-
|
716
|
-
|
717
|
-
### `composio.auth.verify_magic_link`<a id="composioauthverify_magic_link"></a>
|
718
|
-
|
719
|
-
Verify magic link
|
720
|
-
|
721
|
-
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
722
|
-
|
723
|
-
```ruby
|
724
|
-
result = composio.auth.verify_magic_link(
|
725
|
-
token: "string_example",
|
726
|
-
)
|
727
|
-
p result
|
728
|
-
```
|
729
|
-
|
730
|
-
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
731
|
-
|
732
|
-
##### token: `String`<a id="token-string"></a>
|
733
|
-
The magic link token
|
734
|
-
|
735
|
-
#### 🔄 Return<a id="🔄-return"></a>
|
736
|
-
|
737
|
-
[VerifyMagicLinkResDTO](./lib/composio/models/verify_magic_link_res_dto.rb)
|
738
|
-
|
739
|
-
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
740
|
-
|
741
|
-
`/api/v1/client/auth/verify_magic_link` `POST`
|
742
|
-
|
743
|
-
[🔙 **Back to Table of Contents**](#table-of-contents)
|
744
|
-
|
745
|
-
---
|
746
|
-
|
747
|
-
|
748
|
-
### `composio.cli.exchange_code`<a id="composiocliexchange_code"></a>
|
749
|
-
|
750
|
-
Handle cli code exchange
|
751
|
-
|
752
|
-
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
753
|
-
|
754
|
-
```ruby
|
755
|
-
result = composio.cli.exchange_code
|
756
|
-
p result
|
757
|
-
```
|
758
|
-
|
759
|
-
#### 🔄 Return<a id="🔄-return"></a>
|
760
|
-
|
761
|
-
[GenerateCLISessionResDTO](./lib/composio/models/generate_cli_session_res_dto.rb)
|
762
|
-
|
763
|
-
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
764
|
-
|
765
|
-
`/api/v1/cli/generate-cli-session` `GET`
|
766
|
-
|
767
|
-
[🔙 **Back to Table of Contents**](#table-of-contents)
|
768
|
-
|
769
|
-
---
|
770
|
-
|
771
|
-
|
772
|
-
### `composio.cli.get_code`<a id="composiocliget_code"></a>
|
773
|
-
|
774
|
-
Get cli code
|
775
|
-
|
776
|
-
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
777
|
-
|
778
|
-
```ruby
|
779
|
-
result = composio.cli.get_code(
|
780
|
-
key: "key_example",
|
781
|
-
code: "string_example",
|
782
|
-
)
|
783
|
-
p result
|
784
|
-
```
|
785
|
-
|
786
|
-
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
787
|
-
|
788
|
-
##### key: `String`<a id="key-string"></a>
|
789
|
-
##### code: `String`<a id="code-string"></a>
|
790
|
-
#### 🔄 Return<a id="🔄-return"></a>
|
791
|
-
|
792
|
-
[GetCLISessionResDTO](./lib/composio/models/get_cli_session_res_dto.rb)
|
793
|
-
|
794
|
-
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
795
|
-
|
796
|
-
`/api/v1/cli/get-cli-code` `GET`
|
797
|
-
|
798
|
-
[🔙 **Back to Table of Contents**](#table-of-contents)
|
799
|
-
|
800
|
-
---
|
801
|
-
|
802
|
-
|
803
|
-
### `composio.cli.verify_code`<a id="composiocliverify_code"></a>
|
804
|
-
|
805
|
-
Handle cli code verification
|
806
|
-
|
807
|
-
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
808
|
-
|
809
|
-
```ruby
|
810
|
-
result = composio.cli.verify_code(
|
811
|
-
key: "key_example",
|
812
|
-
code: "string_example",
|
813
|
-
)
|
814
|
-
p result
|
815
|
-
```
|
816
|
-
|
817
|
-
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
818
|
-
|
819
|
-
##### key: `String`<a id="key-string"></a>
|
820
|
-
##### code: `String`<a id="code-string"></a>
|
821
|
-
#### 🔄 Return<a id="🔄-return"></a>
|
822
|
-
|
823
|
-
[VerifyCLICodeResDTO](./lib/composio/models/verify_cli_code_res_dto.rb)
|
824
|
-
|
825
|
-
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
826
|
-
|
827
|
-
`/api/v1/cli/verify-cli-code` `GET`
|
828
|
-
|
829
|
-
[🔙 **Back to Table of Contents**](#table-of-contents)
|
830
|
-
|
831
|
-
---
|
832
|
-
|
833
|
-
|
834
447
|
### `composio.connections.delete`<a id="composioconnectionsdelete"></a>
|
835
448
|
|
836
449
|
Delete connection
|
@@ -1135,7 +748,7 @@ p result
|
|
1135
748
|
|
1136
749
|
### `composio.integrations.list_global_connectors`<a id="composiointegrationslist_global_connectors"></a>
|
1137
750
|
|
1138
|
-
List
|
751
|
+
List all connectors
|
1139
752
|
|
1140
753
|
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
1141
754
|
|
@@ -1159,7 +772,7 @@ p result
|
|
1159
772
|
|
1160
773
|
### `composio.integrations.update_integration`<a id="composiointegrationsupdate_integration"></a>
|
1161
774
|
|
1162
|
-
|
775
|
+
Modify connector
|
1163
776
|
|
1164
777
|
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
1165
778
|
|
@@ -1194,43 +807,6 @@ Flag to indicate if the connector is enabled
|
|
1194
807
|
---
|
1195
808
|
|
1196
809
|
|
1197
|
-
### `composio.integrations.update_status`<a id="composiointegrationsupdate_status"></a>
|
1198
|
-
|
1199
|
-
Patch post connector
|
1200
|
-
|
1201
|
-
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
1202
|
-
|
1203
|
-
```ruby
|
1204
|
-
result = composio.integrations.update_status(
|
1205
|
-
integration_id: "'+j>6",
|
1206
|
-
auth_config: {},
|
1207
|
-
enabled: true,
|
1208
|
-
)
|
1209
|
-
p result
|
1210
|
-
```
|
1211
|
-
|
1212
|
-
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
1213
|
-
|
1214
|
-
##### integration_id: `String`<a id="integration_id-string"></a>
|
1215
|
-
##### authConfig: `Object`<a id="authconfig-object"></a>
|
1216
|
-
Authentication configuration for the connector
|
1217
|
-
|
1218
|
-
##### enabled: `Boolean`<a id="enabled-boolean"></a>
|
1219
|
-
Flag to indicate if the connector is enabled
|
1220
|
-
|
1221
|
-
#### 🔄 Return<a id="🔄-return"></a>
|
1222
|
-
|
1223
|
-
[PatchConnectorResDTO](./lib/composio/models/patch_connector_res_dto.rb)
|
1224
|
-
|
1225
|
-
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
1226
|
-
|
1227
|
-
`/api/v1/integrations/{integrationId}/status` `POST`
|
1228
|
-
|
1229
|
-
[🔙 **Back to Table of Contents**](#table-of-contents)
|
1230
|
-
|
1231
|
-
---
|
1232
|
-
|
1233
|
-
|
1234
810
|
### `composio.logs.list`<a id="composiologslist"></a>
|
1235
811
|
|
1236
812
|
List logs
|
@@ -1274,124 +850,6 @@ p result
|
|
1274
850
|
---
|
1275
851
|
|
1276
852
|
|
1277
|
-
### `composio.metadata.get_toggle_info`<a id="composiometadataget_toggle_info"></a>
|
1278
|
-
|
1279
|
-
Get toggle info
|
1280
|
-
|
1281
|
-
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
1282
|
-
|
1283
|
-
```ruby
|
1284
|
-
result = composio.metadata.get_toggle_info
|
1285
|
-
p result
|
1286
|
-
```
|
1287
|
-
|
1288
|
-
#### 🔄 Return<a id="🔄-return"></a>
|
1289
|
-
|
1290
|
-
[TriggerToggleInfoResponseDTO](./lib/composio/models/trigger_toggle_info_response_dto.rb)
|
1291
|
-
|
1292
|
-
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
1293
|
-
|
1294
|
-
`/api/v1/metadata/toggle.info` `GET`
|
1295
|
-
|
1296
|
-
[🔙 **Back to Table of Contents**](#table-of-contents)
|
1297
|
-
|
1298
|
-
---
|
1299
|
-
|
1300
|
-
|
1301
|
-
### `composio.metadata.toggle_trigger_state`<a id="composiometadatatoggle_trigger_state"></a>
|
1302
|
-
|
1303
|
-
Toggle trigger state
|
1304
|
-
|
1305
|
-
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
1306
|
-
|
1307
|
-
```ruby
|
1308
|
-
result = composio.metadata.toggle_trigger_state(
|
1309
|
-
enabled: true,
|
1310
|
-
)
|
1311
|
-
p result
|
1312
|
-
```
|
1313
|
-
|
1314
|
-
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
1315
|
-
|
1316
|
-
##### enabled: `Boolean`<a id="enabled-boolean"></a>
|
1317
|
-
Flag to enable or disable triggers
|
1318
|
-
|
1319
|
-
#### 🔄 Return<a id="🔄-return"></a>
|
1320
|
-
|
1321
|
-
[ToggleTriggerStateResponseDTO](./lib/composio/models/toggle_trigger_state_response_dto.rb)
|
1322
|
-
|
1323
|
-
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
1324
|
-
|
1325
|
-
`/api/v1/metadata/toggle/trigger` `POST`
|
1326
|
-
|
1327
|
-
[🔙 **Back to Table of Contents**](#table-of-contents)
|
1328
|
-
|
1329
|
-
---
|
1330
|
-
|
1331
|
-
|
1332
|
-
### `composio.team.get_member_list`<a id="composioteamget_member_list"></a>
|
1333
|
-
|
1334
|
-
List members
|
1335
|
-
|
1336
|
-
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
1337
|
-
|
1338
|
-
```ruby
|
1339
|
-
result = composio.team.get_member_list
|
1340
|
-
p result
|
1341
|
-
```
|
1342
|
-
|
1343
|
-
#### 🔄 Return<a id="🔄-return"></a>
|
1344
|
-
|
1345
|
-
[MemberResDTO](./lib/composio/models/member_res_dto.rb)
|
1346
|
-
|
1347
|
-
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
1348
|
-
|
1349
|
-
`/api/v1/team/members` `GET`
|
1350
|
-
|
1351
|
-
[🔙 **Back to Table of Contents**](#table-of-contents)
|
1352
|
-
|
1353
|
-
---
|
1354
|
-
|
1355
|
-
|
1356
|
-
### `composio.team.send_invitation`<a id="composioteamsend_invitation"></a>
|
1357
|
-
|
1358
|
-
Invite member
|
1359
|
-
|
1360
|
-
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
1361
|
-
|
1362
|
-
```ruby
|
1363
|
-
result = composio.team.send_invitation(
|
1364
|
-
email: "string_example",
|
1365
|
-
name: "string_example",
|
1366
|
-
verify_host: "string_example",
|
1367
|
-
)
|
1368
|
-
p result
|
1369
|
-
```
|
1370
|
-
|
1371
|
-
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
1372
|
-
|
1373
|
-
##### email: `String`<a id="email-string"></a>
|
1374
|
-
The email of the member
|
1375
|
-
|
1376
|
-
##### name: `String`<a id="name-string"></a>
|
1377
|
-
The name of the member
|
1378
|
-
|
1379
|
-
##### verifyHost: `String`<a id="verifyhost-string"></a>
|
1380
|
-
The host to verify the member
|
1381
|
-
|
1382
|
-
#### 🔄 Return<a id="🔄-return"></a>
|
1383
|
-
|
1384
|
-
[MemberResDTO](./lib/composio/models/member_res_dto.rb)
|
1385
|
-
|
1386
|
-
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
1387
|
-
|
1388
|
-
`/api/v1/team/invite` `POST`
|
1389
|
-
|
1390
|
-
[🔙 **Back to Table of Contents**](#table-of-contents)
|
1391
|
-
|
1392
|
-
---
|
1393
|
-
|
1394
|
-
|
1395
853
|
### `composio.triggers.delete_trigger_instance`<a id="composiotriggersdelete_trigger_instance"></a>
|
1396
854
|
|
1397
855
|
Deletes a specified trigger instance.
|
@@ -1526,35 +984,6 @@ p result
|
|
1526
984
|
---
|
1527
985
|
|
1528
986
|
|
1529
|
-
### `composio.triggers.get_by_id`<a id="composiotriggersget_by_id"></a>
|
1530
|
-
|
1531
|
-
Retrieves a specific trigger by its ID.
|
1532
|
-
|
1533
|
-
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
1534
|
-
|
1535
|
-
```ruby
|
1536
|
-
result = composio.triggers.get_by_id(
|
1537
|
-
trigger_id: "'+j>6",
|
1538
|
-
)
|
1539
|
-
p result
|
1540
|
-
```
|
1541
|
-
|
1542
|
-
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
1543
|
-
|
1544
|
-
##### trigger_id: `String`<a id="trigger_id-string"></a>
|
1545
|
-
#### 🔄 Return<a id="🔄-return"></a>
|
1546
|
-
|
1547
|
-
[GetTriggerResponseDTO](./lib/composio/models/get_trigger_response_dto.rb)
|
1548
|
-
|
1549
|
-
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
1550
|
-
|
1551
|
-
`/api/v1/triggers/get/{triggerId}` `GET`
|
1552
|
-
|
1553
|
-
[🔙 **Back to Table of Contents**](#table-of-contents)
|
1554
|
-
|
1555
|
-
---
|
1556
|
-
|
1557
|
-
|
1558
987
|
### `composio.triggers.get_callback_url`<a id="composiotriggersget_callback_url"></a>
|
1559
988
|
|
1560
989
|
Retrieves the universal callback URL set for the client.
|
@@ -1742,38 +1171,5 @@ The new enabled status of the trigger
|
|
1742
1171
|
---
|
1743
1172
|
|
1744
1173
|
|
1745
|
-
### `composio.triggers.switch_post_instance_status`<a id="composiotriggersswitch_post_instance_status"></a>
|
1746
|
-
|
1747
|
-
Switches the status of a trigger instance.
|
1748
|
-
|
1749
|
-
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
1750
|
-
|
1751
|
-
```ruby
|
1752
|
-
result = composio.triggers.switch_post_instance_status(
|
1753
|
-
enabled: true,
|
1754
|
-
trigger_id: "'+j>6",
|
1755
|
-
)
|
1756
|
-
p result
|
1757
|
-
```
|
1758
|
-
|
1759
|
-
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
1760
|
-
|
1761
|
-
##### enabled: `Boolean`<a id="enabled-boolean"></a>
|
1762
|
-
The new enabled status of the trigger
|
1763
|
-
|
1764
|
-
##### trigger_id: `String`<a id="trigger_id-string"></a>
|
1765
|
-
#### 🔄 Return<a id="🔄-return"></a>
|
1766
|
-
|
1767
|
-
[TriggerResponseDTO](./lib/composio/models/trigger_response_dto.rb)
|
1768
|
-
|
1769
|
-
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
1770
|
-
|
1771
|
-
`/api/v1/triggers/instance/{triggerId}/status` `POST`
|
1772
|
-
|
1773
|
-
[🔙 **Back to Table of Contents**](#table-of-contents)
|
1774
|
-
|
1775
|
-
---
|
1776
|
-
|
1777
|
-
|
1778
1174
|
## Author<a id="author"></a>
|
1779
1175
|
This TypeScript package is automatically generated by [Konfig](https://konfigthis.com)
|