carbon_ruby_sdk 0.2.6 → 0.2.8
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +1 -1
- data/README.md +155 -28
- data/lib/carbon_ruby_sdk/api/integrations_api.rb +261 -8
- data/lib/carbon_ruby_sdk/api/utilities_api.rb +196 -0
- data/lib/carbon_ruby_sdk/models/data_source_type.rb +2 -1
- data/lib/carbon_ruby_sdk/models/data_source_type_nullable.rb +2 -1
- data/lib/carbon_ruby_sdk/models/fetch_urls_request.rb +220 -0
- data/lib/carbon_ruby_sdk/models/file_formats.rb +2 -1
- data/lib/carbon_ruby_sdk/models/file_formats_nullable.rb +2 -1
- data/lib/carbon_ruby_sdk/models/o_auth_url_request.rb +2 -2
- data/lib/carbon_ruby_sdk/models/simple_o_auth_data_sources.rb +2 -1
- data/lib/carbon_ruby_sdk/models/slack_filters.rb +232 -0
- data/lib/carbon_ruby_sdk/models/slack_sync_request.rb +321 -0
- data/lib/carbon_ruby_sdk/models/sync_files_request.rb +1 -1
- data/lib/carbon_ruby_sdk/models/sync_options.rb +1 -1
- data/lib/carbon_ruby_sdk/models/user_file.rb +15 -1
- data/lib/carbon_ruby_sdk/models/user_web_page_order_by_types.rb +37 -0
- data/lib/carbon_ruby_sdk/models/user_web_pages_filters.rb +218 -0
- data/lib/carbon_ruby_sdk/models/user_web_pages_request.rb +246 -0
- data/lib/carbon_ruby_sdk/version.rb +1 -1
- data/lib/carbon_ruby_sdk.rb +6 -3
- data/spec/api/integrations_api_spec.rb +27 -0
- data/spec/api/utilities_api_spec.rb +22 -0
- data/spec/models/fetch_urls_request_spec.rb +28 -0
- data/spec/models/slack_filters_spec.rb +34 -0
- data/spec/models/slack_sync_request_spec.rb +82 -0
- data/spec/models/user_file_spec.rb +6 -0
- data/spec/models/user_web_page_order_by_types_spec.rb +22 -0
- data/spec/models/user_web_pages_filters_spec.rb +28 -0
- data/spec/models/user_web_pages_request_spec.rb +46 -0
- metadata +20 -5
- data/lib/carbon_ruby_sdk/api/health_api.rb +0 -92
- data/spec/api/health_api_spec.rb +0 -39
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 7e24c4f7481d52cd0901f996fa2918d220818ff71e03f3466fe588a0a721048a
|
4
|
+
data.tar.gz: b4b4f44995b7b14d370897734d98b16d1e8f05d6d12be08890e2a1486c768f8f
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: b4c1aa6d3423c0a32fbd51eeccf1059e1f2e5b3c44124bfdf3b3abec834e7bb5f564f0a4ed6c40ca265bc387b334881d3f8f4955301388e7d6439636828aec75
|
7
|
+
data.tar.gz: 5c8eee9e089f459a6da9b5242f8843ee53dcd21ef80b3b4361ac45c040a3d50c61e8c158d5759d3d24f9106e8aa52bfee3df1c78a9d27b87cffe9d6c54dac4d9
|
data/Gemfile.lock
CHANGED
data/README.md
CHANGED
@@ -6,7 +6,7 @@
|
|
6
6
|
|
7
7
|
Connect external data to LLMs, no matter the source.
|
8
8
|
|
9
|
-
[![npm](https://img.shields.io/badge/gem-v0.2.
|
9
|
+
[![npm](https://img.shields.io/badge/gem-v0.2.8-blue)](https://rubygems.org/gems/carbon_ruby_sdk/versions/0.2.8)
|
10
10
|
|
11
11
|
</div>
|
12
12
|
|
@@ -38,7 +38,6 @@ Connect external data to LLMs, no matter the source.
|
|
38
38
|
* [`carbon.files.upload`](#carbonfilesupload)
|
39
39
|
* [`carbon.files.upload_from_url`](#carbonfilesupload_from_url)
|
40
40
|
* [`carbon.files.upload_text`](#carbonfilesupload_text)
|
41
|
-
* [`carbon.health.check`](#carbonhealthcheck)
|
42
41
|
* [`carbon.integrations.cancel`](#carbonintegrationscancel)
|
43
42
|
* [`carbon.integrations.connect_data_source`](#carbonintegrationsconnect_data_source)
|
44
43
|
* [`carbon.integrations.connect_freshdesk`](#carbonintegrationsconnect_freshdesk)
|
@@ -46,6 +45,7 @@ Connect external data to LLMs, no matter the source.
|
|
46
45
|
* [`carbon.integrations.create_aws_iam_user`](#carbonintegrationscreate_aws_iam_user)
|
47
46
|
* [`carbon.integrations.get_oauth_url`](#carbonintegrationsget_oauth_url)
|
48
47
|
* [`carbon.integrations.list_confluence_pages`](#carbonintegrationslist_confluence_pages)
|
48
|
+
* [`carbon.integrations.list_conversations`](#carbonintegrationslist_conversations)
|
49
49
|
* [`carbon.integrations.list_data_source_items`](#carbonintegrationslist_data_source_items)
|
50
50
|
* [`carbon.integrations.list_folders`](#carbonintegrationslist_folders)
|
51
51
|
* [`carbon.integrations.list_gitbook_spaces`](#carbonintegrationslist_gitbook_spaces)
|
@@ -62,6 +62,7 @@ Connect external data to LLMs, no matter the source.
|
|
62
62
|
* [`carbon.integrations.sync_repos`](#carbonintegrationssync_repos)
|
63
63
|
* [`carbon.integrations.sync_rss_feed`](#carbonintegrationssync_rss_feed)
|
64
64
|
* [`carbon.integrations.sync_s3_files`](#carbonintegrationssync_s3_files)
|
65
|
+
* [`carbon.integrations.sync_slack`](#carbonintegrationssync_slack)
|
65
66
|
* [`carbon.organizations.get`](#carbonorganizationsget)
|
66
67
|
* [`carbon.organizations.update`](#carbonorganizationsupdate)
|
67
68
|
* [`carbon.organizations.update_stats`](#carbonorganizationsupdate_stats)
|
@@ -70,11 +71,13 @@ Connect external data to LLMs, no matter the source.
|
|
70
71
|
* [`carbon.users.toggle_user_features`](#carbonuserstoggle_user_features)
|
71
72
|
* [`carbon.users.update_users`](#carbonusersupdate_users)
|
72
73
|
* [`carbon.utilities.fetch_urls`](#carbonutilitiesfetch_urls)
|
74
|
+
* [`carbon.utilities.fetch_webpage`](#carbonutilitiesfetch_webpage)
|
73
75
|
* [`carbon.utilities.fetch_youtube_transcripts`](#carbonutilitiesfetch_youtube_transcripts)
|
74
76
|
* [`carbon.utilities.process_sitemap`](#carbonutilitiesprocess_sitemap)
|
75
77
|
* [`carbon.utilities.scrape_sitemap`](#carbonutilitiesscrape_sitemap)
|
76
78
|
* [`carbon.utilities.scrape_web`](#carbonutilitiesscrape_web)
|
77
79
|
* [`carbon.utilities.search_urls`](#carbonutilitiessearch_urls)
|
80
|
+
* [`carbon.utilities.user_webpages`](#carbonutilitiesuser_webpages)
|
78
81
|
* [`carbon.webhooks.add_url`](#carbonwebhooksadd_url)
|
79
82
|
* [`carbon.webhooks.delete_url`](#carbonwebhooksdelete_url)
|
80
83
|
* [`carbon.webhooks.urls`](#carbonwebhooksurls)
|
@@ -86,7 +89,7 @@ Connect external data to LLMs, no matter the source.
|
|
86
89
|
Add to Gemfile:
|
87
90
|
|
88
91
|
```ruby
|
89
|
-
gem 'carbon_ruby_sdk', '~> 0.2.
|
92
|
+
gem 'carbon_ruby_sdk', '~> 0.2.8'
|
90
93
|
```
|
91
94
|
|
92
95
|
## Getting Started<a id="getting-started"></a>
|
@@ -1177,26 +1180,6 @@ p result
|
|
1177
1180
|
---
|
1178
1181
|
|
1179
1182
|
|
1180
|
-
### `carbon.health.check`<a id="carbonhealthcheck"></a>
|
1181
|
-
|
1182
|
-
Health
|
1183
|
-
|
1184
|
-
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
1185
|
-
|
1186
|
-
```ruby
|
1187
|
-
result = carbon.health.check
|
1188
|
-
p result
|
1189
|
-
```
|
1190
|
-
|
1191
|
-
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
1192
|
-
|
1193
|
-
`/health` `GET`
|
1194
|
-
|
1195
|
-
[🔙 **Back to Table of Contents**](#table-of-contents)
|
1196
|
-
|
1197
|
-
---
|
1198
|
-
|
1199
|
-
|
1200
1183
|
### `carbon.integrations.cancel`<a id="carbonintegrationscancel"></a>
|
1201
1184
|
|
1202
1185
|
Cancel Data Source Items Sync
|
@@ -1247,7 +1230,7 @@ result = carbon.integrations.connect_data_source(
|
|
1247
1230
|
"prepend_filename_to_chunks" => false,
|
1248
1231
|
"sync_files_on_connection" => true,
|
1249
1232
|
"set_page_as_boundary" => false,
|
1250
|
-
"request_id" => "
|
1233
|
+
"request_id" => "9e41dd01-0592-477a-97b3-df618acf082b",
|
1251
1234
|
"enable_file_picker" => true,
|
1252
1235
|
"sync_source_items" => true,
|
1253
1236
|
"incremental_sync" => false,
|
@@ -1467,7 +1450,7 @@ result = carbon.integrations.get_oauth_url(
|
|
1467
1450
|
set_page_as_boundary: false,
|
1468
1451
|
data_source_id: 1,
|
1469
1452
|
connecting_new_account: false,
|
1470
|
-
request_id: "
|
1453
|
+
request_id: "1855375f-faa1-4965-99a1-03d1cab8000b",
|
1471
1454
|
use_ocr: false,
|
1472
1455
|
parse_pdf_tables_with_ocr: false,
|
1473
1456
|
enable_file_picker: true,
|
@@ -1528,7 +1511,7 @@ Enable OCR for files that support it. Supported formats: pdf
|
|
1528
1511
|
##### parse_pdf_tables_with_ocr: `Boolean`<a id="parse_pdf_tables_with_ocr-boolean"></a>
|
1529
1512
|
##### enable_file_picker: `Boolean`<a id="enable_file_picker-boolean"></a>
|
1530
1513
|
Enable integration's file picker for sources that support it. Supported sources:
|
1531
|
-
SHAREPOINT, ONEDRIVE,
|
1514
|
+
SHAREPOINT, GOOGLE_DRIVE, ONEDRIVE, BOX, DROPBOX
|
1532
1515
|
|
1533
1516
|
##### sync_source_items: `Boolean`<a id="sync_source_items-boolean"></a>
|
1534
1517
|
Enabling this flag will fetch all available content from the source to be listed
|
@@ -1590,6 +1573,43 @@ p result
|
|
1590
1573
|
---
|
1591
1574
|
|
1592
1575
|
|
1576
|
+
### `carbon.integrations.list_conversations`<a id="carbonintegrationslist_conversations"></a>
|
1577
|
+
|
1578
|
+
List all of your public and private channels, DMs, and Group DMs. The ID from response
|
1579
|
+
can be used as a filter to sync messages to Carbon
|
1580
|
+
types: Comma separated list of types. Available types are im (DMs), mpim (group DMs), public_channel, and private_channel.
|
1581
|
+
Defaults to public_channel.
|
1582
|
+
cursor: Used for pagination. If next_cursor is returned in response, you need to pass it as the cursor in the next request
|
1583
|
+
data_source_id: Data source needs to be specified if you have linked multiple slack accounts
|
1584
|
+
exclude_archived: Should archived conversations be excluded, defaults to true
|
1585
|
+
|
1586
|
+
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
1587
|
+
|
1588
|
+
```ruby
|
1589
|
+
result = carbon.integrations.list_conversations(
|
1590
|
+
types: "public_channel",
|
1591
|
+
cursor: "string_example",
|
1592
|
+
data_source_id: 1,
|
1593
|
+
exclude_archived: true,
|
1594
|
+
)
|
1595
|
+
p result
|
1596
|
+
```
|
1597
|
+
|
1598
|
+
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
1599
|
+
|
1600
|
+
##### types: `String`<a id="types-string"></a>
|
1601
|
+
##### cursor: `String`<a id="cursor-string"></a>
|
1602
|
+
##### data_source_id: `Integer`<a id="data_source_id-integer"></a>
|
1603
|
+
##### exclude_archived: `Boolean`<a id="exclude_archived-boolean"></a>
|
1604
|
+
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
1605
|
+
|
1606
|
+
`/integrations/slack/conversations` `GET`
|
1607
|
+
|
1608
|
+
[🔙 **Back to Table of Contents**](#table-of-contents)
|
1609
|
+
|
1610
|
+
---
|
1611
|
+
|
1612
|
+
|
1593
1613
|
### `carbon.integrations.list_data_source_items`<a id="carbonintegrationslist_data_source_items"></a>
|
1594
1614
|
|
1595
1615
|
List Data Source Items
|
@@ -1790,7 +1810,7 @@ result = carbon.integrations.sync_confluence(
|
|
1790
1810
|
prepend_filename_to_chunks: false,
|
1791
1811
|
max_items_per_chunk: 1,
|
1792
1812
|
set_page_as_boundary: false,
|
1793
|
-
request_id: "
|
1813
|
+
request_id: "9e2d7dc0-7a78-49fa-9f68-a411cfa13267",
|
1794
1814
|
use_ocr: false,
|
1795
1815
|
parse_pdf_tables_with_ocr: false,
|
1796
1816
|
incremental_sync: false,
|
@@ -1894,7 +1914,7 @@ result = carbon.integrations.sync_files(
|
|
1894
1914
|
prepend_filename_to_chunks: false,
|
1895
1915
|
max_items_per_chunk: 1,
|
1896
1916
|
set_page_as_boundary: false,
|
1897
|
-
request_id: "
|
1917
|
+
request_id: "9e2d7dc0-7a78-49fa-9f68-a411cfa13267",
|
1898
1918
|
use_ocr: false,
|
1899
1919
|
parse_pdf_tables_with_ocr: false,
|
1900
1920
|
incremental_sync: false,
|
@@ -2400,6 +2420,52 @@ Number of objects per chunk. For csv, tsv, xlsx, and json files only.
|
|
2400
2420
|
---
|
2401
2421
|
|
2402
2422
|
|
2423
|
+
### `carbon.integrations.sync_slack`<a id="carbonintegrationssync_slack"></a>
|
2424
|
+
|
2425
|
+
You can list all conversations using the endpoint /integrations/slack/conversations. The ID of
|
2426
|
+
conversation will be used as an input for this endpoint with timestamps as optional filters.
|
2427
|
+
|
2428
|
+
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
2429
|
+
|
2430
|
+
```ruby
|
2431
|
+
result = carbon.integrations.sync_slack(
|
2432
|
+
filters: {
|
2433
|
+
"conversation_id" => "conversation_id_example",
|
2434
|
+
},
|
2435
|
+
tags: {},
|
2436
|
+
chunk_size: 1500,
|
2437
|
+
chunk_overlap: 20,
|
2438
|
+
skip_embedding_generation: false,
|
2439
|
+
embedding_model: "OPENAI",
|
2440
|
+
generate_sparse_vectors: false,
|
2441
|
+
prepend_filename_to_chunks: false,
|
2442
|
+
data_source_id: 1,
|
2443
|
+
request_id: "string_example",
|
2444
|
+
)
|
2445
|
+
p result
|
2446
|
+
```
|
2447
|
+
|
2448
|
+
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
2449
|
+
|
2450
|
+
##### filters: [`SlackFilters`](./lib/carbon_ruby_sdk/models/slack_filters.rb)<a id="filters-slackfilterslibcarbon_ruby_sdkmodelsslack_filtersrb"></a>
|
2451
|
+
##### tags: `Object`<a id="tags-object"></a>
|
2452
|
+
##### chunk_size: `Integer`<a id="chunk_size-integer"></a>
|
2453
|
+
##### chunk_overlap: `Integer`<a id="chunk_overlap-integer"></a>
|
2454
|
+
##### skip_embedding_generation: `Boolean`<a id="skip_embedding_generation-boolean"></a>
|
2455
|
+
##### embedding_model: [`EmbeddingGenerators`](./lib/carbon_ruby_sdk/models/embedding_generators.rb)<a id="embedding_model-embeddinggeneratorslibcarbon_ruby_sdkmodelsembedding_generatorsrb"></a>
|
2456
|
+
##### generate_sparse_vectors: `Boolean`<a id="generate_sparse_vectors-boolean"></a>
|
2457
|
+
##### prepend_filename_to_chunks: `Boolean`<a id="prepend_filename_to_chunks-boolean"></a>
|
2458
|
+
##### data_source_id: `Integer`<a id="data_source_id-integer"></a>
|
2459
|
+
##### request_id: `String`<a id="request_id-string"></a>
|
2460
|
+
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
2461
|
+
|
2462
|
+
`/integrations/slack/sync` `POST`
|
2463
|
+
|
2464
|
+
[🔙 **Back to Table of Contents**](#table-of-contents)
|
2465
|
+
|
2466
|
+
---
|
2467
|
+
|
2468
|
+
|
2403
2469
|
### `carbon.organizations.get`<a id="carbonorganizationsget"></a>
|
2404
2470
|
|
2405
2471
|
Get Organization
|
@@ -2623,6 +2689,7 @@ upload. If not set, or if set to -1, then the user will have no limit.
|
|
2623
2689
|
|
2624
2690
|
|
2625
2691
|
### `carbon.utilities.fetch_urls`<a id="carbonutilitiesfetch_urls"></a>
|
2692
|
+
![Deprecated](https://img.shields.io/badge/deprecated-yellow)
|
2626
2693
|
|
2627
2694
|
Extracts all URLs from a webpage.
|
2628
2695
|
|
@@ -2657,6 +2724,31 @@ p result
|
|
2657
2724
|
---
|
2658
2725
|
|
2659
2726
|
|
2727
|
+
### `carbon.utilities.fetch_webpage`<a id="carbonutilitiesfetch_webpage"></a>
|
2728
|
+
|
2729
|
+
Fetch Urls V2
|
2730
|
+
|
2731
|
+
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
2732
|
+
|
2733
|
+
```ruby
|
2734
|
+
result = carbon.utilities.fetch_webpage(
|
2735
|
+
url: "string_example",
|
2736
|
+
)
|
2737
|
+
p result
|
2738
|
+
```
|
2739
|
+
|
2740
|
+
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
2741
|
+
|
2742
|
+
##### url: `String`<a id="url-string"></a>
|
2743
|
+
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
2744
|
+
|
2745
|
+
`/fetch_webpage` `POST`
|
2746
|
+
|
2747
|
+
[🔙 **Back to Table of Contents**](#table-of-contents)
|
2748
|
+
|
2749
|
+
---
|
2750
|
+
|
2751
|
+
|
2660
2752
|
### `carbon.utilities.fetch_youtube_transcripts`<a id="carbonutilitiesfetch_youtube_transcripts"></a>
|
2661
2753
|
|
2662
2754
|
Fetches english transcripts from YouTube videos.
|
@@ -2891,6 +2983,41 @@ p result
|
|
2891
2983
|
---
|
2892
2984
|
|
2893
2985
|
|
2986
|
+
### `carbon.utilities.user_webpages`<a id="carbonutilitiesuser_webpages"></a>
|
2987
|
+
|
2988
|
+
User Web Pages
|
2989
|
+
|
2990
|
+
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
2991
|
+
|
2992
|
+
```ruby
|
2993
|
+
result = carbon.utilities.user_webpages(
|
2994
|
+
filters: {
|
2995
|
+
},
|
2996
|
+
pagination: {
|
2997
|
+
"limit" => 10,
|
2998
|
+
"offset" => 0,
|
2999
|
+
},
|
3000
|
+
order_by: "created_at",
|
3001
|
+
order_dir: "asc",
|
3002
|
+
)
|
3003
|
+
p result
|
3004
|
+
```
|
3005
|
+
|
3006
|
+
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
3007
|
+
|
3008
|
+
##### filters: [`UserWebPagesFilters`](./lib/carbon_ruby_sdk/models/user_web_pages_filters.rb)<a id="filters-userwebpagesfilterslibcarbon_ruby_sdkmodelsuser_web_pages_filtersrb"></a>
|
3009
|
+
##### pagination: [`Pagination`](./lib/carbon_ruby_sdk/models/pagination.rb)<a id="pagination-paginationlibcarbon_ruby_sdkmodelspaginationrb"></a>
|
3010
|
+
##### order_by: [`UserWebPageOrderByTypes`](./lib/carbon_ruby_sdk/models/user_web_page_order_by_types.rb)<a id="order_by-userwebpageorderbytypeslibcarbon_ruby_sdkmodelsuser_web_page_order_by_typesrb"></a>
|
3011
|
+
##### order_dir: [`OrderDirV2`](./lib/carbon_ruby_sdk/models/order_dir_v2.rb)<a id="order_dir-orderdirv2libcarbon_ruby_sdkmodelsorder_dir_v2rb"></a>
|
3012
|
+
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
3013
|
+
|
3014
|
+
`/user_webpages` `POST`
|
3015
|
+
|
3016
|
+
[🔙 **Back to Table of Contents**](#table-of-contents)
|
3017
|
+
|
3018
|
+
---
|
3019
|
+
|
3020
|
+
|
2894
3021
|
### `carbon.webhooks.add_url`<a id="carbonwebhooksadd_url"></a>
|
2895
3022
|
|
2896
3023
|
Add Webhook Url
|
@@ -653,13 +653,13 @@ module Carbon
|
|
653
653
|
# @param request_id [String] This request id will be added to all files that get synced using the generated OAuth URL
|
654
654
|
# @param use_ocr [Boolean] Enable OCR for files that support it. Supported formats: pdf
|
655
655
|
# @param parse_pdf_tables_with_ocr [Boolean]
|
656
|
-
# @param enable_file_picker [Boolean] Enable integration's file picker for sources that support it. Supported sources: SHAREPOINT, ONEDRIVE,
|
656
|
+
# @param enable_file_picker [Boolean] Enable integration's file picker for sources that support it. Supported sources: SHAREPOINT, GOOGLE_DRIVE, ONEDRIVE, BOX, DROPBOX
|
657
657
|
# @param sync_source_items [Boolean] Enabling this flag will fetch all available content from the source to be listed via list items endpoint
|
658
658
|
# @param incremental_sync [Boolean] Only sync files if they have not already been synced or if the embedding properties have changed. This flag is currently supported by ONEDRIVE, GOOGLE_DRIVE, BOX, DROPBOX. It will be ignored for other data sources.
|
659
659
|
# @param file_sync_config [FileSyncConfigNullable]
|
660
660
|
# @param body [OAuthURLRequest]
|
661
661
|
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
662
|
-
def get_oauth_url(service:, tags: SENTINEL, scope: SENTINEL, chunk_size: 1500, chunk_overlap: 20, skip_embedding_generation: false, embedding_model: 'OPENAI', zendesk_subdomain: SENTINEL, microsoft_tenant: SENTINEL, sharepoint_site_name: SENTINEL, confluence_subdomain: SENTINEL, generate_sparse_vectors: false, prepend_filename_to_chunks: false, max_items_per_chunk: SENTINEL, salesforce_domain: SENTINEL, sync_files_on_connection: true, set_page_as_boundary: false, data_source_id: SENTINEL, connecting_new_account: false, request_id: '
|
662
|
+
def get_oauth_url(service:, tags: SENTINEL, scope: SENTINEL, chunk_size: 1500, chunk_overlap: 20, skip_embedding_generation: false, embedding_model: 'OPENAI', zendesk_subdomain: SENTINEL, microsoft_tenant: SENTINEL, sharepoint_site_name: SENTINEL, confluence_subdomain: SENTINEL, generate_sparse_vectors: false, prepend_filename_to_chunks: false, max_items_per_chunk: SENTINEL, salesforce_domain: SENTINEL, sync_files_on_connection: true, set_page_as_boundary: false, data_source_id: SENTINEL, connecting_new_account: false, request_id: '1855375f-faa1-4965-99a1-03d1cab8000b', use_ocr: false, parse_pdf_tables_with_ocr: false, enable_file_picker: true, sync_source_items: true, incremental_sync: false, file_sync_config: SENTINEL, extra: {})
|
663
663
|
_body = {}
|
664
664
|
_body[:tags] = tags if tags != SENTINEL
|
665
665
|
_body[:scope] = scope if scope != SENTINEL
|
@@ -721,13 +721,13 @@ module Carbon
|
|
721
721
|
# @param request_id [String] This request id will be added to all files that get synced using the generated OAuth URL
|
722
722
|
# @param use_ocr [Boolean] Enable OCR for files that support it. Supported formats: pdf
|
723
723
|
# @param parse_pdf_tables_with_ocr [Boolean]
|
724
|
-
# @param enable_file_picker [Boolean] Enable integration's file picker for sources that support it. Supported sources: SHAREPOINT, ONEDRIVE,
|
724
|
+
# @param enable_file_picker [Boolean] Enable integration's file picker for sources that support it. Supported sources: SHAREPOINT, GOOGLE_DRIVE, ONEDRIVE, BOX, DROPBOX
|
725
725
|
# @param sync_source_items [Boolean] Enabling this flag will fetch all available content from the source to be listed via list items endpoint
|
726
726
|
# @param incremental_sync [Boolean] Only sync files if they have not already been synced or if the embedding properties have changed. This flag is currently supported by ONEDRIVE, GOOGLE_DRIVE, BOX, DROPBOX. It will be ignored for other data sources.
|
727
727
|
# @param file_sync_config [FileSyncConfigNullable]
|
728
728
|
# @param body [OAuthURLRequest]
|
729
729
|
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
730
|
-
def get_oauth_url_with_http_info(service:, tags: SENTINEL, scope: SENTINEL, chunk_size: 1500, chunk_overlap: 20, skip_embedding_generation: false, embedding_model: 'OPENAI', zendesk_subdomain: SENTINEL, microsoft_tenant: SENTINEL, sharepoint_site_name: SENTINEL, confluence_subdomain: SENTINEL, generate_sparse_vectors: false, prepend_filename_to_chunks: false, max_items_per_chunk: SENTINEL, salesforce_domain: SENTINEL, sync_files_on_connection: true, set_page_as_boundary: false, data_source_id: SENTINEL, connecting_new_account: false, request_id: '
|
730
|
+
def get_oauth_url_with_http_info(service:, tags: SENTINEL, scope: SENTINEL, chunk_size: 1500, chunk_overlap: 20, skip_embedding_generation: false, embedding_model: 'OPENAI', zendesk_subdomain: SENTINEL, microsoft_tenant: SENTINEL, sharepoint_site_name: SENTINEL, confluence_subdomain: SENTINEL, generate_sparse_vectors: false, prepend_filename_to_chunks: false, max_items_per_chunk: SENTINEL, salesforce_domain: SENTINEL, sync_files_on_connection: true, set_page_as_boundary: false, data_source_id: SENTINEL, connecting_new_account: false, request_id: '1855375f-faa1-4965-99a1-03d1cab8000b', use_ocr: false, parse_pdf_tables_with_ocr: false, enable_file_picker: true, sync_source_items: true, incremental_sync: false, file_sync_config: SENTINEL, extra: {})
|
731
731
|
_body = {}
|
732
732
|
_body[:tags] = tags if tags != SENTINEL
|
733
733
|
_body[:scope] = scope if scope != SENTINEL
|
@@ -942,6 +942,123 @@ module Carbon
|
|
942
942
|
end
|
943
943
|
|
944
944
|
|
945
|
+
# Slack List Conversations
|
946
|
+
#
|
947
|
+
# List all of your public and private channels, DMs, and Group DMs. The ID from response
|
948
|
+
# can be used as a filter to sync messages to Carbon
|
949
|
+
# types: Comma separated list of types. Available types are im (DMs), mpim (group DMs), public_channel, and private_channel.
|
950
|
+
# Defaults to public_channel.
|
951
|
+
# cursor: Used for pagination. If next_cursor is returned in response, you need to pass it as the cursor in the next request
|
952
|
+
# data_source_id: Data source needs to be specified if you have linked multiple slack accounts
|
953
|
+
# exclude_archived: Should archived conversations be excluded, defaults to true
|
954
|
+
#
|
955
|
+
# @param types [String]
|
956
|
+
# @param cursor [String]
|
957
|
+
# @param data_source_id [Integer]
|
958
|
+
# @param exclude_archived [Boolean]
|
959
|
+
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
960
|
+
def list_conversations(types: 'public_channel', cursor: SENTINEL, data_source_id: SENTINEL, exclude_archived: true, extra: {})
|
961
|
+
extra[:types] = types if types != SENTINEL
|
962
|
+
extra[:cursor] = cursor if cursor != SENTINEL
|
963
|
+
extra[:data_source_id] = data_source_id if data_source_id != SENTINEL
|
964
|
+
extra[:exclude_archived] = exclude_archived if exclude_archived != SENTINEL
|
965
|
+
api_response = list_conversations_with_http_info_impl(extra)
|
966
|
+
api_response.data
|
967
|
+
end
|
968
|
+
|
969
|
+
# Slack List Conversations
|
970
|
+
#
|
971
|
+
# List all of your public and private channels, DMs, and Group DMs. The ID from response
|
972
|
+
# can be used as a filter to sync messages to Carbon
|
973
|
+
# types: Comma separated list of types. Available types are im (DMs), mpim (group DMs), public_channel, and private_channel.
|
974
|
+
# Defaults to public_channel.
|
975
|
+
# cursor: Used for pagination. If next_cursor is returned in response, you need to pass it as the cursor in the next request
|
976
|
+
# data_source_id: Data source needs to be specified if you have linked multiple slack accounts
|
977
|
+
# exclude_archived: Should archived conversations be excluded, defaults to true
|
978
|
+
#
|
979
|
+
# @param types [String]
|
980
|
+
# @param cursor [String]
|
981
|
+
# @param data_source_id [Integer]
|
982
|
+
# @param exclude_archived [Boolean]
|
983
|
+
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
984
|
+
def list_conversations_with_http_info(types: 'public_channel', cursor: SENTINEL, data_source_id: SENTINEL, exclude_archived: true, extra: {})
|
985
|
+
extra[:types] = types if types != SENTINEL
|
986
|
+
extra[:cursor] = cursor if cursor != SENTINEL
|
987
|
+
extra[:data_source_id] = data_source_id if data_source_id != SENTINEL
|
988
|
+
extra[:exclude_archived] = exclude_archived if exclude_archived != SENTINEL
|
989
|
+
list_conversations_with_http_info_impl(extra)
|
990
|
+
end
|
991
|
+
|
992
|
+
# Slack List Conversations
|
993
|
+
# List all of your public and private channels, DMs, and Group DMs. The ID from response can be used as a filter to sync messages to Carbon types: Comma separated list of types. Available types are im (DMs), mpim (group DMs), public_channel, and private_channel. Defaults to public_channel. cursor: Used for pagination. If next_cursor is returned in response, you need to pass it as the cursor in the next request data_source_id: Data source needs to be specified if you have linked multiple slack accounts exclude_archived: Should archived conversations be excluded, defaults to true
|
994
|
+
# @param [Hash] opts the optional parameters
|
995
|
+
# @option opts [String] :types (default to 'public_channel')
|
996
|
+
# @option opts [String] :cursor
|
997
|
+
# @option opts [Integer] :data_source_id
|
998
|
+
# @option opts [Boolean] :exclude_archived (default to true)
|
999
|
+
# @return [Object]
|
1000
|
+
private def list_conversations_impl(opts = {})
|
1001
|
+
data, _status_code, _headers = list_conversations_with_http_info(opts)
|
1002
|
+
data
|
1003
|
+
end
|
1004
|
+
|
1005
|
+
# Slack List Conversations
|
1006
|
+
# List all of your public and private channels, DMs, and Group DMs. The ID from response can be used as a filter to sync messages to Carbon types: Comma separated list of types. Available types are im (DMs), mpim (group DMs), public_channel, and private_channel. Defaults to public_channel. cursor: Used for pagination. If next_cursor is returned in response, you need to pass it as the cursor in the next request data_source_id: Data source needs to be specified if you have linked multiple slack accounts exclude_archived: Should archived conversations be excluded, defaults to true
|
1007
|
+
# @param [Hash] opts the optional parameters
|
1008
|
+
# @option opts [String] :types (default to 'public_channel')
|
1009
|
+
# @option opts [String] :cursor
|
1010
|
+
# @option opts [Integer] :data_source_id
|
1011
|
+
# @option opts [Boolean] :exclude_archived (default to true)
|
1012
|
+
# @return [APIResponse] data is Object, status code, headers and response
|
1013
|
+
private def list_conversations_with_http_info_impl(opts = {})
|
1014
|
+
if @api_client.config.debugging
|
1015
|
+
@api_client.config.logger.debug 'Calling API: IntegrationsApi.list_conversations ...'
|
1016
|
+
end
|
1017
|
+
# resource path
|
1018
|
+
local_var_path = '/integrations/slack/conversations'
|
1019
|
+
|
1020
|
+
# query parameters
|
1021
|
+
query_params = opts[:query_params] || {}
|
1022
|
+
query_params[:'types'] = opts[:'types'] if !opts[:'types'].nil?
|
1023
|
+
query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
|
1024
|
+
query_params[:'data_source_id'] = opts[:'data_source_id'] if !opts[:'data_source_id'].nil?
|
1025
|
+
query_params[:'exclude_archived'] = opts[:'exclude_archived'] if !opts[:'exclude_archived'].nil?
|
1026
|
+
|
1027
|
+
# header parameters
|
1028
|
+
header_params = opts[:header_params] || {}
|
1029
|
+
# HTTP header 'Accept' (if needed)
|
1030
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1031
|
+
|
1032
|
+
# form parameters
|
1033
|
+
form_params = opts[:form_params] || {}
|
1034
|
+
|
1035
|
+
# http body (model)
|
1036
|
+
post_body = opts[:debug_body]
|
1037
|
+
|
1038
|
+
# return_type
|
1039
|
+
return_type = opts[:debug_return_type] || 'Object'
|
1040
|
+
|
1041
|
+
# auth_names
|
1042
|
+
auth_names = opts[:debug_auth_names] || ['accessToken', 'apiKey', 'customerId']
|
1043
|
+
|
1044
|
+
new_options = opts.merge(
|
1045
|
+
:operation => :"IntegrationsApi.list_conversations",
|
1046
|
+
:header_params => header_params,
|
1047
|
+
:query_params => query_params,
|
1048
|
+
:form_params => form_params,
|
1049
|
+
:body => post_body,
|
1050
|
+
:auth_names => auth_names,
|
1051
|
+
:return_type => return_type
|
1052
|
+
)
|
1053
|
+
|
1054
|
+
data, status_code, headers, response = @api_client.call_api(:GET, local_var_path, new_options)
|
1055
|
+
if @api_client.config.debugging
|
1056
|
+
@api_client.config.logger.debug "API called: IntegrationsApi#list_conversations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1057
|
+
end
|
1058
|
+
APIResponse::new(data, status_code, headers, response)
|
1059
|
+
end
|
1060
|
+
|
1061
|
+
|
945
1062
|
# List Data Source Items
|
946
1063
|
#
|
947
1064
|
# @param data_source_id [Integer]
|
@@ -1523,7 +1640,7 @@ module Carbon
|
|
1523
1640
|
# @param file_sync_config [FileSyncConfigNullable]
|
1524
1641
|
# @param body [SyncFilesRequest]
|
1525
1642
|
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
1526
|
-
def sync_confluence(data_source_id:, ids:, tags: SENTINEL, chunk_size: 1500, chunk_overlap: 20, skip_embedding_generation: false, embedding_model: 'OPENAI', generate_sparse_vectors: false, prepend_filename_to_chunks: false, max_items_per_chunk: SENTINEL, set_page_as_boundary: false, request_id: '
|
1643
|
+
def sync_confluence(data_source_id:, ids:, tags: SENTINEL, chunk_size: 1500, chunk_overlap: 20, skip_embedding_generation: false, embedding_model: 'OPENAI', generate_sparse_vectors: false, prepend_filename_to_chunks: false, max_items_per_chunk: SENTINEL, set_page_as_boundary: false, request_id: '9e2d7dc0-7a78-49fa-9f68-a411cfa13267', use_ocr: false, parse_pdf_tables_with_ocr: false, incremental_sync: false, file_sync_config: SENTINEL, extra: {})
|
1527
1644
|
_body = {}
|
1528
1645
|
_body[:tags] = tags if tags != SENTINEL
|
1529
1646
|
_body[:data_source_id] = data_source_id if data_source_id != SENTINEL
|
@@ -1571,7 +1688,7 @@ module Carbon
|
|
1571
1688
|
# @param file_sync_config [FileSyncConfigNullable]
|
1572
1689
|
# @param body [SyncFilesRequest]
|
1573
1690
|
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
1574
|
-
def sync_confluence_with_http_info(data_source_id:, ids:, tags: SENTINEL, chunk_size: 1500, chunk_overlap: 20, skip_embedding_generation: false, embedding_model: 'OPENAI', generate_sparse_vectors: false, prepend_filename_to_chunks: false, max_items_per_chunk: SENTINEL, set_page_as_boundary: false, request_id: '
|
1691
|
+
def sync_confluence_with_http_info(data_source_id:, ids:, tags: SENTINEL, chunk_size: 1500, chunk_overlap: 20, skip_embedding_generation: false, embedding_model: 'OPENAI', generate_sparse_vectors: false, prepend_filename_to_chunks: false, max_items_per_chunk: SENTINEL, set_page_as_boundary: false, request_id: '9e2d7dc0-7a78-49fa-9f68-a411cfa13267', use_ocr: false, parse_pdf_tables_with_ocr: false, incremental_sync: false, file_sync_config: SENTINEL, extra: {})
|
1575
1692
|
_body = {}
|
1576
1693
|
_body[:tags] = tags if tags != SENTINEL
|
1577
1694
|
_body[:data_source_id] = data_source_id if data_source_id != SENTINEL
|
@@ -1779,7 +1896,7 @@ module Carbon
|
|
1779
1896
|
# @param file_sync_config [FileSyncConfigNullable]
|
1780
1897
|
# @param body [SyncFilesRequest]
|
1781
1898
|
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
1782
|
-
def sync_files(data_source_id:, ids:, tags: SENTINEL, chunk_size: 1500, chunk_overlap: 20, skip_embedding_generation: false, embedding_model: 'OPENAI', generate_sparse_vectors: false, prepend_filename_to_chunks: false, max_items_per_chunk: SENTINEL, set_page_as_boundary: false, request_id: '
|
1899
|
+
def sync_files(data_source_id:, ids:, tags: SENTINEL, chunk_size: 1500, chunk_overlap: 20, skip_embedding_generation: false, embedding_model: 'OPENAI', generate_sparse_vectors: false, prepend_filename_to_chunks: false, max_items_per_chunk: SENTINEL, set_page_as_boundary: false, request_id: '9e2d7dc0-7a78-49fa-9f68-a411cfa13267', use_ocr: false, parse_pdf_tables_with_ocr: false, incremental_sync: false, file_sync_config: SENTINEL, extra: {})
|
1783
1900
|
_body = {}
|
1784
1901
|
_body[:tags] = tags if tags != SENTINEL
|
1785
1902
|
_body[:data_source_id] = data_source_id if data_source_id != SENTINEL
|
@@ -1827,7 +1944,7 @@ module Carbon
|
|
1827
1944
|
# @param file_sync_config [FileSyncConfigNullable]
|
1828
1945
|
# @param body [SyncFilesRequest]
|
1829
1946
|
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
1830
|
-
def sync_files_with_http_info(data_source_id:, ids:, tags: SENTINEL, chunk_size: 1500, chunk_overlap: 20, skip_embedding_generation: false, embedding_model: 'OPENAI', generate_sparse_vectors: false, prepend_filename_to_chunks: false, max_items_per_chunk: SENTINEL, set_page_as_boundary: false, request_id: '
|
1947
|
+
def sync_files_with_http_info(data_source_id:, ids:, tags: SENTINEL, chunk_size: 1500, chunk_overlap: 20, skip_embedding_generation: false, embedding_model: 'OPENAI', generate_sparse_vectors: false, prepend_filename_to_chunks: false, max_items_per_chunk: SENTINEL, set_page_as_boundary: false, request_id: '9e2d7dc0-7a78-49fa-9f68-a411cfa13267', use_ocr: false, parse_pdf_tables_with_ocr: false, incremental_sync: false, file_sync_config: SENTINEL, extra: {})
|
1831
1948
|
_body = {}
|
1832
1949
|
_body[:tags] = tags if tags != SENTINEL
|
1833
1950
|
_body[:data_source_id] = data_source_id if data_source_id != SENTINEL
|
@@ -3062,6 +3179,142 @@ module Carbon
|
|
3062
3179
|
end
|
3063
3180
|
APIResponse::new(data, status_code, headers, response)
|
3064
3181
|
end
|
3182
|
+
|
3183
|
+
|
3184
|
+
# Slack Sync
|
3185
|
+
#
|
3186
|
+
# You can list all conversations using the endpoint /integrations/slack/conversations. The ID of
|
3187
|
+
# conversation will be used as an input for this endpoint with timestamps as optional filters.
|
3188
|
+
#
|
3189
|
+
# @param filters [SlackFilters]
|
3190
|
+
# @param tags [Object]
|
3191
|
+
# @param chunk_size [Integer]
|
3192
|
+
# @param chunk_overlap [Integer]
|
3193
|
+
# @param skip_embedding_generation [Boolean]
|
3194
|
+
# @param embedding_model [EmbeddingGenerators]
|
3195
|
+
# @param generate_sparse_vectors [Boolean]
|
3196
|
+
# @param prepend_filename_to_chunks [Boolean]
|
3197
|
+
# @param data_source_id [Integer]
|
3198
|
+
# @param request_id [String]
|
3199
|
+
# @param body [SlackSyncRequest]
|
3200
|
+
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
3201
|
+
def sync_slack(filters:, tags: SENTINEL, chunk_size: 1500, chunk_overlap: 20, skip_embedding_generation: false, embedding_model: 'OPENAI', generate_sparse_vectors: false, prepend_filename_to_chunks: false, data_source_id: SENTINEL, request_id: SENTINEL, extra: {})
|
3202
|
+
_body = {}
|
3203
|
+
_body[:tags] = tags if tags != SENTINEL
|
3204
|
+
_body[:filters] = filters if filters != SENTINEL
|
3205
|
+
_body[:chunk_size] = chunk_size if chunk_size != SENTINEL
|
3206
|
+
_body[:chunk_overlap] = chunk_overlap if chunk_overlap != SENTINEL
|
3207
|
+
_body[:skip_embedding_generation] = skip_embedding_generation if skip_embedding_generation != SENTINEL
|
3208
|
+
_body[:embedding_model] = embedding_model if embedding_model != SENTINEL
|
3209
|
+
_body[:generate_sparse_vectors] = generate_sparse_vectors if generate_sparse_vectors != SENTINEL
|
3210
|
+
_body[:prepend_filename_to_chunks] = prepend_filename_to_chunks if prepend_filename_to_chunks != SENTINEL
|
3211
|
+
_body[:data_source_id] = data_source_id if data_source_id != SENTINEL
|
3212
|
+
_body[:request_id] = request_id if request_id != SENTINEL
|
3213
|
+
slack_sync_request = _body
|
3214
|
+
api_response = sync_slack_with_http_info_impl(slack_sync_request, extra)
|
3215
|
+
api_response.data
|
3216
|
+
end
|
3217
|
+
|
3218
|
+
# Slack Sync
|
3219
|
+
#
|
3220
|
+
# You can list all conversations using the endpoint /integrations/slack/conversations. The ID of
|
3221
|
+
# conversation will be used as an input for this endpoint with timestamps as optional filters.
|
3222
|
+
#
|
3223
|
+
# @param filters [SlackFilters]
|
3224
|
+
# @param tags [Object]
|
3225
|
+
# @param chunk_size [Integer]
|
3226
|
+
# @param chunk_overlap [Integer]
|
3227
|
+
# @param skip_embedding_generation [Boolean]
|
3228
|
+
# @param embedding_model [EmbeddingGenerators]
|
3229
|
+
# @param generate_sparse_vectors [Boolean]
|
3230
|
+
# @param prepend_filename_to_chunks [Boolean]
|
3231
|
+
# @param data_source_id [Integer]
|
3232
|
+
# @param request_id [String]
|
3233
|
+
# @param body [SlackSyncRequest]
|
3234
|
+
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
3235
|
+
def sync_slack_with_http_info(filters:, tags: SENTINEL, chunk_size: 1500, chunk_overlap: 20, skip_embedding_generation: false, embedding_model: 'OPENAI', generate_sparse_vectors: false, prepend_filename_to_chunks: false, data_source_id: SENTINEL, request_id: SENTINEL, extra: {})
|
3236
|
+
_body = {}
|
3237
|
+
_body[:tags] = tags if tags != SENTINEL
|
3238
|
+
_body[:filters] = filters if filters != SENTINEL
|
3239
|
+
_body[:chunk_size] = chunk_size if chunk_size != SENTINEL
|
3240
|
+
_body[:chunk_overlap] = chunk_overlap if chunk_overlap != SENTINEL
|
3241
|
+
_body[:skip_embedding_generation] = skip_embedding_generation if skip_embedding_generation != SENTINEL
|
3242
|
+
_body[:embedding_model] = embedding_model if embedding_model != SENTINEL
|
3243
|
+
_body[:generate_sparse_vectors] = generate_sparse_vectors if generate_sparse_vectors != SENTINEL
|
3244
|
+
_body[:prepend_filename_to_chunks] = prepend_filename_to_chunks if prepend_filename_to_chunks != SENTINEL
|
3245
|
+
_body[:data_source_id] = data_source_id if data_source_id != SENTINEL
|
3246
|
+
_body[:request_id] = request_id if request_id != SENTINEL
|
3247
|
+
slack_sync_request = _body
|
3248
|
+
sync_slack_with_http_info_impl(slack_sync_request, extra)
|
3249
|
+
end
|
3250
|
+
|
3251
|
+
# Slack Sync
|
3252
|
+
# You can list all conversations using the endpoint /integrations/slack/conversations. The ID of conversation will be used as an input for this endpoint with timestamps as optional filters.
|
3253
|
+
# @param slack_sync_request [SlackSyncRequest]
|
3254
|
+
# @param [Hash] opts the optional parameters
|
3255
|
+
# @return [Object]
|
3256
|
+
private def sync_slack_impl(slack_sync_request, opts = {})
|
3257
|
+
data, _status_code, _headers = sync_slack_with_http_info(slack_sync_request, opts)
|
3258
|
+
data
|
3259
|
+
end
|
3260
|
+
|
3261
|
+
# Slack Sync
|
3262
|
+
# You can list all conversations using the endpoint /integrations/slack/conversations. The ID of conversation will be used as an input for this endpoint with timestamps as optional filters.
|
3263
|
+
# @param slack_sync_request [SlackSyncRequest]
|
3264
|
+
# @param [Hash] opts the optional parameters
|
3265
|
+
# @return [APIResponse] data is Object, status code, headers and response
|
3266
|
+
private def sync_slack_with_http_info_impl(slack_sync_request, opts = {})
|
3267
|
+
if @api_client.config.debugging
|
3268
|
+
@api_client.config.logger.debug 'Calling API: IntegrationsApi.sync_slack ...'
|
3269
|
+
end
|
3270
|
+
# verify the required parameter 'slack_sync_request' is set
|
3271
|
+
if @api_client.config.client_side_validation && slack_sync_request.nil?
|
3272
|
+
fail ArgumentError, "Missing the required parameter 'slack_sync_request' when calling IntegrationsApi.sync_slack"
|
3273
|
+
end
|
3274
|
+
# resource path
|
3275
|
+
local_var_path = '/integrations/slack/sync'
|
3276
|
+
|
3277
|
+
# query parameters
|
3278
|
+
query_params = opts[:query_params] || {}
|
3279
|
+
|
3280
|
+
# header parameters
|
3281
|
+
header_params = opts[:header_params] || {}
|
3282
|
+
# HTTP header 'Accept' (if needed)
|
3283
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
3284
|
+
# HTTP header 'Content-Type'
|
3285
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
3286
|
+
if !content_type.nil?
|
3287
|
+
header_params['Content-Type'] = content_type
|
3288
|
+
end
|
3289
|
+
|
3290
|
+
# form parameters
|
3291
|
+
form_params = opts[:form_params] || {}
|
3292
|
+
|
3293
|
+
# http body (model)
|
3294
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(slack_sync_request)
|
3295
|
+
|
3296
|
+
# return_type
|
3297
|
+
return_type = opts[:debug_return_type] || 'Object'
|
3298
|
+
|
3299
|
+
# auth_names
|
3300
|
+
auth_names = opts[:debug_auth_names] || ['accessToken', 'apiKey', 'customerId']
|
3301
|
+
|
3302
|
+
new_options = opts.merge(
|
3303
|
+
:operation => :"IntegrationsApi.sync_slack",
|
3304
|
+
:header_params => header_params,
|
3305
|
+
:query_params => query_params,
|
3306
|
+
:form_params => form_params,
|
3307
|
+
:body => post_body,
|
3308
|
+
:auth_names => auth_names,
|
3309
|
+
:return_type => return_type
|
3310
|
+
)
|
3311
|
+
|
3312
|
+
data, status_code, headers, response = @api_client.call_api(:POST, local_var_path, new_options)
|
3313
|
+
if @api_client.config.debugging
|
3314
|
+
@api_client.config.logger.debug "API called: IntegrationsApi#sync_slack\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
3315
|
+
end
|
3316
|
+
APIResponse::new(data, status_code, headers, response)
|
3317
|
+
end
|
3065
3318
|
end
|
3066
3319
|
|
3067
3320
|
# top-level client access to avoid having the user to insantiate their own API instances
|