carbon_ruby_sdk 0.2.43 → 0.2.45

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: '0041088eca440b5e23106b5a61b6631c6bbde015033004d3c84ed205a1f8c3dc'
4
- data.tar.gz: d8f21fbc6d1ef0183689fb980f05da068930ae611a06d83464411eb708316099
3
+ metadata.gz: 3596d6a655628cbcaca3380a239bb5a771a2221f3d2e432604b902afcc4aca49
4
+ data.tar.gz: 1d66ea20c061d8130237dac15c9e3d03d3e3a7ead69a09fec5f37a0021b81be5
5
5
  SHA512:
6
- metadata.gz: 5ab2fe2c38087f093e086a2a9127acee8e9c7fcfb40cf763eee594d128579dbb02b0a33045ba9bf5bbf6c5c5b2ae382d2e01500c6a95df2cc85f7c0f7ad3e0da
7
- data.tar.gz: 83c6428340b06c799b908b818172ad17b5bc3b78b3016374572ac64211f23d78a7357418ddbbc57f61a5842654ced1da1dddf409117bdc40982bc469a1ee4113
6
+ metadata.gz: c4f1137585807b233474b437e63e9c15558adc2fcf9d35a5ff78821bdf48f6af84a5db3902e7583c61c663450856461c2c7536e733a0d1d6a70cba811791ee47
7
+ data.tar.gz: cc2e293275002a11f8adcdc4179e593a03bbf4289c25b4edd545dde368c6a25bd69a1848a7f2ab55a4e54041e58fbf8541f1c7a20f56aa2482bc971ed1008573
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- carbon_ruby_sdk (0.2.43)
4
+ carbon_ruby_sdk (0.2.45)
5
5
  faraday (>= 1.0.1, < 3.0)
6
6
  faraday-multipart (~> 1.0, >= 1.0.4)
7
7
 
@@ -44,7 +44,7 @@ GEM
44
44
  regexp_parser (2.9.2)
45
45
  reline (0.5.10)
46
46
  io-console (~> 0.5)
47
- rexml (3.3.8)
47
+ rexml (3.3.9)
48
48
  rspec (3.13.0)
49
49
  rspec-core (~> 3.13.0)
