composio 0.1.14 → 0.1.16
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 +248 -202
- data/lib/composio/api/actions_api.rb +191 -4
- 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 +128 -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/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 +28 -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/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 +12 -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.16)
|
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.16'
|
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)
|
@@ -352,6 +357,8 @@ result = composio.actions.get_all_actions_based_on_query(
|
|
352
357
|
usecase_limit: 3.14,
|
353
358
|
filter_important_actions: true,
|
354
359
|
show_all: true,
|
360
|
+
page: 3.14,
|
361
|
+
offset: 3.14,
|
355
362
|
)
|
356
363
|
p result
|
357
364
|
```
|
@@ -368,6 +375,8 @@ p result
|
|
368
375
|
##### usecase_limit: `Float`<a id="usecase_limit-float"></a>
|
369
376
|
##### filter_important_actions: `Boolean`<a id="filter_important_actions-boolean"></a>
|
370
377
|
##### show_all: `Boolean`<a id="show_all-boolean"></a>
|
378
|
+
##### page: `Float`<a id="page-float"></a>
|
379
|
+
##### offset: `Float`<a id="offset-float"></a>
|
371
380
|
#### 🔄 Return<a id="🔄-return"></a>
|
372
381
|
|
373
382
|
[ActionsListResponseDTO](./lib/composio/models/actions_list_response_dto.rb)
|
@@ -381,6 +390,82 @@ p result
|
|
381
390
|
---
|
382
391
|
|
383
392
|
|
393
|
+
### `composio.actions.list`<a id="composioactionslist"></a>
|
394
|
+
|
395
|
+
Retrieve a list of all actions based on query parameters.
|
396
|
+
|
397
|
+
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
398
|
+
|
399
|
+
```ruby
|
400
|
+
result = composio.actions.list(
|
401
|
+
app_names: "string_example",
|
402
|
+
use_case: "string_example",
|
403
|
+
show_enabled_only: true,
|
404
|
+
limit: 3.14,
|
405
|
+
apps: "string_example",
|
406
|
+
actions: "string_example",
|
407
|
+
tags: "string_example",
|
408
|
+
usecase_limit: 3.14,
|
409
|
+
filter_important_actions: true,
|
410
|
+
show_all: true,
|
411
|
+
page: 3.14,
|
412
|
+
offset: 3.14,
|
413
|
+
)
|
414
|
+
p result
|
415
|
+
```
|
416
|
+
|
417
|
+
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
418
|
+
|
419
|
+
##### app_names: `String`<a id="app_names-string"></a>
|
420
|
+
##### use_case: `String`<a id="use_case-string"></a>
|
421
|
+
##### show_enabled_only: `Boolean`<a id="show_enabled_only-boolean"></a>
|
422
|
+
##### limit: `Float`<a id="limit-float"></a>
|
423
|
+
##### apps: `String`<a id="apps-string"></a>
|
424
|
+
##### actions: `String`<a id="actions-string"></a>
|
425
|
+
##### tags: `String`<a id="tags-string"></a>
|
426
|
+
##### usecase_limit: `Float`<a id="usecase_limit-float"></a>
|
427
|
+
##### filter_important_actions: `Boolean`<a id="filter_important_actions-boolean"></a>
|
428
|
+
##### show_all: `Boolean`<a id="show_all-boolean"></a>
|
429
|
+
##### page: `Float`<a id="page-float"></a>
|
430
|
+
##### offset: `Float`<a id="offset-float"></a>
|
431
|
+
#### 🔄 Return<a id="🔄-return"></a>
|
432
|
+
|
433
|
+
[ActionsListResponseDTO](./lib/composio/models/actions_list_response_dto.rb)
|
434
|
+
|
435
|
+
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
436
|
+
|
437
|
+
`/api/v2/actions` `GET`
|
438
|
+
|
439
|
+
[🔙 **Back to Table of Contents**](#table-of-contents)
|
440
|
+
|
441
|
+
---
|
442
|
+
|
443
|
+
|
444
|
+
### `composio.admin.clear_cache`<a id="composioadminclear_cache"></a>
|
445
|
+
|
446
|
+
Clear cache
|
447
|
+
|
448
|
+
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
449
|
+
|
450
|
+
```ruby
|
451
|
+
result = composio.admin.clear_cache(
|
452
|
+
x_admin_token: "string_example",
|
453
|
+
)
|
454
|
+
p result
|
455
|
+
```
|
456
|
+
|
457
|
+
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
458
|
+
|
459
|
+
##### x_admin_token: `String`<a id="x_admin_token-string"></a>
|
460
|
+
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
461
|
+
|
462
|
+
`/api/v1/clear-cache` `POST`
|
463
|
+
|
464
|
+
[🔙 **Back to Table of Contents**](#table-of-contents)
|
465
|
+
|
466
|
+
---
|
467
|
+
|
468
|
+
|
384
469
|
### `composio.admin.get_sentry_dns`<a id="composioadminget_sentry_dns"></a>
|
385
470
|
|
386
471
|
Jssentry dns
|
@@ -621,6 +706,30 @@ p result
|
|
621
706
|
---
|
622
707
|
|
623
708
|
|
709
|
+
### `composio.auth.get_user_info`<a id="composioauthget_user_info"></a>
|
710
|
+
|
711
|
+
Get client info
|
712
|
+
|
713
|
+
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
714
|
+
|
715
|
+
```ruby
|
716
|
+
result = composio.auth.get_user_info
|
717
|
+
p result
|
718
|
+
```
|
719
|
+
|
720
|
+
#### 🔄 Return<a id="🔄-return"></a>
|
721
|
+
|
722
|
+
[ClientInfoResDTO](./lib/composio/models/client_info_res_dto.rb)
|
723
|
+
|
724
|
+
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
725
|
+
|
726
|
+
`/api/v1/client/auth/client_info` `GET`
|
727
|
+
|
728
|
+
[🔙 **Back to Table of Contents**](#table-of-contents)
|
729
|
+
|
730
|
+
---
|
731
|
+
|
732
|
+
|
624
733
|
### `composio.auth.identify_client_operation`<a id="composioauthidentify_client_operation"></a>
|
625
734
|
|
626
735
|
Identify client
|
@@ -656,6 +765,92 @@ The framework used by the client
|
|
656
765
|
---
|
657
766
|
|
658
767
|
|
768
|
+
### `composio.cli.exchange_code`<a id="composiocliexchange_code"></a>
|
769
|
+
|
770
|
+
Handle cli code exchange
|
771
|
+
|
772
|
+
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
773
|
+
|
774
|
+
```ruby
|
775
|
+
result = composio.cli.exchange_code
|
776
|
+
p result
|
777
|
+
```
|
778
|
+
|
779
|
+
#### 🔄 Return<a id="🔄-return"></a>
|
780
|
+
|
781
|
+
[GenerateCLISessionResDTO](./lib/composio/models/generate_cli_session_res_dto.rb)
|
782
|
+
|
783
|
+
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
784
|
+
|
785
|
+
`/api/v1/cli/generate-cli-session` `GET`
|
786
|
+
|
787
|
+
[🔙 **Back to Table of Contents**](#table-of-contents)
|
788
|
+
|
789
|
+
---
|
790
|
+
|
791
|
+
|
792
|
+
### `composio.cli.get_code`<a id="composiocliget_code"></a>
|
793
|
+
|
794
|
+
Get cli code
|
795
|
+
|
796
|
+
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
797
|
+
|
798
|
+
```ruby
|
799
|
+
result = composio.cli.get_code(
|
800
|
+
key: "key_example",
|
801
|
+
code: "string_example",
|
802
|
+
)
|
803
|
+
p result
|
804
|
+
```
|
805
|
+
|
806
|
+
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
807
|
+
|
808
|
+
##### key: `String`<a id="key-string"></a>
|
809
|
+
##### code: `String`<a id="code-string"></a>
|
810
|
+
#### 🔄 Return<a id="🔄-return"></a>
|
811
|
+
|
812
|
+
[GetCLISessionResDTO](./lib/composio/models/get_cli_session_res_dto.rb)
|
813
|
+
|
814
|
+
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
815
|
+
|
816
|
+
`/api/v1/cli/get-cli-code` `GET`
|
817
|
+
|
818
|
+
[🔙 **Back to Table of Contents**](#table-of-contents)
|
819
|
+
|
820
|
+
---
|
821
|
+
|
822
|
+
|
823
|
+
### `composio.cli.verify_code`<a id="composiocliverify_code"></a>
|
824
|
+
|
825
|
+
Handle cli code verification
|
826
|
+
|
827
|
+
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
828
|
+
|
829
|
+
```ruby
|
830
|
+
result = composio.cli.verify_code(
|
831
|
+
key: "key_example",
|
832
|
+
code: "string_example",
|
833
|
+
)
|
834
|
+
p result
|
835
|
+
```
|
836
|
+
|
837
|
+
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
838
|
+
|
839
|
+
##### key: `String`<a id="key-string"></a>
|
840
|
+
##### code: `String`<a id="code-string"></a>
|
841
|
+
#### 🔄 Return<a id="🔄-return"></a>
|
842
|
+
|
843
|
+
[VerifyCLICodeResDTO](./lib/composio/models/verify_cli_code_res_dto.rb)
|
844
|
+
|
845
|
+
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
846
|
+
|
847
|
+
`/api/v1/cli/verify-cli-code` `GET`
|
848
|
+
|
849
|
+
[🔙 **Back to Table of Contents**](#table-of-contents)
|
850
|
+
|
851
|
+
---
|
852
|
+
|
853
|
+
|
659
854
|
### `composio.connections.delete`<a id="composioconnectionsdelete"></a>
|
660
855
|
|
661
856
|
Delete a connection
|
@@ -809,20 +1004,26 @@ Initiate connection
|
|
809
1004
|
|
810
1005
|
```ruby
|
811
1006
|
result = composio.connections.initiate(
|
1007
|
+
data: {},
|
812
1008
|
integration_id: "a",
|
813
|
-
data: "a",
|
814
1009
|
redirect_uri: "string_example",
|
815
1010
|
user_uuid: "string_example",
|
1011
|
+
entity_id: "string_example",
|
1012
|
+
labels: [
|
1013
|
+
"string_example"
|
1014
|
+
],
|
816
1015
|
)
|
817
1016
|
p result
|
818
1017
|
```
|
819
1018
|
|
820
1019
|
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
821
1020
|
|
1021
|
+
##### data: `Object`<a id="data-object"></a>
|
822
1022
|
##### integrationId: `String`<a id="integrationid-string"></a>
|
823
|
-
##### data: `String`<a id="data-string"></a>
|
824
1023
|
##### redirectUri: `String`<a id="redirecturi-string"></a>
|
825
1024
|
##### userUuid: `String`<a id="useruuid-string"></a>
|
1025
|
+
##### entityId: `String`<a id="entityid-string"></a>
|
1026
|
+
##### labels: Array<`String`><a id="labels-array"></a>
|
826
1027
|
#### 🔄 Return<a id="🔄-return"></a>
|
827
1028
|
|
828
1029
|
[InitiateConnectionResponse](./lib/composio/models/initiate_connection_response.rb)
|
@@ -853,6 +1054,9 @@ result = composio.connections.list(
|
|
853
1054
|
show_active_only: true,
|
854
1055
|
status: "string_example",
|
855
1056
|
show_disabled: true,
|
1057
|
+
labels: [
|
1058
|
+
"string_example"
|
1059
|
+
],
|
856
1060
|
)
|
857
1061
|
p result
|
858
1062
|
```
|
@@ -868,6 +1072,7 @@ p result
|
|
868
1072
|
##### show_active_only: `Boolean`<a id="show_active_only-boolean"></a>
|
869
1073
|
##### status: `String`<a id="status-string"></a>
|
870
1074
|
##### show_disabled: `Boolean`<a id="show_disabled-boolean"></a>
|
1075
|
+
##### labels: Array<`String`><a id="labels-array"></a>
|
871
1076
|
#### 🔄 Return<a id="🔄-return"></a>
|
872
1077
|
|
873
1078
|
[GetConnectionsResponseDto](./lib/composio/models/get_connections_response_dto.rb)
|
@@ -881,87 +1086,29 @@ p result
|
|
881
1086
|
---
|
882
1087
|
|
883
1088
|
|
884
|
-
### `composio.
|
1089
|
+
### `composio.connections.update_connection_data`<a id="composioconnectionsupdate_connection_data"></a>
|
885
1090
|
|
886
|
-
|
1091
|
+
Update connection data
|
887
1092
|
|
888
1093
|
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
889
1094
|
|
890
1095
|
```ruby
|
891
|
-
result = composio.
|
892
|
-
|
893
|
-
|
1096
|
+
result = composio.connections.update_connection_data(
|
1097
|
+
labels: [
|
1098
|
+
"string_example"
|
1099
|
+
],
|
1100
|
+
connected_account_id: "'+j>6",
|
894
1101
|
)
|
895
1102
|
p result
|
896
1103
|
```
|
897
1104
|
|
898
1105
|
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
899
1106
|
|
900
|
-
#####
|
901
|
-
#####
|
902
|
-
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
903
|
-
|
904
|
-
`/api/v1/event_logs/get/events` `GET`
|
905
|
-
|
906
|
-
[🔙 **Back to Table of Contents**](#table-of-contents)
|
907
|
-
|
908
|
-
---
|
909
|
-
|
910
|
-
|
911
|
-
### `composio.event_logs.get_webhook`<a id="composioevent_logsget_webhook"></a>
|
912
|
-
|
913
|
-
Get webhook
|
914
|
-
|
915
|
-
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
916
|
-
|
917
|
-
```ruby
|
918
|
-
result = composio.event_logs.get_webhook
|
919
|
-
p result
|
920
|
-
```
|
921
|
-
|
922
|
-
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
923
|
-
|
924
|
-
`/api/v1/event_logs/get/webhook` `GET`
|
925
|
-
|
926
|
-
[🔙 **Back to Table of Contents**](#table-of-contents)
|
927
|
-
|
928
|
-
---
|
929
|
-
|
930
|
-
|
931
|
-
### `composio.event_logs.get_webhook_secret`<a id="composioevent_logsget_webhook_secret"></a>
|
932
|
-
|
933
|
-
Get webhook secret
|
934
|
-
|
935
|
-
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
936
|
-
|
937
|
-
```ruby
|
938
|
-
result = composio.event_logs.get_webhook_secret
|
939
|
-
p result
|
940
|
-
```
|
941
|
-
|
942
|
-
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
943
|
-
|
944
|
-
`/api/v1/event_logs/webhook/secret/get` `GET`
|
945
|
-
|
946
|
-
[🔙 **Back to Table of Contents**](#table-of-contents)
|
947
|
-
|
948
|
-
---
|
949
|
-
|
950
|
-
|
951
|
-
### `composio.event_logs.refresh_webhook_secret`<a id="composioevent_logsrefresh_webhook_secret"></a>
|
952
|
-
|
953
|
-
Refresh webhook
|
954
|
-
|
955
|
-
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
956
|
-
|
957
|
-
```ruby
|
958
|
-
result = composio.event_logs.refresh_webhook_secret
|
959
|
-
p result
|
960
|
-
```
|
961
|
-
|
1107
|
+
##### labels: Array<`String`><a id="labels-array"></a>
|
1108
|
+
##### connected_account_id: `String`<a id="connected_account_id-string"></a>
|
962
1109
|
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
963
1110
|
|
964
|
-
`/api/v1/
|
1111
|
+
`/api/v1/connectedAccounts/{connectedAccountId}/data` `PATCH`
|
965
1112
|
|
966
1113
|
[🔙 **Back to Table of Contents**](#table-of-contents)
|
967
1114
|
|
@@ -1004,11 +1151,12 @@ Create a new connector
|
|
1004
1151
|
```ruby
|
1005
1152
|
result = composio.integrations.create_integration(
|
1006
1153
|
name: "string_example",
|
1007
|
-
app_id: "string_example",
|
1008
1154
|
auth_scheme: "string_example",
|
1009
1155
|
auth_config: {
|
1010
1156
|
},
|
1011
1157
|
use_composio_auth: true,
|
1158
|
+
app_id: "string_example",
|
1159
|
+
app_name: "string_example",
|
1012
1160
|
force_new_integration: true,
|
1013
1161
|
)
|
1014
1162
|
p result
|
@@ -1019,14 +1167,17 @@ p result
|
|
1019
1167
|
##### name: `String`<a id="name-string"></a>
|
1020
1168
|
Name of the connector
|
1021
1169
|
|
1022
|
-
##### appId: `String`<a id="appid-string"></a>
|
1023
|
-
Application ID
|
1024
|
-
|
1025
1170
|
##### authScheme: `String`<a id="authscheme-string"></a>
|
1026
1171
|
Authentication scheme
|
1027
1172
|
|
1028
1173
|
##### authConfig: [`AuthConfigDTO`](./lib/composio/models/auth_config_dto.rb)<a id="authconfig-authconfigdtolibcomposiomodelsauth_config_dtorb"></a>
|
1029
1174
|
##### useComposioAuth: [`CreateConnectorPayloadDTOUseComposioAuth`](./lib/composio/models/create_connector_payload_dto_use_composio_auth.rb)<a id="usecomposioauth-createconnectorpayloaddtousecomposioauthlibcomposiomodelscreate_connector_payload_dto_use_composio_authrb"></a>
|
1175
|
+
##### appId: `String`<a id="appid-string"></a>
|
1176
|
+
Composio App UUID to be used for authentication. Either specify this or appName
|
1177
|
+
|
1178
|
+
##### appName: `String`<a id="appname-string"></a>
|
1179
|
+
Name of the app to be used for authentication. Either specify this or appId
|
1180
|
+
|
1030
1181
|
##### forceNewIntegration: `Boolean`<a id="forcenewintegration-boolean"></a>
|
1031
1182
|
Flag to force new integration
|
1032
1183
|
|
@@ -1176,6 +1327,8 @@ result = composio.logs.add_new_logs(
|
|
1176
1327
|
response: {},
|
1177
1328
|
is_error: true,
|
1178
1329
|
connection_id: "string_example",
|
1330
|
+
session_id: "string_example",
|
1331
|
+
logs_type: "string_example",
|
1179
1332
|
entity_id: "string_example",
|
1180
1333
|
)
|
1181
1334
|
p result
|
@@ -1195,6 +1348,12 @@ Action name of the log
|
|
1195
1348
|
##### connectionId: `String`<a id="connectionid-string"></a>
|
1196
1349
|
Connection ID of the log
|
1197
1350
|
|
1351
|
+
##### sessionId: `String`<a id="sessionid-string"></a>
|
1352
|
+
Session ID of the log
|
1353
|
+
|
1354
|
+
##### logsType: `String`<a id="logstype-string"></a>
|
1355
|
+
Type of the log
|
1356
|
+
|
1198
1357
|
##### entityId: `String`<a id="entityid-string"></a>
|
1199
1358
|
Entity ID of the log
|
1200
1359
|
|
@@ -1228,6 +1387,7 @@ result = composio.logs.list(
|
|
1228
1387
|
limit: 10,
|
1229
1388
|
cursor: "string_example",
|
1230
1389
|
logs_type: "string_example",
|
1390
|
+
session_id: "string_example",
|
1231
1391
|
)
|
1232
1392
|
p result
|
1233
1393
|
```
|
@@ -1243,6 +1403,7 @@ p result
|
|
1243
1403
|
##### limit: `Float`<a id="limit-float"></a>
|
1244
1404
|
##### cursor: `String`<a id="cursor-string"></a>
|
1245
1405
|
##### logs_type: `String`<a id="logs_type-string"></a>
|
1406
|
+
##### session_id: `String`<a id="session_id-string"></a>
|
1246
1407
|
#### 🔄 Return<a id="🔄-return"></a>
|
1247
1408
|
|
1248
1409
|
[LogsResDTO](./lib/composio/models/logs_res_dto.rb)
|
@@ -1256,123 +1417,6 @@ p result
|
|
1256
1417
|
---
|
1257
1418
|
|
1258
1419
|
|
1259
|
-
### `composio.payment.create_checkout_session`<a id="composiopaymentcreate_checkout_session"></a>
|
1260
|
-
|
1261
|
-
Create checkout session
|
1262
|
-
|
1263
|
-
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
1264
|
-
|
1265
|
-
```ruby
|
1266
|
-
result = composio.payment.create_checkout_session(
|
1267
|
-
plan: "HOBBY",
|
1268
|
-
)
|
1269
|
-
p result
|
1270
|
-
```
|
1271
|
-
|
1272
|
-
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
1273
|
-
|
1274
|
-
##### plan: [`Plan`](./lib/composio/models/plan.rb)<a id="plan-planlibcomposiomodelsplanrb"></a>
|
1275
|
-
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
1276
|
-
|
1277
|
-
`/api/v1/payment/create-checkout-session` `POST`
|
1278
|
-
|
1279
|
-
[🔙 **Back to Table of Contents**](#table-of-contents)
|
1280
|
-
|
1281
|
-
---
|
1282
|
-
|
1283
|
-
|
1284
|
-
### `composio.payment.get_checkout_session_status`<a id="composiopaymentget_checkout_session_status"></a>
|
1285
|
-
|
1286
|
-
Get checkout session status
|
1287
|
-
|
1288
|
-
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
1289
|
-
|
1290
|
-
```ruby
|
1291
|
-
result = composio.payment.get_checkout_session_status(
|
1292
|
-
session_id: "'+j>6",
|
1293
|
-
)
|
1294
|
-
p result
|
1295
|
-
```
|
1296
|
-
|
1297
|
-
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
1298
|
-
|
1299
|
-
##### session_id: `String`<a id="session_id-string"></a>
|
1300
|
-
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
1301
|
-
|
1302
|
-
`/api/v1/payment/checkout-session/{sessionId}/status` `GET`
|
1303
|
-
|
1304
|
-
[🔙 **Back to Table of Contents**](#table-of-contents)
|
1305
|
-
|
1306
|
-
---
|
1307
|
-
|
1308
|
-
|
1309
|
-
### `composio.payment.get_invoice`<a id="composiopaymentget_invoice"></a>
|
1310
|
-
|
1311
|
-
Get invoice
|
1312
|
-
|
1313
|
-
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
1314
|
-
|
1315
|
-
```ruby
|
1316
|
-
result = composio.payment.get_invoice(
|
1317
|
-
invoice_id: "'+j>6",
|
1318
|
-
)
|
1319
|
-
p result
|
1320
|
-
```
|
1321
|
-
|
1322
|
-
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
1323
|
-
|
1324
|
-
##### invoice_id: `String`<a id="invoice_id-string"></a>
|
1325
|
-
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
1326
|
-
|
1327
|
-
`/api/v1/payment/invoices/{invoiceId}` `GET`
|
1328
|
-
|
1329
|
-
[🔙 **Back to Table of Contents**](#table-of-contents)
|
1330
|
-
|
1331
|
-
---
|
1332
|
-
|
1333
|
-
|
1334
|
-
### `composio.payment.get_invoices`<a id="composiopaymentget_invoices"></a>
|
1335
|
-
|
1336
|
-
Get invoices
|
1337
|
-
|
1338
|
-
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
1339
|
-
|
1340
|
-
```ruby
|
1341
|
-
result = composio.payment.get_invoices
|
1342
|
-
p result
|
1343
|
-
```
|
1344
|
-
|
1345
|
-
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
1346
|
-
|
1347
|
-
`/api/v1/payment/invoices` `GET`
|
1348
|
-
|
1349
|
-
[🔙 **Back to Table of Contents**](#table-of-contents)
|
1350
|
-
|
1351
|
-
---
|
1352
|
-
|
1353
|
-
|
1354
|
-
### `composio.payment.handle_stripe_webhook`<a id="composiopaymenthandle_stripe_webhook"></a>
|
1355
|
-
|
1356
|
-
Handle stripe webhook
|
1357
|
-
|
1358
|
-
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
1359
|
-
|
1360
|
-
```ruby
|
1361
|
-
result = composio.payment.handle_stripe_webhook(
|
1362
|
-
body: None,
|
1363
|
-
)
|
1364
|
-
p result
|
1365
|
-
```
|
1366
|
-
|
1367
|
-
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
1368
|
-
|
1369
|
-
`/api/v1/payment/webhook` `POST`
|
1370
|
-
|
1371
|
-
[🔙 **Back to Table of Contents**](#table-of-contents)
|
1372
|
-
|
1373
|
-
---
|
1374
|
-
|
1375
|
-
|
1376
1420
|
### `composio.triggers.delete_trigger_instance`<a id="composiotriggersdelete_trigger_instance"></a>
|
1377
1421
|
|
1378
1422
|
Deletes a specified trigger instance.
|
@@ -1610,6 +1654,7 @@ result = composio.triggers.list(
|
|
1610
1654
|
app_names: "string_example",
|
1611
1655
|
connected_account_ids: "string_example",
|
1612
1656
|
trigger_ids: "string_example",
|
1657
|
+
integration_ids: "string_example",
|
1613
1658
|
show_enabled_only: true,
|
1614
1659
|
)
|
1615
1660
|
p result
|
@@ -1620,6 +1665,7 @@ p result
|
|
1620
1665
|
##### app_names: `String`<a id="app_names-string"></a>
|
1621
1666
|
##### connected_account_ids: `String`<a id="connected_account_ids-string"></a>
|
1622
1667
|
##### trigger_ids: `String`<a id="trigger_ids-string"></a>
|
1668
|
+
##### integration_ids: `String`<a id="integration_ids-string"></a>
|
1623
1669
|
##### show_enabled_only: `Boolean`<a id="show_enabled_only-boolean"></a>
|
1624
1670
|
#### 🔄 Return<a id="🔄-return"></a>
|
1625
1671
|
|