composio 0.1.15 → 0.1.17
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Gemfile.lock +4 -4
- data/README.md +250 -202
- data/lib/composio/api/actions_api.rb +201 -6
- data/lib/composio/api/admin_api.rb +78 -0
- data/lib/composio/api/auth_api.rb +77 -0
- data/lib/composio/api/cli_api.rb +266 -0
- data/lib/composio/api/connections_api.rb +124 -6
- data/lib/composio/api/event_logs_api.rb +0 -318
- data/lib/composio/api/integrations_api.rb +8 -4
- data/lib/composio/api/logs_api.rb +19 -4
- data/lib/composio/api/triggers_api.rb +9 -2
- data/lib/composio/models/action_execution_req_dto.rb +31 -4
- data/lib/composio/models/action_get_nla_inputs_req_dto.rb +22 -4
- data/lib/composio/models/actions_query_dto.rb +22 -4
- data/lib/composio/models/app_query_dto.rb +1 -1
- data/lib/composio/models/client_dto.rb +374 -0
- data/lib/composio/models/client_dto_created_at.rb +102 -0
- data/lib/composio/models/client_dto_last_subscribed_at.rb +102 -0
- data/lib/composio/models/client_dto_updated_at.rb +102 -0
- data/lib/composio/models/client_info_res_dto.rb +235 -0
- data/lib/composio/models/connection_params.rb +15 -4
- data/lib/composio/models/connection_with_app_data.rb +15 -4
- data/lib/composio/models/create_connector_payload_dto.rb +12 -7
- data/lib/composio/models/expected_input_fields_dto.rb +346 -0
- data/lib/composio/models/get_connections_query_dto.rb +15 -4
- data/lib/composio/models/get_connector_info_res_dto.rb +1 -1
- data/lib/composio/models/get_logs_dto.rb +14 -4
- data/lib/composio/models/ingest_data_dto.rb +21 -1
- data/lib/composio/models/initiate_connection_payload_dto.rb +19 -18
- data/lib/composio/models/list_triggers_query_dto.rb +11 -1
- data/lib/composio/models/sdk_error_res_dto.rb +221 -0
- data/lib/composio/models/session_info_dto.rb +224 -0
- data/lib/composio/models/tools_execute_req_dto.rb +22 -4
- data/lib/composio/models/trigger_response_dto.rb +14 -4
- data/lib/composio/models/update_connection_labels_payload_dto.rb +222 -0
- data/lib/composio/version.rb +1 -1
- data/lib/composio.rb +12 -3
- data/spec/api/actions_api_spec.rb +25 -0
- data/spec/api/admin_api_spec.rb +11 -0
- data/spec/api/auth_api_spec.rb +11 -0
- data/spec/api/cli_api_spec.rb +63 -0
- data/spec/api/connections_api_spec.rb +14 -0
- data/spec/api/event_logs_api_spec.rb +0 -43
- data/spec/api/logs_api_spec.rb +1 -0
- data/spec/api/triggers_api_spec.rb +1 -0
- data/spec/models/action_execution_req_dto_spec.rb +18 -0
- data/spec/models/action_get_nla_inputs_req_dto_spec.rb +12 -0
- data/spec/models/actions_query_dto_spec.rb +12 -0
- data/spec/models/client_dto_created_at_spec.rb +25 -0
- data/spec/models/client_dto_last_subscribed_at_spec.rb +25 -0
- data/spec/models/client_dto_spec.rb +100 -0
- data/spec/models/client_dto_updated_at_spec.rb +25 -0
- data/spec/models/client_info_res_dto_spec.rb +34 -0
- data/spec/models/connection_params_spec.rb +6 -0
- data/spec/models/connection_with_app_data_spec.rb +6 -0
- data/spec/models/create_connector_payload_dto_spec.rb +6 -0
- data/spec/models/expected_input_fields_dto_spec.rb +82 -0
- data/spec/models/get_connections_query_dto_spec.rb +6 -0
- data/spec/models/get_logs_dto_spec.rb +6 -0
- data/spec/models/ingest_data_dto_spec.rb +12 -0
- data/spec/models/initiate_connection_payload_dto_spec.rb +6 -0
- data/spec/models/list_triggers_query_dto_spec.rb +6 -0
- data/spec/models/sdk_error_res_dto_spec.rb +28 -0
- data/spec/models/session_info_dto_spec.rb +34 -0
- data/spec/models/tools_execute_req_dto_spec.rb +12 -0
- data/spec/models/trigger_response_dto_spec.rb +6 -0
- data/spec/models/update_connection_labels_payload_dto_spec.rb +28 -0
- metadata +32 -4
- data/spec/api/payment_api_spec.rb +0 -83
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
|
-
[](https://rubygems.org/gems/composio/versions/0.1.17)
|
10
10
|
[](https://composio.dev)
|
11
11
|
|
12
12
|
</div>
|
@@ -27,6 +27,8 @@ Composio SDK: Equip your agent with high-quality tools and build your real-world
|
|
27
27
|
* [`composio.actions.get_action_by_id`](#composioactionsget_action_by_id)
|
28
28
|
* [`composio.actions.get_action_inputs`](#composioactionsget_action_inputs)
|
29
29
|
* [`composio.actions.get_all_actions_based_on_query`](#composioactionsget_all_actions_based_on_query)
|
30
|
+
* [`composio.actions.list`](#composioactionslist)
|
31
|
+
* [`composio.admin.clear_cache`](#composioadminclear_cache)
|
30
32
|
* [`composio.admin.get_sentry_dns`](#composioadminget_sentry_dns)
|
31
33
|
* [`composio.analytics.get`](#composioanalyticsget)
|
32
34
|
* [`composio.analytics.get_top_entities`](#composioanalyticsget_top_entities)
|
@@ -36,7 +38,11 @@ Composio SDK: Equip your agent with high-quality tools and build your real-world
|
|
36
38
|
* [`composio.apps.list`](#composioappslist)
|
37
39
|
* [`composio.apps.list_open_api_specs`](#composioappslist_open_api_specs)
|
38
40
|
* [`composio.apps.send_email_to_client`](#composioappssend_email_to_client)
|
41
|
+
* [`composio.auth.get_user_info`](#composioauthget_user_info)
|
39
42
|
* [`composio.auth.identify_client_operation`](#composioauthidentify_client_operation)
|
43
|
+
* [`composio.cli.exchange_code`](#composiocliexchange_code)
|
44
|
+
* [`composio.cli.get_code`](#composiocliget_code)
|
45
|
+
* [`composio.cli.verify_code`](#composiocliverify_code)
|
40
46
|
* [`composio.connections.delete`](#composioconnectionsdelete)
|
41
47
|
* [`composio.connections.disable`](#composioconnectionsdisable)
|
42
48
|
* [`composio.connections.enable`](#composioconnectionsenable)
|
@@ -44,10 +50,7 @@ Composio SDK: Equip your agent with high-quality tools and build your real-world
|
|
44
50
|
* [`composio.connections.get_info`](#composioconnectionsget_info)
|
45
51
|
* [`composio.connections.initiate`](#composioconnectionsinitiate)
|
46
52
|
* [`composio.connections.list`](#composioconnectionslist)
|
47
|
-
* [`composio.
|
48
|
-
* [`composio.event_logs.get_webhook`](#composioevent_logsget_webhook)
|
49
|
-
* [`composio.event_logs.get_webhook_secret`](#composioevent_logsget_webhook_secret)
|
50
|
-
* [`composio.event_logs.refresh_webhook_secret`](#composioevent_logsrefresh_webhook_secret)
|
53
|
+
* [`composio.connections.update_connection_data`](#composioconnectionsupdate_connection_data)
|
51
54
|
* [`composio.event_logs.update_webhook`](#composioevent_logsupdate_webhook)
|
52
55
|
* [`composio.integrations.create_integration`](#composiointegrationscreate_integration)
|
53
56
|
* [`composio.integrations.delete_connector`](#composiointegrationsdelete_connector)
|
@@ -56,11 +59,6 @@ Composio SDK: Equip your agent with high-quality tools and build your real-world
|
|
56
59
|
* [`composio.integrations.update_integration`](#composiointegrationsupdate_integration)
|
57
60
|
* [`composio.logs.add_new_logs`](#composiologsadd_new_logs)
|
58
61
|
* [`composio.logs.list`](#composiologslist)
|
59
|
-
* [`composio.payment.create_checkout_session`](#composiopaymentcreate_checkout_session)
|
60
|
-
* [`composio.payment.get_checkout_session_status`](#composiopaymentget_checkout_session_status)
|
61
|
-
* [`composio.payment.get_invoice`](#composiopaymentget_invoice)
|
62
|
-
* [`composio.payment.get_invoices`](#composiopaymentget_invoices)
|
63
|
-
* [`composio.payment.handle_stripe_webhook`](#composiopaymenthandle_stripe_webhook)
|
64
62
|
* [`composio.triggers.delete_trigger_instance`](#composiotriggersdelete_trigger_instance)
|
65
63
|
* [`composio.triggers.disable_trigger_instance`](#composiotriggersdisable_trigger_instance)
|
66
64
|
* [`composio.triggers.enable`](#composiotriggersenable)
|
@@ -79,7 +77,7 @@ Composio SDK: Equip your agent with high-quality tools and build your real-world
|
|
79
77
|
Add to Gemfile:
|
80
78
|
|
81
79
|
```ruby
|
82
|
-
gem 'composio', '~> 0.1.
|
80
|
+
gem 'composio', '~> 0.1.17'
|
83
81
|
```
|
84
82
|
|
85
83
|
## Getting Started<a id="getting-started"></a>
|
@@ -210,6 +208,8 @@ result = composio.actions.execute(
|
|
210
208
|
entity_id: "string_example",
|
211
209
|
endpoint: "string_example",
|
212
210
|
input: {},
|
211
|
+
session_info: {
|
212
|
+
},
|
213
213
|
auth_config: {
|
214
214
|
"parameters" => [
|
215
215
|
{
|
@@ -220,6 +220,8 @@ result = composio.actions.execute(
|
|
220
220
|
],
|
221
221
|
},
|
222
222
|
text: "string_example",
|
223
|
+
custom_description: "string_example",
|
224
|
+
system_prompt: "string_example",
|
223
225
|
)
|
224
226
|
p result
|
225
227
|
```
|
@@ -232,8 +234,11 @@ p result
|
|
232
234
|
##### entityId: `String`<a id="entityid-string"></a>
|
233
235
|
##### endpoint: `String`<a id="endpoint-string"></a>
|
234
236
|
##### input: `Object`<a id="input-object"></a>
|
237
|
+
##### sessionInfo: [`SessionInfoDTO`](./lib/composio/models/session_info_dto.rb)<a id="sessioninfo-sessioninfodtolibcomposiomodelssession_info_dtorb"></a>
|
235
238
|
##### authConfig: [`CustomAuthDTO`](./lib/composio/models/custom_auth_dto.rb)<a id="authconfig-customauthdtolibcomposiomodelscustom_auth_dtorb"></a>
|
236
239
|
##### text: `String`<a id="text-string"></a>
|
240
|
+
##### customDescription: `String`<a id="customdescription-string"></a>
|
241
|
+
##### systemPrompt: `String`<a id="systemprompt-string"></a>
|
237
242
|
#### 🔄 Return<a id="🔄-return"></a>
|
238
243
|
|
239
244
|
[ActionExecutionResDto](./lib/composio/models/action_execution_res_dto.rb)
|
@@ -317,6 +322,8 @@ Get the inputs for an action with NLA
|
|
317
322
|
result = composio.actions.get_action_inputs(
|
318
323
|
text: "string_example",
|
319
324
|
action_id: "'+j>6",
|
325
|
+
custom_description: "string_example",
|
326
|
+
system_prompt: "string_example",
|
320
327
|
)
|
321
328
|
p result
|
322
329
|
```
|
@@ -325,6 +332,8 @@ p result
|
|
325
332
|
|
326
333
|
##### text: `String`<a id="text-string"></a>
|
327
334
|
##### action_id: `String`<a id="action_id-string"></a>
|
335
|
+
##### customDescription: `String`<a id="customdescription-string"></a>
|
336
|
+
##### systemPrompt: `String`<a id="systemprompt-string"></a>
|
328
337
|
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
329
338
|
|
330
339
|
`/api/v2/actions/{actionId}/execute/get.inputs` `POST`
|
@@ -352,6 +361,8 @@ result = composio.actions.get_all_actions_based_on_query(
|
|
352
361
|
usecase_limit: 3.14,
|
353
362
|
filter_important_actions: true,
|
354
363
|
show_all: true,
|
364
|
+
page: 3.14,
|
365
|
+
offset: 3.14,
|
355
366
|
)
|
356
367
|
p result
|
357
368
|
```
|
@@ -368,6 +379,8 @@ p result
|
|
368
379
|
##### usecase_limit: `Float`<a id="usecase_limit-float"></a>
|
369
380
|
##### filter_important_actions: `Boolean`<a id="filter_important_actions-boolean"></a>
|
370
381
|
##### show_all: `Boolean`<a id="show_all-boolean"></a>
|
382
|
+
##### page: `Float`<a id="page-float"></a>
|
383
|
+
##### offset: `Float`<a id="offset-float"></a>
|
371
384
|
#### 🔄 Return<a id="🔄-return"></a>
|
372
385
|
|
373
386
|
[ActionsListResponseDTO](./lib/composio/models/actions_list_response_dto.rb)
|
@@ -381,6 +394,82 @@ p result
|
|
381
394
|
---
|
382
395
|
|
383
396
|
|
397
|
+
### `composio.actions.list`<a id="composioactionslist"></a>
|
398
|
+
|
399
|
+
Retrieve a list of all actions based on query parameters.
|
400
|
+
|
401
|
+
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
402
|
+
|
403
|
+
```ruby
|
404
|
+
result = composio.actions.list(
|
405
|
+
app_names: "string_example",
|
406
|
+
use_case: "string_example",
|
407
|
+
show_enabled_only: true,
|
408
|
+
limit: 3.14,
|
409
|
+
apps: "string_example",
|
410
|
+
actions: "string_example",
|
411
|
+
tags: "string_example",
|
412
|
+
usecase_limit: 3.14,
|
413
|
+
filter_important_actions: true,
|
414
|
+
show_all: true,
|
415
|
+
page: 3.14,
|
416
|
+
offset: 3.14,
|
417
|
+
)
|
418
|
+
p result
|
419
|
+
```
|
420
|
+
|
421
|
+
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
422
|
+
|
423
|
+
##### app_names: `String`<a id="app_names-string"></a>
|
424
|
+
##### use_case: `String`<a id="use_case-string"></a>
|
425
|
+
##### show_enabled_only: `Boolean`<a id="show_enabled_only-boolean"></a>
|
426
|
+
##### limit: `Float`<a id="limit-float"></a>
|
427
|
+
##### apps: `String`<a id="apps-string"></a>
|
428
|
+
##### actions: `String`<a id="actions-string"></a>
|
429
|
+
##### tags: `String`<a id="tags-string"></a>
|
430
|
+
##### usecase_limit: `Float`<a id="usecase_limit-float"></a>
|
431
|
+
##### filter_important_actions: `Boolean`<a id="filter_important_actions-boolean"></a>
|
432
|
+
##### show_all: `Boolean`<a id="show_all-boolean"></a>
|
433
|
+
##### page: `Float`<a id="page-float"></a>
|
434
|
+
##### offset: `Float`<a id="offset-float"></a>
|
435
|
+
#### 🔄 Return<a id="🔄-return"></a>
|
436
|
+
|
437
|
+
[ActionsListResponseDTO](./lib/composio/models/actions_list_response_dto.rb)
|
438
|
+
|
439
|
+
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
440
|
+
|
441
|
+
`/api/v2/actions` `GET`
|
442
|
+
|
443
|
+
[🔙 **Back to Table of Contents**](#table-of-contents)
|
444
|
+
|
445
|
+
---
|
446
|
+
|
447
|
+
|
448
|
+
### `composio.admin.clear_cache`<a id="composioadminclear_cache"></a>
|
449
|
+
|
450
|
+
Clear cache
|
451
|
+
|
452
|
+
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
453
|
+
|
454
|
+
```ruby
|
455
|
+
result = composio.admin.clear_cache(
|
456
|
+
x_admin_token: "string_example",
|
457
|
+
)
|
458
|
+
p result
|
459
|
+
```
|
460
|
+
|
461
|
+
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
462
|
+
|
463
|
+
##### x_admin_token: `String`<a id="x_admin_token-string"></a>
|
464
|
+
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
465
|
+
|
466
|
+
`/api/v1/clear-cache` `POST`
|
467
|
+
|
468
|
+
[🔙 **Back to Table of Contents**](#table-of-contents)
|
469
|
+
|
470
|
+
---
|
471
|
+
|
472
|
+
|
384
473
|
### `composio.admin.get_sentry_dns`<a id="composioadminget_sentry_dns"></a>
|
385
474
|
|
386
475
|
Jssentry dns
|
@@ -621,6 +710,30 @@ p result
|
|
621
710
|
---
|
622
711
|
|
623
712
|
|
713
|
+
### `composio.auth.get_user_info`<a id="composioauthget_user_info"></a>
|
714
|
+
|
715
|
+
Get client info
|
716
|
+
|
717
|
+
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
718
|
+
|
719
|
+
```ruby
|
720
|
+
result = composio.auth.get_user_info
|
721
|
+
p result
|
722
|
+
```
|
723
|
+
|
724
|
+
#### 🔄 Return<a id="🔄-return"></a>
|
725
|
+
|
726
|
+
[ClientInfoResDTO](./lib/composio/models/client_info_res_dto.rb)
|
727
|
+
|
728
|
+
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
729
|
+
|
730
|
+
`/api/v1/client/auth/client_info` `GET`
|
731
|
+
|
732
|
+
[🔙 **Back to Table of Contents**](#table-of-contents)
|
733
|
+
|
734
|
+
---
|
735
|
+
|
736
|
+
|
624
737
|
### `composio.auth.identify_client_operation`<a id="composioauthidentify_client_operation"></a>
|
625
738
|
|
626
739
|
Identify client
|
@@ -656,6 +769,92 @@ The framework used by the client
|
|
656
769
|
---
|
657
770
|
|
658
771
|
|
772
|
+
### `composio.cli.exchange_code`<a id="composiocliexchange_code"></a>
|
773
|
+
|
774
|
+
Handle cli code exchange
|
775
|
+
|
776
|
+
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
777
|
+
|
778
|
+
```ruby
|
779
|
+
result = composio.cli.exchange_code
|
780
|
+
p result
|
781
|
+
```
|
782
|
+
|
783
|
+
#### 🔄 Return<a id="🔄-return"></a>
|
784
|
+
|
785
|
+
[GenerateCLISessionResDTO](./lib/composio/models/generate_cli_session_res_dto.rb)
|
786
|
+
|
787
|
+
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
788
|
+
|
789
|
+
`/api/v1/cli/generate-cli-session` `GET`
|
790
|
+
|
791
|
+
[🔙 **Back to Table of Contents**](#table-of-contents)
|
792
|
+
|
793
|
+
---
|
794
|
+
|
795
|
+
|
796
|
+
### `composio.cli.get_code`<a id="composiocliget_code"></a>
|
797
|
+
|
798
|
+
Get cli code
|
799
|
+
|
800
|
+
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
801
|
+
|
802
|
+
```ruby
|
803
|
+
result = composio.cli.get_code(
|
804
|
+
key: "key_example",
|
805
|
+
code: "string_example",
|
806
|
+
)
|
807
|
+
p result
|
808
|
+
```
|
809
|
+
|
810
|
+
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
811
|
+
|
812
|
+
##### key: `String`<a id="key-string"></a>
|
813
|
+
##### code: `String`<a id="code-string"></a>
|
814
|
+
#### 🔄 Return<a id="🔄-return"></a>
|
815
|
+
|
816
|
+
[GetCLISessionResDTO](./lib/composio/models/get_cli_session_res_dto.rb)
|
817
|
+
|
818
|
+
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
819
|
+
|
820
|
+
`/api/v1/cli/get-cli-code` `GET`
|
821
|
+
|
822
|
+
[🔙 **Back to Table of Contents**](#table-of-contents)
|
823
|
+
|
824
|
+
---
|
825
|
+
|
826
|
+
|
827
|
+
### `composio.cli.verify_code`<a id="composiocliverify_code"></a>
|
828
|
+
|
829
|
+
Handle cli code verification
|
830
|
+
|
831
|
+
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
832
|
+
|
833
|
+
```ruby
|
834
|
+
result = composio.cli.verify_code(
|
835
|
+
key: "key_example",
|
836
|
+
code: "string_example",
|
837
|
+
)
|
838
|
+
p result
|
839
|
+
```
|
840
|
+
|
841
|
+
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
842
|
+
|
843
|
+
##### key: `String`<a id="key-string"></a>
|
844
|
+
##### code: `String`<a id="code-string"></a>
|
845
|
+
#### 🔄 Return<a id="🔄-return"></a>
|
846
|
+
|
847
|
+
[VerifyCLICodeResDTO](./lib/composio/models/verify_cli_code_res_dto.rb)
|
848
|
+
|
849
|
+
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
850
|
+
|
851
|
+
`/api/v1/cli/verify-cli-code` `GET`
|
852
|
+
|
853
|
+
[🔙 **Back to Table of Contents**](#table-of-contents)
|
854
|
+
|
855
|
+
---
|
856
|
+
|
857
|
+
|
659
858
|
### `composio.connections.delete`<a id="composioconnectionsdelete"></a>
|
660
859
|
|
661
860
|
Delete a connection
|
@@ -809,22 +1008,26 @@ Initiate connection
|
|
809
1008
|
|
810
1009
|
```ruby
|
811
1010
|
result = composio.connections.initiate(
|
1011
|
+
data: {},
|
812
1012
|
integration_id: "a",
|
813
|
-
data: "a",
|
814
1013
|
redirect_uri: "string_example",
|
815
1014
|
user_uuid: "string_example",
|
816
1015
|
entity_id: "string_example",
|
1016
|
+
labels: [
|
1017
|
+
"string_example"
|
1018
|
+
],
|
817
1019
|
)
|
818
1020
|
p result
|
819
1021
|
```
|
820
1022
|
|
821
1023
|
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
822
1024
|
|
1025
|
+
##### data: `Object`<a id="data-object"></a>
|
823
1026
|
##### integrationId: `String`<a id="integrationid-string"></a>
|
824
|
-
##### data: `String`<a id="data-string"></a>
|
825
1027
|
##### redirectUri: `String`<a id="redirecturi-string"></a>
|
826
1028
|
##### userUuid: `String`<a id="useruuid-string"></a>
|
827
1029
|
##### entityId: `String`<a id="entityid-string"></a>
|
1030
|
+
##### labels: Array<`String`><a id="labels-array"></a>
|
828
1031
|
#### 🔄 Return<a id="🔄-return"></a>
|
829
1032
|
|
830
1033
|
[InitiateConnectionResponse](./lib/composio/models/initiate_connection_response.rb)
|
@@ -855,6 +1058,9 @@ result = composio.connections.list(
|
|
855
1058
|
show_active_only: true,
|
856
1059
|
status: "string_example",
|
857
1060
|
show_disabled: true,
|
1061
|
+
labels: [
|
1062
|
+
"string_example"
|
1063
|
+
],
|
858
1064
|
)
|
859
1065
|
p result
|
860
1066
|
```
|
@@ -870,6 +1076,7 @@ p result
|
|
870
1076
|
##### show_active_only: `Boolean`<a id="show_active_only-boolean"></a>
|
871
1077
|
##### status: `String`<a id="status-string"></a>
|
872
1078
|
##### show_disabled: `Boolean`<a id="show_disabled-boolean"></a>
|
1079
|
+
##### labels: Array<`String`><a id="labels-array"></a>
|
873
1080
|
#### 🔄 Return<a id="🔄-return"></a>
|
874
1081
|
|
875
1082
|
[GetConnectionsResponseDto](./lib/composio/models/get_connections_response_dto.rb)
|
@@ -883,87 +1090,29 @@ p result
|
|
883
1090
|
---
|
884
1091
|
|
885
1092
|
|
886
|
-
### `composio.
|
1093
|
+
### `composio.connections.update_connection_data`<a id="composioconnectionsupdate_connection_data"></a>
|
887
1094
|
|
888
|
-
|
1095
|
+
Update connection data
|
889
1096
|
|
890
1097
|
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
891
1098
|
|
892
1099
|
```ruby
|
893
|
-
result = composio.
|
894
|
-
|
895
|
-
|
1100
|
+
result = composio.connections.update_connection_data(
|
1101
|
+
labels: [
|
1102
|
+
"string_example"
|
1103
|
+
],
|
1104
|
+
connected_account_id: "'+j>6",
|
896
1105
|
)
|
897
1106
|
p result
|
898
1107
|
```
|
899
1108
|
|
900
1109
|
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
901
1110
|
|
902
|
-
#####
|
903
|
-
#####
|
904
|
-
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
905
|
-
|
906
|
-
`/api/v1/event_logs/get/events` `GET`
|
907
|
-
|
908
|
-
[🔙 **Back to Table of Contents**](#table-of-contents)
|
909
|
-
|
910
|
-
---
|
911
|
-
|
912
|
-
|
913
|
-
### `composio.event_logs.get_webhook`<a id="composioevent_logsget_webhook"></a>
|
914
|
-
|
915
|
-
Get webhook
|
916
|
-
|
917
|
-
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
918
|
-
|
919
|
-
```ruby
|
920
|
-
result = composio.event_logs.get_webhook
|
921
|
-
p result
|
922
|
-
```
|
923
|
-
|
924
|
-
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
925
|
-
|
926
|
-
`/api/v1/event_logs/get/webhook` `GET`
|
927
|
-
|
928
|
-
[🔙 **Back to Table of Contents**](#table-of-contents)
|
929
|
-
|
930
|
-
---
|
931
|
-
|
932
|
-
|
933
|
-
### `composio.event_logs.get_webhook_secret`<a id="composioevent_logsget_webhook_secret"></a>
|
934
|
-
|
935
|
-
Get webhook secret
|
936
|
-
|
937
|
-
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
938
|
-
|
939
|
-
```ruby
|
940
|
-
result = composio.event_logs.get_webhook_secret
|
941
|
-
p result
|
942
|
-
```
|
943
|
-
|
944
|
-
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
945
|
-
|
946
|
-
`/api/v1/event_logs/webhook/secret/get` `GET`
|
947
|
-
|
948
|
-
[🔙 **Back to Table of Contents**](#table-of-contents)
|
949
|
-
|
950
|
-
---
|
951
|
-
|
952
|
-
|
953
|
-
### `composio.event_logs.refresh_webhook_secret`<a id="composioevent_logsrefresh_webhook_secret"></a>
|
954
|
-
|
955
|
-
Refresh webhook
|
956
|
-
|
957
|
-
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
958
|
-
|
959
|
-
```ruby
|
960
|
-
result = composio.event_logs.refresh_webhook_secret
|
961
|
-
p result
|
962
|
-
```
|
963
|
-
|
1111
|
+
##### labels: Array<`String`><a id="labels-array"></a>
|
1112
|
+
##### connected_account_id: `String`<a id="connected_account_id-string"></a>
|
964
1113
|
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
965
1114
|
|
966
|
-
`/api/v1/
|
1115
|
+
`/api/v1/connectedAccounts/{connectedAccountId}/data` `PATCH`
|
967
1116
|
|
968
1117
|
[🔙 **Back to Table of Contents**](#table-of-contents)
|
969
1118
|
|
@@ -1006,11 +1155,12 @@ Create a new connector
|
|
1006
1155
|
```ruby
|
1007
1156
|
result = composio.integrations.create_integration(
|
1008
1157
|
name: "string_example",
|
1009
|
-
app_id: "string_example",
|
1010
1158
|
auth_scheme: "string_example",
|
1011
1159
|
auth_config: {
|
1012
1160
|
},
|
1013
1161
|
use_composio_auth: true,
|
1162
|
+
app_id: "string_example",
|
1163
|
+
app_name: "string_example",
|
1014
1164
|
force_new_integration: true,
|
1015
1165
|
)
|
1016
1166
|
p result
|
@@ -1021,14 +1171,17 @@ p result
|
|
1021
1171
|
##### name: `String`<a id="name-string"></a>
|
1022
1172
|
Name of the connector
|
1023
1173
|
|
1024
|
-
##### appId: `String`<a id="appid-string"></a>
|
1025
|
-
Application ID
|
1026
|
-
|
1027
1174
|
##### authScheme: `String`<a id="authscheme-string"></a>
|
1028
1175
|
Authentication scheme
|
1029
1176
|
|
1030
1177
|
##### authConfig: [`AuthConfigDTO`](./lib/composio/models/auth_config_dto.rb)<a id="authconfig-authconfigdtolibcomposiomodelsauth_config_dtorb"></a>
|
1031
1178
|
##### useComposioAuth: [`CreateConnectorPayloadDTOUseComposioAuth`](./lib/composio/models/create_connector_payload_dto_use_composio_auth.rb)<a id="usecomposioauth-createconnectorpayloaddtousecomposioauthlibcomposiomodelscreate_connector_payload_dto_use_composio_authrb"></a>
|
1179
|
+
##### appId: `String`<a id="appid-string"></a>
|
1180
|
+
Composio App UUID to be used for authentication. Either specify this or appName
|
1181
|
+
|
1182
|
+
##### appName: `String`<a id="appname-string"></a>
|
1183
|
+
Name of the app to be used for authentication. Either specify this or appId
|
1184
|
+
|
1032
1185
|
##### forceNewIntegration: `Boolean`<a id="forcenewintegration-boolean"></a>
|
1033
1186
|
Flag to force new integration
|
1034
1187
|
|
@@ -1178,6 +1331,8 @@ result = composio.logs.add_new_logs(
|
|
1178
1331
|
response: {},
|
1179
1332
|
is_error: true,
|
1180
1333
|
connection_id: "string_example",
|
1334
|
+
session_id: "string_example",
|
1335
|
+
logs_type: "string_example",
|
1181
1336
|
entity_id: "string_example",
|
1182
1337
|
)
|
1183
1338
|
p result
|
@@ -1197,6 +1352,12 @@ Action name of the log
|
|
1197
1352
|
##### connectionId: `String`<a id="connectionid-string"></a>
|
1198
1353
|
Connection ID of the log
|
1199
1354
|
|
1355
|
+
##### sessionId: `String`<a id="sessionid-string"></a>
|
1356
|
+
Session ID of the log
|
1357
|
+
|
1358
|
+
##### logsType: `String`<a id="logstype-string"></a>
|
1359
|
+
Type of the log
|
1360
|
+
|
1200
1361
|
##### entityId: `String`<a id="entityid-string"></a>
|
1201
1362
|
Entity ID of the log
|
1202
1363
|
|
@@ -1230,6 +1391,7 @@ result = composio.logs.list(
|
|
1230
1391
|
limit: 10,
|
1231
1392
|
cursor: "string_example",
|
1232
1393
|
logs_type: "string_example",
|
1394
|
+
session_id: "string_example",
|
1233
1395
|
)
|
1234
1396
|
p result
|
1235
1397
|
```
|
@@ -1245,6 +1407,7 @@ p result
|
|
1245
1407
|
##### limit: `Float`<a id="limit-float"></a>
|
1246
1408
|
##### cursor: `String`<a id="cursor-string"></a>
|
1247
1409
|
##### logs_type: `String`<a id="logs_type-string"></a>
|
1410
|
+
##### session_id: `String`<a id="session_id-string"></a>
|
1248
1411
|
#### 🔄 Return<a id="🔄-return"></a>
|
1249
1412
|
|
1250
1413
|
[LogsResDTO](./lib/composio/models/logs_res_dto.rb)
|
@@ -1258,123 +1421,6 @@ p result
|
|
1258
1421
|
---
|
1259
1422
|
|
1260
1423
|
|
1261
|
-
### `composio.payment.create_checkout_session`<a id="composiopaymentcreate_checkout_session"></a>
|
1262
|
-
|
1263
|
-
Create checkout session
|
1264
|
-
|
1265
|
-
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
1266
|
-
|
1267
|
-
```ruby
|
1268
|
-
result = composio.payment.create_checkout_session(
|
1269
|
-
plan: "HOBBY",
|
1270
|
-
)
|
1271
|
-
p result
|
1272
|
-
```
|
1273
|
-
|
1274
|
-
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
1275
|
-
|
1276
|
-
##### plan: [`Plan`](./lib/composio/models/plan.rb)<a id="plan-planlibcomposiomodelsplanrb"></a>
|
1277
|
-
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
1278
|
-
|
1279
|
-
`/api/v1/payment/create-checkout-session` `POST`
|
1280
|
-
|
1281
|
-
[🔙 **Back to Table of Contents**](#table-of-contents)
|
1282
|
-
|
1283
|
-
---
|
1284
|
-
|
1285
|
-
|
1286
|
-
### `composio.payment.get_checkout_session_status`<a id="composiopaymentget_checkout_session_status"></a>
|
1287
|
-
|
1288
|
-
Get checkout session status
|
1289
|
-
|
1290
|
-
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
1291
|
-
|
1292
|
-
```ruby
|
1293
|
-
result = composio.payment.get_checkout_session_status(
|
1294
|
-
session_id: "'+j>6",
|
1295
|
-
)
|
1296
|
-
p result
|
1297
|
-
```
|
1298
|
-
|
1299
|
-
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
1300
|
-
|
1301
|
-
##### session_id: `String`<a id="session_id-string"></a>
|
1302
|
-
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
1303
|
-
|
1304
|
-
`/api/v1/payment/checkout-session/{sessionId}/status` `GET`
|
1305
|
-
|
1306
|
-
[🔙 **Back to Table of Contents**](#table-of-contents)
|
1307
|
-
|
1308
|
-
---
|
1309
|
-
|
1310
|
-
|
1311
|
-
### `composio.payment.get_invoice`<a id="composiopaymentget_invoice"></a>
|
1312
|
-
|
1313
|
-
Get invoice
|
1314
|
-
|
1315
|
-
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
1316
|
-
|
1317
|
-
```ruby
|
1318
|
-
result = composio.payment.get_invoice(
|
1319
|
-
invoice_id: "'+j>6",
|
1320
|
-
)
|
1321
|
-
p result
|
1322
|
-
```
|
1323
|
-
|
1324
|
-
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
1325
|
-
|
1326
|
-
##### invoice_id: `String`<a id="invoice_id-string"></a>
|
1327
|
-
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
1328
|
-
|
1329
|
-
`/api/v1/payment/invoices/{invoiceId}` `GET`
|
1330
|
-
|
1331
|
-
[🔙 **Back to Table of Contents**](#table-of-contents)
|
1332
|
-
|
1333
|
-
---
|
1334
|
-
|
1335
|
-
|
1336
|
-
### `composio.payment.get_invoices`<a id="composiopaymentget_invoices"></a>
|
1337
|
-
|
1338
|
-
Get invoices
|
1339
|
-
|
1340
|
-
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
1341
|
-
|
1342
|
-
```ruby
|
1343
|
-
result = composio.payment.get_invoices
|
1344
|
-
p result
|
1345
|
-
```
|
1346
|
-
|
1347
|
-
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
1348
|
-
|
1349
|
-
`/api/v1/payment/invoices` `GET`
|
1350
|
-
|
1351
|
-
[🔙 **Back to Table of Contents**](#table-of-contents)
|
1352
|
-
|
1353
|
-
---
|
1354
|
-
|
1355
|
-
|
1356
|
-
### `composio.payment.handle_stripe_webhook`<a id="composiopaymenthandle_stripe_webhook"></a>
|
1357
|
-
|
1358
|
-
Handle stripe webhook
|
1359
|
-
|
1360
|
-
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
1361
|
-
|
1362
|
-
```ruby
|
1363
|
-
result = composio.payment.handle_stripe_webhook(
|
1364
|
-
body: None,
|
1365
|
-
)
|
1366
|
-
p result
|
1367
|
-
```
|
1368
|
-
|
1369
|
-
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
1370
|
-
|
1371
|
-
`/api/v1/payment/webhook` `POST`
|
1372
|
-
|
1373
|
-
[🔙 **Back to Table of Contents**](#table-of-contents)
|
1374
|
-
|
1375
|
-
---
|
1376
|
-
|
1377
|
-
|
1378
1424
|
### `composio.triggers.delete_trigger_instance`<a id="composiotriggersdelete_trigger_instance"></a>
|
1379
1425
|
|
1380
1426
|
Deletes a specified trigger instance.
|
@@ -1612,6 +1658,7 @@ result = composio.triggers.list(
|
|
1612
1658
|
app_names: "string_example",
|
1613
1659
|
connected_account_ids: "string_example",
|
1614
1660
|
trigger_ids: "string_example",
|
1661
|
+
integration_ids: "string_example",
|
1615
1662
|
show_enabled_only: true,
|
1616
1663
|
)
|
1617
1664
|
p result
|
@@ -1622,6 +1669,7 @@ p result
|
|
1622
1669
|
##### app_names: `String`<a id="app_names-string"></a>
|
1623
1670
|
##### connected_account_ids: `String`<a id="connected_account_ids-string"></a>
|
1624
1671
|
##### trigger_ids: `String`<a id="trigger_ids-string"></a>
|
1672
|
+
##### integration_ids: `String`<a id="integration_ids-string"></a>
|
1625
1673
|
##### show_enabled_only: `Boolean`<a id="show_enabled_only-boolean"></a>
|
1626
1674
|
#### 🔄 Return<a id="🔄-return"></a>
|
1627
1675
|
|