50
50
  rspec-expectations (~> 3.13.0)
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.43-blue)](https://rubygems.org/gems/carbon_ruby_sdk/versions/0.2.43)
9
+ [![npm](https://img.shields.io/badge/gem-v0.2.45-blue)](https://rubygems.org/gems/carbon_ruby_sdk/versions/0.2.45)
10
10
 
11
11
  </div>
12
12
 
@@ -118,7 +118,7 @@ Connect external data to LLMs, no matter the source.
118
118
  Add to Gemfile:
119
119
 
120
120
  ```ruby
121
- gem 'carbon_ruby_sdk', '~> 0.2.43'
121
+ gem 'carbon_ruby_sdk', '~> 0.2.45'
122
122
  ```
123
123
 
124
124
  ## Getting Started<a id="getting-started"></a>
@@ -577,6 +577,7 @@ result = carbon.data_sources.query_user_data_sources(
577
577
  pagination: {
578
578
  "limit" => 10,
579
579
  "offset" => 0,
580
+ "starting_id" => 0,
580
581
  },
581
582
  order_by: "created_at",
582
583
  order_dir: "desc",
@@ -906,6 +907,7 @@ result = carbon.embeddings.get_embeddings_and_chunks(
906
907
  pagination: {
907
908
  "limit" => 10,
908
909
  "offset" => 0,
910
+ "starting_id" => 0,
909
911
  },
910
912
  order_by: "created_at",
911
913
  order_dir: "desc",
@@ -949,6 +951,7 @@ result = carbon.embeddings.list(
949
951
  pagination: {
950
952
  "limit" => 10,
951
953
  "offset" => 0,
954
+ "starting_id" => 0,
952
955
  },
953
956
  order_by: "created_at",
954
957
  order_dir: "desc",
@@ -1397,6 +1400,7 @@ result = carbon.files.query_user_files(
1397
1400
  pagination: {
1398
1401
  "limit" => 10,
1399
1402
  "offset" => 0,
1403
+ "starting_id" => 0,
1400
1404
  },
1401
1405
  order_by: "created_at",
1402
1406
  order_dir: "desc",
@@ -1407,6 +1411,7 @@ result = carbon.files.query_user_files(
1407
1411
  include_raw_file: true,
1408
1412
  include_parsed_text_file: true,
1409
1413
  include_additional_files: true,
1414
+ presigned_url_expiry_time_seconds: 3600,
1410
1415
  )
1411
1416
  p result
1412
1417
  ```
@@ -1414,12 +1419,33 @@ p result
1414
1419
  #### ⚙️ Parameters<a id="⚙️-parameters"></a>
1415
1420
 
1416
1421
  ##### pagination: [`Pagination`](./lib/carbon_ruby_sdk/models/pagination.rb)<a id="pagination-paginationlibcarbon_ruby_sdkmodelspaginationrb"></a>
1422
+ Pagination parameters for the query.
1423
+
1417
1424
  ##### order_by: [`OrganizationUserFilesToSyncOrderByTypes`](./lib/carbon_ruby_sdk/models/organization_user_files_to_sync_order_by_types.rb)<a id="order_by-organizationuserfilestosyncorderbytypeslibcarbon_ruby_sdkmodelsorganization_user_files_to_sync_order_by_typesrb"></a>
1425
+ The field on OrganizationUserFilesToSYnc to order the results by.
1426
+
1418
1427
  ##### order_dir: [`OrderDir`](./lib/carbon_ruby_sdk/models/order_dir.rb)<a id="order_dir-orderdirlibcarbon_ruby_sdkmodelsorder_dirrb"></a>
1428
+ The direction to order the results by.
1429
+
1419
1430
  ##### filters: [`OrganizationUserFilesToSyncFilters`](./lib/carbon_ruby_sdk/models/organization_user_files_to_sync_filters.rb)<a id="filters-organizationuserfilestosyncfilterslibcarbon_ruby_sdkmodelsorganization_user_files_to_sync_filtersrb"></a>
1431
+ Filters to apply to the query.
1432
+
1420
1433
  ##### include_raw_file: `Boolean`<a id="include_raw_file-boolean"></a>
1434
+ If true, the query will return presigned URLs for the raw file. Only relevant
1435
+ for the /user_files_v2 endpoint.
1436
+
1421
1437
  ##### include_parsed_text_file: `Boolean`<a id="include_parsed_text_file-boolean"></a>
1438
+ If true, the query will return presigned URLs for the parsed text file. Only
1439
+ relevant for the /user_files_v2 endpoint.
1440
+
1422
1441
  ##### include_additional_files: `Boolean`<a id="include_additional_files-boolean"></a>
1442
+ If true, the query will return presigned URLs for additional files. Only
1443
+ relevant for the /user_files_v2 endpoint.
1444
+
1445
+ ##### presigned_url_expiry_time_seconds: `Integer`<a id="presigned_url_expiry_time_seconds-integer"></a>
1446
+ The expiry time for the presigned URLs. Only relevant for the /user_files_v2
1447
+ endpoint.
1448
+
1423
1449
  #### 🔄 Return<a id="🔄-return"></a>
1424
1450
 
1425
1451
  [UserFilesV2](./lib/carbon_ruby_sdk/models/user_files_v2.rb)
@@ -1445,6 +1471,7 @@ result = carbon.files.query_user_files_deprecated(
1445
1471
  pagination: {
1446
1472
  "limit" => 10,
1447
1473
  "offset" => 0,
1474
+ "starting_id" => 0,
1448
1475
  },
1449
1476
  order_by: "created_at",
1450
1477
  order_dir: "desc",
@@ -1455,6 +1482,7 @@ result = carbon.files.query_user_files_deprecated(
1455
1482
  include_raw_file: true,
1456
1483
  include_parsed_text_file: true,
1457
1484
  include_additional_files: true,
1485
+ presigned_url_expiry_time_seconds: 3600,
1458
1486
  )
1459
1487
  p result
1460
1488
  ```
@@ -1462,12 +1490,33 @@ p result
1462
1490
  #### ⚙️ Parameters<a id="⚙️-parameters"></a>
1463
1491
 
1464
1492
  ##### pagination: [`Pagination`](./lib/carbon_ruby_sdk/models/pagination.rb)<a id="pagination-paginationlibcarbon_ruby_sdkmodelspaginationrb"></a>
1493
+ Pagination parameters for the query.
1494
+
1465
1495
  ##### order_by: [`OrganizationUserFilesToSyncOrderByTypes`](./lib/carbon_ruby_sdk/models/organization_user_files_to_sync_order_by_types.rb)<a id="order_by-organizationuserfilestosyncorderbytypeslibcarbon_ruby_sdkmodelsorganization_user_files_to_sync_order_by_typesrb"></a>
1496
+ The field on OrganizationUserFilesToSYnc to order the results by.
1497
+
1466
1498
  ##### order_dir: [`OrderDir`](./lib/carbon_ruby_sdk/models/order_dir.rb)<a id="order_dir-orderdirlibcarbon_ruby_sdkmodelsorder_dirrb"></a>
1499
+ The direction to order the results by.
1500
+
1467
1501
  ##### filters: [`OrganizationUserFilesToSyncFilters`](./lib/carbon_ruby_sdk/models/organization_user_files_to_sync_filters.rb)<a id="filters-organizationuserfilestosyncfilterslibcarbon_ruby_sdkmodelsorganization_user_files_to_sync_filtersrb"></a>
1502
+ Filters to apply to the query.
1503
+
1468
1504
  ##### include_raw_file: `Boolean`<a id="include_raw_file-boolean"></a>
1505
+ If true, the query will return presigned URLs for the raw file. Only relevant
1506
+ for the /user_files_v2 endpoint.
1507
+
1469
1508
  ##### include_parsed_text_file: `Boolean`<a id="include_parsed_text_file-boolean"></a>
1509
+ If true, the query will return presigned URLs for the parsed text file. Only
1510
+ relevant for the /user_files_v2 endpoint.
1511
+
1470
1512
  ##### include_additional_files: `Boolean`<a id="include_additional_files-boolean"></a>
1513
+ If true, the query will return presigned URLs for additional files. Only
1514
+ relevant for the /user_files_v2 endpoint.
1515
+
1516
+ ##### presigned_url_expiry_time_seconds: `Integer`<a id="presigned_url_expiry_time_seconds-integer"></a>
1517
+ The expiry time for the presigned URLs. Only relevant for the /user_files_v2
1518
+ endpoint.
1519
+
1471
1520
  #### 🔄 Return<a id="🔄-return"></a>
1472
1521
 
1473
1522
  [UserFile](./lib/carbon_ruby_sdk/models/user_file.rb)
@@ -2470,6 +2519,7 @@ result = carbon.integrations.get_oauth_url(
2470
2519
  service: "BOX",
2471
2520
  tags: None,
2472
2521
  scope: "string_example",
2522
+ scopes: [],
2473
2523
  chunk_size: 1500,
2474
2524
  chunk_overlap: 20,
2475
2525
  skip_embedding_generation: false,
@@ -2521,6 +2571,11 @@ p result
2521
2571
  ##### service: [`OauthBasedConnectors`](./lib/carbon_ruby_sdk/models/oauth_based_connectors.rb)<a id="service-oauthbasedconnectorslibcarbon_ruby_sdkmodelsoauth_based_connectorsrb"></a>
2522
2572
  ##### tags: `Object`<a id="tags-object"></a>
2523
2573
  ##### scope: `String`<a id="scope-string"></a>
2574
+ ##### scopes: Array<`String`><a id="scopes-array"></a>
2575
+ List of scopes to request from the OAuth provider. Please that the scopes will
2576
+ be used as it is, not combined with the default props that Carbon uses. One
2577
+ scope should be one array element.
2578
+
2524
2579
  ##### chunk_size: `Integer`<a id="chunk_size-integer"></a>
2525
2580
  ##### chunk_overlap: `Integer`<a id="chunk_overlap-integer"></a>
2526
2581
  ##### skip_embedding_generation: `Boolean`<a id="skip_embedding_generation-boolean"></a>
@@ -2694,6 +2749,7 @@ result = carbon.integrations.list_data_source_items(
2694
2749
  pagination: {
2695
2750
  "limit" => 10,
2696
2751
  "offset" => 0,
2752
+ "starting_id" => 0,
2697
2753
  },
2698
2754
  order_by: "name",
2699
2755
  order_dir: "asc",
@@ -3882,6 +3938,7 @@ result = carbon.users.list(
3882
3938
  pagination: {
3883
3939
  "limit" => 10,
3884
3940
  "offset" => 0,
3941
+ "starting_id" => 0,
3885
3942
  },
3886
3943
  filters: {
3887
3944
  },
@@ -4375,6 +4432,7 @@ result = carbon.utilities.user_webpages(
4375
4432
  pagination: {
4376
4433
  "limit" => 10,
4377
4434
  "offset" => 0,
4435
+ "starting_id" => 0,
4378
4436
  },
4379
4437
  order_by: "created_at",
4380
4438
  order_dir: "asc",
@@ -4466,6 +4524,7 @@ result = carbon.webhooks.urls(
4466
4524
  pagination: {
4467
4525
  "limit" => 10,
4468
4526
  "offset" => 0,
4527
+ "starting_id" => 0,
4469
4528
  },
4470
4529
  order_by: "created_at",
4471
4530
  order_dir: "desc",
@@ -4566,6 +4625,7 @@ result = carbon.white_label.list(
4566
4625
  pagination: {
4567
4626
  "limit" => 10,
4568
4627
  "offset" => 0,
4628
+ "starting_id" => 0,
4569
4629
  },
4570
4630
  order_by: "created_at",
4571
4631
  order_dir: "desc",
@@ -936,16 +936,17 @@ module Carbon
936
936
  # 3. "negate" is optional and must be `true` or `false`. If present and `true`, then the filter block is negated in
937
937
  # the resulting query. It is `false` by default.
938
938
  #
939
- # @param pagination [Pagination]
940
- # @param order_by [OrganizationUserFilesToSyncOrderByTypes]
941
- # @param order_dir [OrderDir]
942
- # @param filters [OrganizationUserFilesToSyncFilters]
943
- # @param include_raw_file [Boolean]
944
- # @param include_parsed_text_file [Boolean]
945
- # @param include_additional_files [Boolean]
939
+ # @param pagination [Pagination] Pagination parameters for the query.
940
+ # @param order_by [OrganizationUserFilesToSyncOrderByTypes] The field on OrganizationUserFilesToSYnc to order the results by.
941
+ # @param order_dir [OrderDir] The direction to order the results by.
942
+ # @param filters [OrganizationUserFilesToSyncFilters] Filters to apply to the query.
943
+ # @param include_raw_file [Boolean] If true, the query will return presigned URLs for the raw file. Only relevant for the /user_files_v2 endpoint.
944
+ # @param include_parsed_text_file [Boolean] If true, the query will return presigned URLs for the parsed text file. Only relevant for the /user_files_v2 endpoint.
945
+ # @param include_additional_files [Boolean] If true, the query will return presigned URLs for additional files. Only relevant for the /user_files_v2 endpoint.
946
+ # @param presigned_url_expiry_time_seconds [Integer] The expiry time for the presigned URLs. Only relevant for the /user_files_v2 endpoint.
946
947
  # @param body [OrganizationUserFilesToSyncQueryInput]
947
948
  # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
948
- def query_user_files(pagination: SENTINEL, order_by: 'updated_at', order_dir: 'asc', filters: SENTINEL, include_raw_file: SENTINEL, include_parsed_text_file: SENTINEL, include_additional_files: SENTINEL, extra: {})
949
+ def query_user_files(pagination: SENTINEL, order_by: 'updated_at', order_dir: 'asc', filters: SENTINEL, include_raw_file: SENTINEL, include_parsed_text_file: SENTINEL, include_additional_files: SENTINEL, presigned_url_expiry_time_seconds: 3600, extra: {})
949
950
  _body = {}
950
951
  _body[:pagination] = pagination if pagination != SENTINEL
951
952
  _body[:order_by] = order_by if order_by != SENTINEL
@@ -954,6 +955,7 @@ module Carbon
954
955
  _body[:include_raw_file] = include_raw_file if include_raw_file != SENTINEL
955
956
  _body[:include_parsed_text_file] = include_parsed_text_file if include_parsed_text_file != SENTINEL
956
957
  _body[:include_additional_files] = include_additional_files if include_additional_files != SENTINEL
958
+ _body[:presigned_url_expiry_time_seconds] = presigned_url_expiry_time_seconds if presigned_url_expiry_time_seconds != SENTINEL
957
959
  organization_user_files_to_sync_query_input = _body
958
960
  api_response = query_user_files_with_http_info_impl(organization_user_files_to_sync_query_input, extra)
959
961
  api_response.data
@@ -1012,16 +1014,17 @@ module Carbon
1012
1014
  # 3. "negate" is optional and must be `true` or `false`. If present and `true`, then the filter block is negated in
1013
1015
  # the resulting query. It is `false` by default.
1014
1016
  #
1015
- # @param pagination [Pagination]
1016
- # @param order_by [OrganizationUserFilesToSyncOrderByTypes]
1017
- # @param order_dir [OrderDir]
1018
- # @param filters [OrganizationUserFilesToSyncFilters]
1019
- # @param include_raw_file [Boolean]
1020
- # @param include_parsed_text_file [Boolean]
1021
- # @param include_additional_files [Boolean]
1017
+ # @param pagination [Pagination] Pagination parameters for the query.
1018
+ # @param order_by [OrganizationUserFilesToSyncOrderByTypes] The field on OrganizationUserFilesToSYnc to order the results by.
1019
+ # @param order_dir [OrderDir] The direction to order the results by.
1020
+ # @param filters [OrganizationUserFilesToSyncFilters] Filters to apply to the query.
1021
+ # @param include_raw_file [Boolean] If true, the query will return presigned URLs for the raw file. Only relevant for the /user_files_v2 endpoint.
1022
+ # @param include_parsed_text_file [Boolean] If true, the query will return presigned URLs for the parsed text file. Only relevant for the /user_files_v2 endpoint.
1023
+ # @param include_additional_files [Boolean] If true, the query will return presigned URLs for additional files. Only relevant for the /user_files_v2 endpoint.
1024
+ # @param presigned_url_expiry_time_seconds [Integer] The expiry time for the presigned URLs. Only relevant for the /user_files_v2 endpoint.
1022
1025
  # @param body [OrganizationUserFilesToSyncQueryInput]
1023
1026
  # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
1024
- def query_user_files_with_http_info(pagination: SENTINEL, order_by: 'updated_at', order_dir: 'asc', filters: SENTINEL, include_raw_file: SENTINEL, include_parsed_text_file: SENTINEL, include_additional_files: SENTINEL, extra: {})
1027
+ def query_user_files_with_http_info(pagination: SENTINEL, order_by: 'updated_at', order_dir: 'asc', filters: SENTINEL, include_raw_file: SENTINEL, include_parsed_text_file: SENTINEL, include_additional_files: SENTINEL, presigned_url_expiry_time_seconds: 3600, extra: {})
1025
1028
  _body = {}
1026
1029
  _body[:pagination] = pagination if pagination != SENTINEL
1027
1030
  _body[:order_by] = order_by if order_by != SENTINEL
@@ -1030,6 +1033,7 @@ module Carbon
1030
1033
  _body[:include_raw_file] = include_raw_file if include_raw_file != SENTINEL
1031
1034
  _body[:include_parsed_text_file] = include_parsed_text_file if include_parsed_text_file != SENTINEL
1032
1035
  _body[:include_additional_files] = include_additional_files if include_additional_files != SENTINEL
1036
+ _body[:presigned_url_expiry_time_seconds] = presigned_url_expiry_time_seconds if presigned_url_expiry_time_seconds != SENTINEL
1033
1037
  organization_user_files_to_sync_query_input = _body
1034
1038
  query_user_files_with_http_info_impl(organization_user_files_to_sync_query_input, extra)
1035
1039
  end
@@ -1107,16 +1111,17 @@ module Carbon
1107
1111
  #
1108
1112
  # This route is deprecated. Use `/user_files_v2` instead.
1109
1113
  #
1110
- # @param pagination [Pagination]
1111
- # @param order_by [OrganizationUserFilesToSyncOrderByTypes]
1112
- # @param order_dir [OrderDir]
1113
- # @param filters [OrganizationUserFilesToSyncFilters]
1114
- # @param include_raw_file [Boolean]
1115
- # @param include_parsed_text_file [Boolean]
1116
- # @param include_additional_files [Boolean]
1114
+ # @param pagination [Pagination] Pagination parameters for the query.
1115
+ # @param order_by [OrganizationUserFilesToSyncOrderByTypes] The field on OrganizationUserFilesToSYnc to order the results by.
1116
+ # @param order_dir [OrderDir] The direction to order the results by.
1117
+ # @param filters [OrganizationUserFilesToSyncFilters] Filters to apply to the query.
1118
+ # @param include_raw_file [Boolean] If true, the query will return presigned URLs for the raw file. Only relevant for the /user_files_v2 endpoint.
1119
+ # @param include_parsed_text_file [Boolean] If true, the query will return presigned URLs for the parsed text file. Only relevant for the /user_files_v2 endpoint.
1120
+ # @param include_additional_files [Boolean] If true, the query will return presigned URLs for additional files. Only relevant for the /user_files_v2 endpoint.
1121
+ # @param presigned_url_expiry_time_seconds [Integer] The expiry time for the presigned URLs. Only relevant for the /user_files_v2 endpoint.
1117
1122
  # @param body [OrganizationUserFilesToSyncQueryInput]
1118
1123
  # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
1119
- def query_user_files_deprecated(pagination: SENTINEL, order_by: 'updated_at', order_dir: 'asc', filters: SENTINEL, include_raw_file: SENTINEL, include_parsed_text_file: SENTINEL, include_additional_files: SENTINEL, extra: {})
1124
+ def query_user_files_deprecated(pagination: SENTINEL, order_by: 'updated_at', order_dir: 'asc', filters: SENTINEL, include_raw_file: SENTINEL, include_parsed_text_file: SENTINEL, include_additional_files: SENTINEL, presigned_url_expiry_time_seconds: 3600, extra: {})
1120
1125
  _body = {}
1121
1126
  _body[:pagination] = pagination if pagination != SENTINEL
1122
1127
  _body[:order_by] = order_by if order_by != SENTINEL
@@ -1125,6 +1130,7 @@ module Carbon
1125
1130
  _body[:include_raw_file] = include_raw_file if include_raw_file != SENTINEL
1126
1131
  _body[:include_parsed_text_file] = include_parsed_text_file if include_parsed_text_file != SENTINEL
1127
1132
  _body[:include_additional_files] = include_additional_files if include_additional_files != SENTINEL
1133
+ _body[:presigned_url_expiry_time_seconds] = presigned_url_expiry_time_seconds if presigned_url_expiry_time_seconds != SENTINEL
1128
1134
  organization_user_files_to_sync_query_input = _body
1129
1135
  api_response = query_user_files_deprecated_with_http_info_impl(organization_user_files_to_sync_query_input, extra)
1130
1136
  api_response.data
@@ -1134,16 +1140,17 @@ module Carbon
1134
1140
  #
1135
1141
  # This route is deprecated. Use `/user_files_v2` instead.
1136
1142
  #
1137
- # @param pagination [Pagination]
1138
- # @param order_by [OrganizationUserFilesToSyncOrderByTypes]
1139
- # @param order_dir [OrderDir]
1140
- # @param filters [OrganizationUserFilesToSyncFilters]
1141
- # @param include_raw_file [Boolean]
1142
- # @param include_parsed_text_file [Boolean]
1143
- # @param include_additional_files [Boolean]
1143
+ # @param pagination [Pagination] Pagination parameters for the query.
1144
+ # @param order_by [OrganizationUserFilesToSyncOrderByTypes] The field on OrganizationUserFilesToSYnc to order the results by.
1145
+ # @param order_dir [OrderDir] The direction to order the results by.
1146
+ # @param filters [OrganizationUserFilesToSyncFilters] Filters to apply to the query.
1147
+ # @param include_raw_file [Boolean] If true, the query will return presigned URLs for the raw file. Only relevant for the /user_files_v2 endpoint.
1148
+ # @param include_parsed_text_file [Boolean] If true, the query will return presigned URLs for the parsed text file. Only relevant for the /user_files_v2 endpoint.
1149
+ # @param include_additional_files [Boolean] If true, the query will return presigned URLs for additional files. Only relevant for the /user_files_v2 endpoint.
1150
+ # @param presigned_url_expiry_time_seconds [Integer] The expiry time for the presigned URLs. Only relevant for the /user_files_v2 endpoint.
1144
1151
  # @param body [OrganizationUserFilesToSyncQueryInput]
1145
1152
  # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
1146
- def query_user_files_deprecated_with_http_info(pagination: SENTINEL, order_by: 'updated_at', order_dir: 'asc', filters: SENTINEL, include_raw_file: SENTINEL, include_parsed_text_file: SENTINEL, include_additional_files: SENTINEL, extra: {})
1153
+ def query_user_files_deprecated_with_http_info(pagination: SENTINEL, order_by: 'updated_at', order_dir: 'asc', filters: SENTINEL, include_raw_file: SENTINEL, include_parsed_text_file: SENTINEL, include_additional_files: SENTINEL, presigned_url_expiry_time_seconds: 3600, extra: {})
1147
1154
  _body = {}
1148
1155
  _body[:pagination] = pagination if pagination != SENTINEL
1149
1156
  _body[:order_by] = order_by if order_by != SENTINEL
@@ -1152,6 +1159,7 @@ module Carbon
1152
1159
  _body[:include_raw_file] = include_raw_file if include_raw_file != SENTINEL
1153
1160
  _body[:include_parsed_text_file] = include_parsed_text_file if include_parsed_text_file != SENTINEL
1154
1161
  _body[:include_additional_files] = include_additional_files if include_additional_files != SENTINEL
1162
+ _body[:presigned_url_expiry_time_seconds] = presigned_url_expiry_time_seconds if presigned_url_expiry_time_seconds != SENTINEL
1155
1163
  organization_user_files_to_sync_query_input = _body
1156
1164
  query_user_files_deprecated_with_http_info_impl(organization_user_files_to_sync_query_input, extra)
1157
1165
  end
@@ -812,6 +812,7 @@ module Carbon
812
812
  # @param service [OauthBasedConnectors]
813
813
  # @param tags [Object]
814
814
  # @param scope [String]
815
+ # @param scopes [Array<String>] List of scopes to request from the OAuth provider. Please that the scopes will be used as it is, not combined with the default props that Carbon uses. One scope should be one array element.
815
816
  # @param chunk_size [Integer]
816
817
  # @param chunk_overlap [Integer]
817
818
  # @param skip_embedding_generation [Boolean]
@@ -841,10 +842,11 @@ module Carbon
841
842
  # @param data_source_tags [Object] Tags to be associated with the data source. If the data source already has tags set, then an upsert will be performed.
842
843
  # @param body [OAuthURLRequest]
843
844
  # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
844
- 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: SENTINEL, use_ocr: false, parse_pdf_tables_with_ocr: false, enable_file_picker: true, sync_source_items: true, incremental_sync: false, file_sync_config: SENTINEL, automatically_open_file_picker: SENTINEL, gong_account_email: SENTINEL, servicenow_credentials: SENTINEL, data_source_tags: SENTINEL, extra: {})
845
+ def get_oauth_url(service:, tags: SENTINEL, scope: SENTINEL, scopes: 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: SENTINEL, use_ocr: false, parse_pdf_tables_with_ocr: false, enable_file_picker: true, sync_source_items: true, incremental_sync: false, file_sync_config: SENTINEL, automatically_open_file_picker: SENTINEL, gong_account_email: SENTINEL, servicenow_credentials: SENTINEL, data_source_tags: SENTINEL, extra: {})
845
846
  _body = {}
846
847
  _body[:tags] = tags if tags != SENTINEL
847
848
  _body[:scope] = scope if scope != SENTINEL
849
+ _body[:scopes] = scopes if scopes != SENTINEL
848
850
  _body[:service] = service if service != SENTINEL
849
851
  _body[:chunk_size] = chunk_size if chunk_size != SENTINEL
850
852
  _body[:chunk_overlap] = chunk_overlap if chunk_overlap != SENTINEL
@@ -888,6 +890,7 @@ module Carbon
888
890
  # @param service [OauthBasedConnectors]
889
891
  # @param tags [Object]
890
892
  # @param scope [String]
893
+ # @param scopes [Array<String>] List of scopes to request from the OAuth provider. Please that the scopes will be used as it is, not combined with the default props that Carbon uses. One scope should be one array element.
891
894
  # @param chunk_size [Integer]
892
895
  # @param chunk_overlap [Integer]
893
896
  # @param skip_embedding_generation [Boolean]
@@ -917,10 +920,11 @@ module Carbon
917
920
  # @param data_source_tags [Object] Tags to be associated with the data source. If the data source already has tags set, then an upsert will be performed.
918
921
  # @param body [OAuthURLRequest]
919
922
  # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
920
- 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: SENTINEL, use_ocr: false, parse_pdf_tables_with_ocr: false, enable_file_picker: true, sync_source_items: true, incremental_sync: false, file_sync_config: SENTINEL, automatically_open_file_picker: SENTINEL, gong_account_email: SENTINEL, servicenow_credentials: SENTINEL, data_source_tags: SENTINEL, extra: {})
923
+ def get_oauth_url_with_http_info(service:, tags: SENTINEL, scope: SENTINEL, scopes: 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: SENTINEL, use_ocr: false, parse_pdf_tables_with_ocr: false, enable_file_picker: true, sync_source_items: true, incremental_sync: false, file_sync_config: SENTINEL, automatically_open_file_picker: SENTINEL, gong_account_email: SENTINEL, servicenow_credentials: SENTINEL, data_source_tags: SENTINEL, extra: {})
921
924
  _body = {}
922
925
  _body[:tags] = tags if tags != SENTINEL
923
926
  _body[:scope] = scope if scope != SENTINEL
927
+ _body[:scopes] = scopes if scopes != SENTINEL
924
928
  _body[:service] = service if service != SENTINEL
925
929
  _body[:chunk_size] = chunk_size if chunk_size != SENTINEL
926
930
  _body[:chunk_overlap] = chunk_overlap if chunk_overlap != SENTINEL
@@ -127,6 +127,7 @@ module Carbon
127
127
  :'source',
128
128
  :'refresh_token',
129
129
  :'tenant_name',
130
+ :'site_name',
130
131
  :'endpoint_url',
131
132
  ])
132
133
  end
@@ -273,10 +274,6 @@ module Carbon
273
274
  invalid_properties.push('invalid value for "workspace_id", workspace_id cannot be nil.')
274
275
  end
275
276
 
276
- if @site_name.nil?
277
- invalid_properties.push('invalid value for "site_name", site_name cannot be nil.')
278
- end
279
-
280
277
  if @subdomain.nil?
281
278
  invalid_properties.push('invalid value for "subdomain", subdomain cannot be nil.')
282
279
  end
@@ -349,7 +346,6 @@ module Carbon
349
346
  def valid?
350
347
  return false if @access_token.nil?
351
348
  return false if @workspace_id.nil?
352
- return false if @site_name.nil?
353
349
  return false if @subdomain.nil?
354
350
  return false if @access_token_secret.nil?
355
351
  return false if @username.nil?
@@ -15,6 +15,9 @@ module Carbon
15
15
 
16
16
  attr_accessor :scope
17
17
 
18
+ # List of scopes to request from the OAuth provider. Please that the scopes will be used as it is, not combined with the default props that Carbon uses. One scope should be one array element.
19
+ attr_accessor :scopes
20
+
18
21
  attr_accessor :service
19
22
 
20
23
  attr_accessor :chunk_size
@@ -88,6 +91,7 @@ module Carbon
88
91
  {
89
92
  :'tags' => :'tags',
90
93
  :'scope' => :'scope',
94
+ :'scopes' => :'scopes',
91
95
  :'service' => :'service',
92
96
  :'chunk_size' => :'chunk_size',
93
97
  :'chunk_overlap' => :'chunk_overlap',
@@ -129,6 +133,7 @@ module Carbon
129
133
  {
130
134
  :'tags' => :'Object',
131
135
  :'scope' => :'String',
136
+ :'scopes' => :'Array<String>',
132
137
  :'service' => :'OauthBasedConnectors',
133
138
  :'chunk_size' => :'Integer',
134
139
  :'chunk_overlap' => :'Integer',
@@ -165,6 +170,7 @@ module Carbon
165
170
  Set.new([
166
171
  :'tags',
167
172
  :'scope',
173
+ :'scopes',
168
174
  :'chunk_size',
169
175
  :'chunk_overlap',
170
176
  :'skip_embedding_generation',
@@ -213,6 +219,12 @@ module Carbon
213
219
  self.scope = attributes[:'scope']
214
220
  end
215
221
 
222
+ if attributes.key?(:'scopes')
223
+ if (value = attributes[:'scopes']).is_a?(Array)
224
+ self.scopes = value
225
+ end
226
+ end
227
+
216
228
  if attributes.key?(:'service')
217
229
  self.service = attributes[:'service']
218
230
  end
@@ -379,6 +391,7 @@ module Carbon
379
391
  self.class == o.class &&
380
392
  tags == o.tags &&
381
393
  scope == o.scope &&
394
+ scopes == o.scopes &&
382
395
  service == o.service &&
383
396
  chunk_size == o.chunk_size &&
384
397
  chunk_overlap == o.chunk_overlap &&
@@ -418,7 +431,7 @@ module Carbon
418
431
  # Calculates hash code according to all attributes.
419
432
  # @return [Integer] Hash code
420
433
  def hash
421
- [tags, scope, service, chunk_size, chunk_overlap, skip_embedding_generation, embedding_model, zendesk_subdomain, microsoft_tenant, sharepoint_site_name, confluence_subdomain, generate_sparse_vectors, prepend_filename_to_chunks, max_items_per_chunk, salesforce_domain, sync_files_on_connection, set_page_as_boundary, data_source_id, connecting_new_account, request_id, use_ocr, parse_pdf_tables_with_ocr, enable_file_picker, sync_source_items, incremental_sync, file_sync_config, automatically_open_file_picker, gong_account_email, servicenow_credentials, data_source_tags].hash
434
+ [tags, scope, scopes, service, chunk_size, chunk_overlap, skip_embedding_generation, embedding_model, zendesk_subdomain, microsoft_tenant, sharepoint_site_name, confluence_subdomain, generate_sparse_vectors, prepend_filename_to_chunks, max_items_per_chunk, salesforce_domain, sync_files_on_connection, set_page_as_boundary, data_source_id, connecting_new_account, request_id, use_ocr, parse_pdf_tables_with_ocr, enable_file_picker, sync_source_items, incremental_sync, file_sync_config, automatically_open_file_picker, gong_account_email, servicenow_credentials, data_source_tags].hash
422
435
  end
423
436
 
424
437
  # Builds the object from hash
@@ -11,20 +11,30 @@ require 'time'
11
11
 
12
12
  module Carbon
13
13
  class OrganizationUserFilesToSyncQueryInput
14
+ # Pagination parameters for the query.
14
15
  attr_accessor :pagination
15
16
 
17
+ # The field on OrganizationUserFilesToSYnc to order the results by.
16
18
  attr_accessor :order_by
17
19
 
20
+ # The direction to order the results by.
18
21
  attr_accessor :order_dir
19
22
 
23
+ # Filters to apply to the query.
20
24
  attr_accessor :filters
21
25
 
26
+ # If true, the query will return presigned URLs for the raw file. Only relevant for the /user_files_v2 endpoint.
22
27
  attr_accessor :include_raw_file
23
28
 
29
+ # If true, the query will return presigned URLs for the parsed text file. Only relevant for the /user_files_v2 endpoint.
24
30
  attr_accessor :include_parsed_text_file
25
31
 
32
+ # If true, the query will return presigned URLs for additional files. Only relevant for the /user_files_v2 endpoint.
26
33
  attr_accessor :include_additional_files
27
34
 
35
+ # The expiry time for the presigned URLs. Only relevant for the /user_files_v2 endpoint.
36
+ attr_accessor :presigned_url_expiry_time_seconds
37
+
28
38
  # Attribute mapping from ruby-style variable name to JSON key.
29
39
  def self.attribute_map
30
40
  {
@@ -34,7 +44,8 @@ module Carbon
34
44
  :'filters' => :'filters',
35
45
  :'include_raw_file' => :'include_raw_file',
36
46
  :'include_parsed_text_file' => :'include_parsed_text_file',
37
- :'include_additional_files' => :'include_additional_files'
47
+ :'include_additional_files' => :'include_additional_files',
48
+ :'presigned_url_expiry_time_seconds' => :'presigned_url_expiry_time_seconds'
38
49
  }
39
50
  end
40
51
 
@@ -52,7 +63,8 @@ module Carbon
52
63
  :'filters' => :'OrganizationUserFilesToSyncFilters',
53
64
  :'include_raw_file' => :'Boolean',
54
65
  :'include_parsed_text_file' => :'Boolean',
55
- :'include_additional_files' => :'Boolean'
66
+ :'include_additional_files' => :'Boolean',
67
+ :'presigned_url_expiry_time_seconds' => :'Integer'
56
68
  }
57
69
  end
58
70
 
@@ -61,7 +73,7 @@ module Carbon
61
73
  Set.new([
62
74
  :'include_raw_file',
63
75
  :'include_parsed_text_file',
64
- :'include_additional_files'
76
+ :'include_additional_files',
65
77
  ])
66
78
  end
67
79
 
@@ -111,6 +123,12 @@ module Carbon
111
123
  if attributes.key?(:'include_additional_files')
112
124
  self.include_additional_files = attributes[:'include_additional_files']
113
125
  end
126
+
127
+ if attributes.key?(:'presigned_url_expiry_time_seconds')
128
+ self.presigned_url_expiry_time_seconds = attributes[:'presigned_url_expiry_time_seconds']
129
+ else
130
+ self.presigned_url_expiry_time_seconds = 3600
131
+ end
114
132
  end
115
133
 
116
134
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -137,7 +155,8 @@ module Carbon
137
155
  filters == o.filters &&
138
156
  include_raw_file == o.include_raw_file &&
139
157
  include_parsed_text_file == o.include_parsed_text_file &&
140
- include_additional_files == o.include_additional_files
158
+ include_additional_files == o.include_additional_files &&
159
+ presigned_url_expiry_time_seconds == o.presigned_url_expiry_time_seconds
141
160
  end
142
161
 
143
162
  # @see the `==` method
@@ -149,7 +168,7 @@ module Carbon
149
168
  # Calculates hash code according to all attributes.
150
169
  # @return [Integer] Hash code
151
170
  def hash
152
- [pagination, order_by, order_dir, filters, include_raw_file, include_parsed_text_file, include_additional_files].hash
171
+ [pagination, order_by, order_dir, filters, include_raw_file, include_parsed_text_file, include_additional_files, presigned_url_expiry_time_seconds].hash
153
172
  end
154
173
 
155
174
  # Builds the object from hash
@@ -15,11 +15,14 @@ module Carbon
15
15
 
16
16
  attr_accessor :offset
17
17
 
18
+ attr_accessor :starting_id
19
+
18
20
  # Attribute mapping from ruby-style variable name to JSON key.
19
21
  def self.attribute_map
20
22
  {
21
23
  :'limit' => :'limit',
22
- :'offset' => :'offset'
24
+ :'offset' => :'offset',
25
+ :'starting_id' => :'starting_id'
23
26
  }
24
27
  end
25
28
 
@@ -32,7 +35,8 @@ module Carbon
32
35
  def self.openapi_types
33
36
  {
34
37
  :'limit' => :'Integer',
35
- :'offset' => :'Integer'
38
+ :'offset' => :'Integer',
39
+ :'starting_id' => :'Integer'
36
40
  }
37
41
  end
38
42
 
@@ -68,6 +72,12 @@ module Carbon
68
72
  else
69
73
  self.offset = 0
70
74
  end
75
+
76
+ if attributes.key?(:'starting_id')
77
+ self.starting_id = attributes[:'starting_id']
78
+ else
79
+ self.starting_id = 0
80
+ end
71
81
  end
72
82
 
73
83
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -89,7 +99,8 @@ module Carbon
89
99
  return true if self.equal?(o)
90
100
  self.class == o.class &&
91
101
  limit == o.limit &&
92
- offset == o.offset
102
+ offset == o.offset &&
103
+ starting_id == o.starting_id
93
104
  end
94
105
 
95
106
  # @see the `==` method
@@ -101,7 +112,7 @@ module Carbon
101
112
  # Calculates hash code according to all attributes.
102
113
  # @return [Integer] Hash code
103
114
  def hash
104
- [limit, offset].hash
115
+ [limit, offset, starting_id].hash
105
116
  end
106
117
 
107
118
  # Builds the object from hash
@@ -54,6 +54,7 @@ module Carbon
54
54
  :'source',
55
55
  :'refresh_token',
56
56
  :'tenant_name',
57
+ :'site_name'
57
58
  ])
58
59
  end
59
60
 
@@ -101,10 +102,6 @@ module Carbon
101
102
  invalid_properties.push('invalid value for "access_token", access_token cannot be nil.')
102
103
  end
103
104
 
104
- if @site_name.nil?
105
- invalid_properties.push('invalid value for "site_name", site_name cannot be nil.')
106
- end
107
-
108
105
  invalid_properties
109
106
  end
110
107
 
@@ -112,7 +109,6 @@ module Carbon
112
109
  # @return true if the model is valid
113
110
  def valid?
114
111
  return false if @access_token.nil?
115
- return false if @site_name.nil?
116
112
  true
117
113
  end
118
114
 
@@ -7,5 +7,5 @@ The version of the OpenAPI document: 1.0.0
7
7
  =end
8
8
 
9
9
  module Carbon
10
- VERSION = '0.2.43'
10
+ VERSION = '0.2.45'
11
11
  end
@@ -31,6 +31,12 @@ describe Carbon::OAuthURLRequest do
31
31
  end
32
32
  end
33
33
 
34
+ describe 'test attribute "scopes"' do
35
+ it 'should work' do
36
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
37
+ end
38
+ end
39
+
34
40
  describe 'test attribute "service"' do
35
41
  it 'should work' do
36
42
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -61,4 +61,10 @@ describe Carbon::OrganizationUserFilesToSyncQueryInput do
61
61
  end
62
62
  end
63
63
 
64
+ describe 'test attribute "presigned_url_expiry_time_seconds"' do
65
+ it 'should work' do
66
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
67
+ end
68
+ end
69
+
64
70
  end
@@ -31,4 +31,10 @@ describe Carbon::Pagination do
31
31
  end
32
32
  end
33
33
 
34
+ describe 'test attribute "starting_id"' do
35
+ it 'should work' do
36
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
37
+ end
38
+ end
39
+
34
40
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: carbon_ruby_sdk
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.2.43
4
+ version: 0.2.45
5
5
  platform: ruby
6
6
  authors:
7
7
  - Konfig
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2024-10-22 00:00:00.000000000 Z
11
+ date: 2024-10-26 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: faraday