carbon_ruby_sdk 0.2.41 → 0.2.43

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.
Files changed (76) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +2 -2
  3. data/README.md +273 -3
  4. data/lib/carbon_ruby_sdk/api/data_sources_api.rb +196 -0
  5. data/lib/carbon_ruby_sdk/api/files_api.rb +4 -4
  6. data/lib/carbon_ruby_sdk/api/integrations_api.rb +48 -16
  7. data/lib/carbon_ruby_sdk/api/users_api.rb +71 -0
  8. data/lib/carbon_ruby_sdk/api/white_label_api.rb +393 -0
  9. data/lib/carbon_ruby_sdk/models/add_data_source_tags_input.rb +234 -0
  10. data/lib/carbon_ruby_sdk/models/azure_blob_auth_request.rb +14 -4
  11. data/lib/carbon_ruby_sdk/models/cold_storage_props.rb +1 -1
  12. data/lib/carbon_ruby_sdk/models/credentials.rb +244 -0
  13. data/lib/carbon_ruby_sdk/models/delete_white_label_request.rb +222 -0
  14. data/lib/carbon_ruby_sdk/models/external_source_item.rb +11 -1
  15. data/lib/carbon_ruby_sdk/models/fresh_desk_connect_request.rb +15 -5
  16. data/lib/carbon_ruby_sdk/models/gitbook_connect_request.rb +15 -5
  17. data/lib/carbon_ruby_sdk/models/github_connect_request.rb +14 -4
  18. data/lib/carbon_ruby_sdk/models/google_drive_credentials.rb +254 -0
  19. data/lib/carbon_ruby_sdk/models/google_drive_white_label_input.rb +230 -0
  20. data/lib/carbon_ruby_sdk/models/guru_connect_request.rb +15 -5
  21. data/lib/carbon_ruby_sdk/models/list_white_label_request.rb +246 -0
  22. data/lib/carbon_ruby_sdk/models/o_auth_url_request.rb +15 -5
  23. data/lib/carbon_ruby_sdk/models/one_drive_sharepoint_credentials.rb +264 -0
  24. data/lib/carbon_ruby_sdk/models/one_drive_sharepoint_white_label_input.rb +234 -0
  25. data/lib/carbon_ruby_sdk/models/one_drive_sharepoint_white_label_input_data_source_type.rb +36 -0
  26. data/lib/carbon_ruby_sdk/models/organization_user_data_source_api.rb +15 -1
  27. data/lib/carbon_ruby_sdk/models/organization_user_data_source_filters.rb +12 -1
  28. data/lib/carbon_ruby_sdk/models/remove_data_source_tags_input.rb +242 -0
  29. data/lib/carbon_ruby_sdk/models/rss_feed_input.rb +15 -5
  30. data/lib/carbon_ruby_sdk/models/s3_auth_request.rb +15 -5
  31. data/lib/carbon_ruby_sdk/models/sync_options.rb +15 -5
  32. data/lib/carbon_ruby_sdk/models/user_response.rb +18 -4
  33. data/lib/carbon_ruby_sdk/models/white_label_create_request_inner.rb +255 -0
  34. data/lib/carbon_ruby_sdk/models/white_label_filters.rb +230 -0
  35. data/lib/carbon_ruby_sdk/models/white_label_input.rb +234 -0
  36. data/lib/carbon_ruby_sdk/models/white_label_input_data_source_type.rb +48 -0
  37. data/lib/carbon_ruby_sdk/models/white_label_order_by_columns.rb +36 -0
  38. data/lib/carbon_ruby_sdk/models/white_label_update_request.rb +255 -0
  39. data/lib/carbon_ruby_sdk/models/white_labeling_response.rb +18 -4
  40. data/lib/carbon_ruby_sdk/version.rb +1 -1
  41. data/lib/carbon_ruby_sdk.rb +19 -0
  42. data/spec/api/data_sources_api_spec.rb +22 -0
  43. data/spec/api/files_api_spec.rb +1 -1
  44. data/spec/api/users_api_spec.rb +10 -0
  45. data/spec/api/white_label_api_spec.rb +73 -0
  46. data/spec/models/add_data_source_tags_input_spec.rb +34 -0
  47. data/spec/models/azure_blob_auth_request_spec.rb +6 -0
  48. data/spec/models/credentials_spec.rb +40 -0
  49. data/spec/models/delete_white_label_request_spec.rb +28 -0
  50. data/spec/models/external_source_item_spec.rb +6 -0
  51. data/spec/models/fresh_desk_connect_request_spec.rb +6 -0
  52. data/spec/models/gitbook_connect_request_spec.rb +6 -0
  53. data/spec/models/github_connect_request_spec.rb +6 -0
  54. data/spec/models/google_drive_credentials_spec.rb +46 -0
  55. data/spec/models/google_drive_white_label_input_spec.rb +34 -0
  56. data/spec/models/guru_connect_request_spec.rb +6 -0
  57. data/spec/models/list_white_label_request_spec.rb +46 -0
  58. data/spec/models/o_auth_url_request_spec.rb +6 -0
  59. data/spec/models/one_drive_sharepoint_credentials_spec.rb +52 -0
  60. data/spec/models/one_drive_sharepoint_white_label_input_data_source_type_spec.rb +22 -0
  61. data/spec/models/one_drive_sharepoint_white_label_input_spec.rb +34 -0
  62. data/spec/models/organization_user_data_source_api_spec.rb +6 -0
  63. data/spec/models/organization_user_data_source_filters_spec.rb +6 -0
  64. data/spec/models/remove_data_source_tags_input_spec.rb +40 -0
  65. data/spec/models/rss_feed_input_spec.rb +6 -0
  66. data/spec/models/s3_auth_request_spec.rb +6 -0
  67. data/spec/models/sync_options_spec.rb +6 -0
  68. data/spec/models/user_response_spec.rb +6 -0
  69. data/spec/models/white_label_create_request_inner_spec.rb +34 -0
  70. data/spec/models/white_label_filters_spec.rb +34 -0
  71. data/spec/models/white_label_input_data_source_type_spec.rb +22 -0
  72. data/spec/models/white_label_input_spec.rb +34 -0
  73. data/spec/models/white_label_order_by_columns_spec.rb +22 -0
  74. data/spec/models/white_label_update_request_spec.rb +34 -0
  75. data/spec/models/white_labeling_response_spec.rb +6 -0
  76. metadata +53 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: b6a3377f9d76f046be221f82a9245ff51891693ccd7da4871f731826ad9603fd
4
- data.tar.gz: 16bb35d792953316029695d0931fedbcd7b0c49ff15ddf4e136074c92950a698
3
+ metadata.gz: '0041088eca440b5e23106b5a61b6631c6bbde015033004d3c84ed205a1f8c3dc'
4
+ data.tar.gz: d8f21fbc6d1ef0183689fb980f05da068930ae611a06d83464411eb708316099
5
5
  SHA512:
6
- metadata.gz: e6cd3fc358155e0c0f915b68da5898afecf7c03ddec2341c48187a0d3afc7e85645fc7ca3394e8df0f1d858bf96ecc893aaea8277ef570ea04283d613552b767
7
- data.tar.gz: 4ad76f42235498b6ac475612e468fd1facc96d6fb28812cfce16dc2ecdf4d45a7c30cb951e64695dd9e4bc3991a6a1889d39ce31d3d5e4f883effa42c6b49a9d
6
+ metadata.gz: 5ab2fe2c38087f093e086a2a9127acee8e9c7fcfb40cf763eee594d128579dbb02b0a33045ba9bf5bbf6c5c5b2ae382d2e01500c6a95df2cc85f7c0f7ad3e0da
7
+ data.tar.gz: 83c6428340b06c799b908b818172ad17b5bc3b78b3016374572ac64211f23d78a7357418ddbbc57f61a5842654ced1da1dddf409117bdc40982bc469a1ee4113
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- carbon_ruby_sdk (0.2.41)
4
+ carbon_ruby_sdk (0.2.43)
5
5
  faraday (>= 1.0.1, < 3.0)
6
6
  faraday-multipart (~> 1.0, >= 1.0.4)
7
7
 
@@ -49,7 +49,7 @@ GEM
49
49
  rspec-core (~> 3.13.0)
50
50
  rspec-expectations (~> 3.13.0)
51
51
  rspec-mocks (~> 3.13.0)
52
- rspec-core (3.13.1)
52
+ rspec-core (3.13.2)
53
53
  rspec-support (~> 3.13.0)
54
54
  rspec-expectations (3.13.3)
55
55
  diff-lcs (>= 1.2.0, < 2.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.41-blue)](https://rubygems.org/gems/carbon_ruby_sdk/versions/0.2.41)
9
+ [![npm](https://img.shields.io/badge/gem-v0.2.43-blue)](https://rubygems.org/gems/carbon_ruby_sdk/versions/0.2.43)
10
10
 
11
11
  </div>
12
12
 
@@ -28,7 +28,9 @@ Connect external data to LLMs, no matter the source.
28
28
  * [`carbon.crm.get_leads`](#carboncrmget_leads)
29
29
  * [`carbon.crm.get_opportunities`](#carboncrmget_opportunities)
30
30
  * [`carbon.crm.get_opportunity`](#carboncrmget_opportunity)
31
+ * [`carbon.data_sources.add_tags`](#carbondata_sourcesadd_tags)
31
32
  * [`carbon.data_sources.query_user_data_sources`](#carbondata_sourcesquery_user_data_sources)
33
+ * [`carbon.data_sources.remove_tags`](#carbondata_sourcesremove_tags)
32
34
  * [`carbon.data_sources.revoke_access_token`](#carbondata_sourcesrevoke_access_token)
33
35
  * [`carbon.embeddings.get_documents`](#carbonembeddingsget_documents)
34
36
  * [`carbon.embeddings.get_embeddings_and_chunks`](#carbonembeddingsget_embeddings_and_chunks)
@@ -92,6 +94,7 @@ Connect external data to LLMs, no matter the source.
92
94
  * [`carbon.users.list`](#carbonuserslist)
93
95
  * [`carbon.users.toggle_user_features`](#carbonuserstoggle_user_features)
94
96
  * [`carbon.users.update_users`](#carbonusersupdate_users)
97
+ * [`carbon.users.who_am_i`](#carbonuserswho_am_i)
95
98
  * [`carbon.utilities.fetch_urls`](#carbonutilitiesfetch_urls)
96
99
  * [`carbon.utilities.fetch_webpage`](#carbonutilitiesfetch_webpage)
97
100
  * [`carbon.utilities.fetch_youtube_transcripts`](#carbonutilitiesfetch_youtube_transcripts)
@@ -103,6 +106,10 @@ Connect external data to LLMs, no matter the source.
103
106
  * [`carbon.webhooks.add_url`](#carbonwebhooksadd_url)
104
107
  * [`carbon.webhooks.delete_url`](#carbonwebhooksdelete_url)
105
108
  * [`carbon.webhooks.urls`](#carbonwebhooksurls)
109
+ * [`carbon.white_label.create`](#carbonwhite_labelcreate)
110
+ * [`carbon.white_label.delete`](#carbonwhite_labeldelete)
111
+ * [`carbon.white_label.list`](#carbonwhite_labellist)
112
+ * [`carbon.white_label.update`](#carbonwhite_labelupdate)
106
113
 
107
114
  <!-- tocstop -->
108
115
 
@@ -111,7 +118,7 @@ Connect external data to LLMs, no matter the source.
111
118
  Add to Gemfile:
112
119
 
113
120
  ```ruby
114
- gem 'carbon_ruby_sdk', '~> 0.2.41'
121
+ gem 'carbon_ruby_sdk', '~> 0.2.43'
115
122
  ```
116
123
 
117
124
  ## Getting Started<a id="getting-started"></a>
@@ -528,6 +535,37 @@ p result
528
535
  ---
529
536
 
530
537
 
538
+ ### `carbon.data_sources.add_tags`<a id="carbondata_sourcesadd_tags"></a>
539
+
540
+ Add Data Source Tags
541
+
542
+ #### 🛠️ Usage<a id="🛠️-usage"></a>
543
+
544
+ ```ruby
545
+ result = carbon.data_sources.add_tags(
546
+ tags: {},
547
+ data_source_id: 1,
548
+ )
549
+ p result
550
+ ```
551
+
552
+ #### ⚙️ Parameters<a id="⚙️-parameters"></a>
553
+
554
+ ##### tags: `Object`<a id="tags-object"></a>
555
+ ##### data_source_id: `Integer`<a id="data_source_id-integer"></a>
556
+ #### 🔄 Return<a id="🔄-return"></a>
557
+
558
+ [OrganizationUserDataSourceAPI](./lib/carbon_ruby_sdk/models/organization_user_data_source_api.rb)
559
+
560
+ #### 🌐 Endpoint<a id="🌐-endpoint"></a>
561
+
562
+ `/data_sources/tags/add` `POST`
563
+
564
+ [🔙 **Back to Table of Contents**](#table-of-contents)
565
+
566
+ ---
567
+
568
+
531
569
  ### `carbon.data_sources.query_user_data_sources`<a id="carbondata_sourcesquery_user_data_sources"></a>
532
570
 
533
571
  User Data Sources
@@ -568,6 +606,39 @@ p result
568
606
  ---
569
607
 
570
608
 
609
+ ### `carbon.data_sources.remove_tags`<a id="carbondata_sourcesremove_tags"></a>
610
+
611
+ Remove Data Source Tags
612
+
613
+ #### 🛠️ Usage<a id="🛠️-usage"></a>
614
+
615
+ ```ruby
616
+ result = carbon.data_sources.remove_tags(
617
+ data_source_id: 1,
618
+ tags_to_remove: [],
619
+ remove_all_tags: false,
620
+ )
621
+ p result
622
+ ```
623
+
624
+ #### ⚙️ Parameters<a id="⚙️-parameters"></a>
625
+
626
+ ##### data_source_id: `Integer`<a id="data_source_id-integer"></a>
627
+ ##### tags_to_remove: Array<`String`><a id="tags_to_remove-array"></a>
628
+ ##### remove_all_tags: `Boolean`<a id="remove_all_tags-boolean"></a>
629
+ #### 🔄 Return<a id="🔄-return"></a>
630
+
631
+ [OrganizationUserDataSourceAPI](./lib/carbon_ruby_sdk/models/organization_user_data_source_api.rb)
632
+
633
+ #### 🌐 Endpoint<a id="🌐-endpoint"></a>
634
+
635
+ `/data_sources/tags/remove` `POST`
636
+
637
+ [🔙 **Back to Table of Contents**](#table-of-contents)
638
+
639
+ ---
640
+
641
+
571
642
  ### `carbon.data_sources.revoke_access_token`<a id="carbondata_sourcesrevoke_access_token"></a>
572
643
 
573
644
  Revoke Access Token
@@ -1565,7 +1636,8 @@ Enable cold storage for the file. If set to true, the file will be moved to cold
1565
1636
  storage after a certain period of inactivity. Default is false.
1566
1637
 
1567
1638
  ##### hot_storage_time_to_live: `Integer`<a id="hot_storage_time_to_live-integer"></a>
1568
- Time in seconds after which the file will be moved to cold storage.
1639
+ Time in days after which the file will be moved to cold storage. Must be one of
1640
+ [1, 3, 7, 14, 30].
1569
1641
 
1570
1642
  ##### generate_chunks_only: `Boolean`<a id="generate_chunks_only-boolean"></a>
1571
1643
  If this flag is enabled, the file will be chunked and stored with Carbon, but no
@@ -2142,6 +2214,7 @@ result = carbon.integrations.connect_freshdesk(
2142
2214
  "store_file_only" => false,
2143
2215
  "skip_file_processing" => false,
2144
2216
  },
2217
+ data_source_tags: {},
2145
2218
  )
2146
2219
  p result
2147
2220
  ```
@@ -2164,6 +2237,10 @@ Enabling this flag will fetch all available content from the source to be listed
2164
2237
  via list items endpoint
2165
2238
 
2166
2239
  ##### file_sync_config: [`FileSyncConfigNullable`](./lib/carbon_ruby_sdk/models/file_sync_config_nullable.rb)<a id="file_sync_config-filesyncconfignullablelibcarbon_ruby_sdkmodelsfile_sync_config_nullablerb"></a>
2240
+ ##### data_source_tags: `Object`<a id="data_source_tags-object"></a>
2241
+ Tags to be associated with the data source. If the data source already has tags
2242
+ set, then an upsert will be performed.
2243
+
2167
2244
  #### 🔄 Return<a id="🔄-return"></a>
2168
2245
 
2169
2246
  [GenericSuccessResponse](./lib/carbon_ruby_sdk/models/generic_success_response.rb)
@@ -2211,6 +2288,7 @@ result = carbon.integrations.connect_gitbook(
2211
2288
  "store_file_only" => false,
2212
2289
  "skip_file_processing" => false,
2213
2290
  },
2291
+ data_source_tags: {},
2214
2292
  )
2215
2293
  p result
2216
2294
  ```
@@ -2233,6 +2311,10 @@ Enabling this flag will fetch all available content from the source to be listed
2233
2311
  via list items endpoint
2234
2312
 
2235
2313
  ##### file_sync_config: [`FileSyncConfigNullable`](./lib/carbon_ruby_sdk/models/file_sync_config_nullable.rb)<a id="file_sync_config-filesyncconfignullablelibcarbon_ruby_sdkmodelsfile_sync_config_nullablerb"></a>
2314
+ ##### data_source_tags: `Object`<a id="data_source_tags-object"></a>
2315
+ Tags to be associated with the data source. If the data source already has tags
2316
+ set, then an upsert will be performed.
2317
+
2236
2318
  #### 🔄 Return<a id="🔄-return"></a>
2237
2319
 
2238
2320
  [GenericSuccessResponse](./lib/carbon_ruby_sdk/models/generic_success_response.rb)
@@ -2278,6 +2360,7 @@ result = carbon.integrations.connect_guru(
2278
2360
  "store_file_only" => false,
2279
2361
  "skip_file_processing" => false,
2280
2362
  },
2363
+ data_source_tags: {},
2281
2364
  )
2282
2365
  p result
2283
2366
  ```
@@ -2300,6 +2383,10 @@ Enabling this flag will fetch all available content from the source to be listed
2300
2383
  via list items endpoint
2301
2384
 
2302
2385
  ##### file_sync_config: [`FileSyncConfigNullable`](./lib/carbon_ruby_sdk/models/file_sync_config_nullable.rb)<a id="file_sync_config-filesyncconfignullablelibcarbon_ruby_sdkmodelsfile_sync_config_nullablerb"></a>
2386
+ ##### data_source_tags: `Object`<a id="data_source_tags-object"></a>
2387
+ Tags to be associated with the data source. If the data source already has tags
2388
+ set, then an upsert will be performed.
2389
+
2303
2390
  #### 🔄 Return<a id="🔄-return"></a>
2304
2391
 
2305
2392
  [GenericSuccessResponse](./lib/carbon_ruby_sdk/models/generic_success_response.rb)
@@ -2334,6 +2421,7 @@ result = carbon.integrations.create_aws_iam_user(
2334
2421
  access_key_secret: "string_example",
2335
2422
  sync_source_items: true,
2336
2423
  endpoint_url: "string_example",
2424
+ data_source_tags: {},
2337
2425
  )
2338
2426
  p result
2339
2427
  ```
@@ -2351,6 +2439,10 @@ You can specify a Digital Ocean endpoint URL to connect a Digital Ocean Space
2351
2439
  through this endpoint. The URL should be of format
2352
2440
  <region>.digitaloceanspaces.com. It's not required for S3 buckets.
2353
2441
 
2442
+ ##### data_source_tags: `Object`<a id="data_source_tags-object"></a>
2443
+ Tags to be associated with the data source. If the data source already has tags
2444
+ set, then an upsert will be performed.
2445
+
2354
2446
  #### 🔄 Return<a id="🔄-return"></a>
2355
2447
 
2356
2448
  [OrganizationUserDataSourceAPI](./lib/carbon_ruby_sdk/models/organization_user_data_source_api.rb)
@@ -2419,6 +2511,7 @@ result = carbon.integrations.get_oauth_url(
2419
2511
  "client_secret" => "client_secret_example",
2420
2512
  "redirect_uri" => "redirect_uri_example",
2421
2513
  },
2514
+ data_source_tags: {},
2422
2515
  )
2423
2516
  p result
2424
2517
  ```
@@ -2492,6 +2585,10 @@ you wish to connect. This email will be used to identify your carbon data
2492
2585
  source.
2493
2586
 
2494
2587
  ##### servicenow_credentials: [`ServiceNowCredentialsNullable`](./lib/carbon_ruby_sdk/models/service_now_credentials_nullable.rb)<a id="servicenow_credentials-servicenowcredentialsnullablelibcarbon_ruby_sdkmodelsservice_now_credentials_nullablerb"></a>
2588
+ ##### data_source_tags: `Object`<a id="data_source_tags-object"></a>
2589
+ Tags to be associated with the data source. If the data source already has tags
2590
+ set, then an upsert will be performed.
2591
+
2495
2592
  #### 🔄 Return<a id="🔄-return"></a>
2496
2593
 
2497
2594
  [OuthURLResponse](./lib/carbon_ruby_sdk/models/outh_url_response.rb)
@@ -2860,6 +2957,7 @@ result = carbon.integrations.sync_azure_blob_storage(
2860
2957
  account_name: "string_example",
2861
2958
  account_key: "string_example",
2862
2959
  sync_source_items: true,
2960
+ data_source_tags: {},
2863
2961
  )
2864
2962
  p result
2865
2963
  ```
@@ -2869,6 +2967,10 @@ p result
2869
2967
  ##### account_name: `String`<a id="account_name-string"></a>
2870
2968
  ##### account_key: `String`<a id="account_key-string"></a>
2871
2969
  ##### sync_source_items: `Boolean`<a id="sync_source_items-boolean"></a>
2970
+ ##### data_source_tags: `Object`<a id="data_source_tags-object"></a>
2971
+ Tags to be associated with the data source. If the data source already has tags
2972
+ set, then an upsert will be performed.
2973
+
2872
2974
  #### 🔄 Return<a id="🔄-return"></a>
2873
2975
 
2874
2976
  [OrganizationUserDataSourceAPI](./lib/carbon_ruby_sdk/models/organization_user_data_source_api.rb)
@@ -3089,6 +3191,7 @@ result = carbon.integrations.sync_git_hub(
3089
3191
  username: "string_example",
3090
3192
  access_token: "string_example",
3091
3193
  sync_source_items: false,
3194
+ data_source_tags: {},
3092
3195
  )
3093
3196
  p result
3094
3197
  ```
@@ -3101,6 +3204,10 @@ p result
3101
3204
  Enabling this flag will fetch all available content from the source to be listed
3102
3205
  via list items endpoint
3103
3206
 
3207
+ ##### data_source_tags: `Object`<a id="data_source_tags-object"></a>
3208
+ Tags to be associated with the data source. If the data source already has tags
3209
+ set, then an upsert will be performed.
3210
+
3104
3211
  #### 🔄 Return<a id="🔄-return"></a>
3105
3212
 
3106
3213
  [GenericSuccessResponse](./lib/carbon_ruby_sdk/models/generic_success_response.rb)
@@ -3461,6 +3568,7 @@ result = carbon.integrations.sync_rss_feed(
3461
3568
  generate_sparse_vectors: false,
3462
3569
  prepend_filename_to_chunks: false,
3463
3570
  request_id: "string_example",
3571
+ data_source_tags: {},
3464
3572
  )
3465
3573
  p result
3466
3574
  ```
@@ -3476,6 +3584,10 @@ p result
3476
3584
  ##### generate_sparse_vectors: `Boolean`<a id="generate_sparse_vectors-boolean"></a>
3477
3585
  ##### prepend_filename_to_chunks: `Boolean`<a id="prepend_filename_to_chunks-boolean"></a>
3478
3586
  ##### request_id: `String`<a id="request_id-string"></a>
3587
+ ##### data_source_tags: `Object`<a id="data_source_tags-object"></a>
3588
+ Tags to be associated with the data source. If the data source already has tags
3589
+ set, then an upsert will be performed.
3590
+
3479
3591
  #### 🔄 Return<a id="🔄-return"></a>
3480
3592
 
3481
3593
  [GenericSuccessResponse](./lib/carbon_ruby_sdk/models/generic_success_response.rb)
@@ -3899,6 +4011,30 @@ not set, or if set to -1, then the user will have no limit.
3899
4011
  ---
3900
4012
 
3901
4013
 
4014
+ ### `carbon.users.who_am_i`<a id="carbonuserswho_am_i"></a>
4015
+
4016
+ Me Endpoint
4017
+
4018
+ #### 🛠️ Usage<a id="🛠️-usage"></a>
4019
+
4020
+ ```ruby
4021
+ result = carbon.users.who_am_i
4022
+ p result
4023
+ ```
4024
+
4025
+ #### 🔄 Return<a id="🔄-return"></a>
4026
+
4027
+ [UserResponse](./lib/carbon_ruby_sdk/models/user_response.rb)
4028
+
4029
+ #### 🌐 Endpoint<a id="🌐-endpoint"></a>
4030
+
4031
+ `/whoami` `GET`
4032
+
4033
+ [🔙 **Back to Table of Contents**](#table-of-contents)
4034
+
4035
+ ---
4036
+
4037
+
3902
4038
  ### `carbon.utilities.fetch_urls`<a id="carbonutilitiesfetch_urls"></a>
3903
4039
  ![Deprecated](https://img.shields.io/badge/deprecated-yellow)
3904
4040
 
@@ -4359,5 +4495,139 @@ p result
4359
4495
  ---
4360
4496
 
4361
4497
 
4498
+ ### `carbon.white_label.create`<a id="carbonwhite_labelcreate"></a>
4499
+
4500
+ Create White Labels
4501
+
4502
+ #### 🛠️ Usage<a id="🛠️-usage"></a>
4503
+
4504
+ ```ruby
4505
+ result = carbon.white_label.create(
4506
+ body: [
4507
+ {
4508
+ "data_source_type" => None,
4509
+ "credentials" => {
4510
+ "client_id" => "client_id_example",
4511
+ "redirect_uri" => "redirect_uri_example",
4512
+ },
4513
+ }
4514
+ ],
4515
+ )
4516
+ p result
4517
+ ```
4518
+
4519
+ #### ⚙️ body<a id="⚙️-body"></a>
4520
+
4521
+ Array<[`WhiteLabelCreateRequestInner`](./lib/carbon_ruby_sdk/models/white_label_create_request_inner.rb)>
4522
+ #### 🌐 Endpoint<a id="🌐-endpoint"></a>
4523
+
4524
+ `/white_label/create` `POST`
4525
+
4526
+ [🔙 **Back to Table of Contents**](#table-of-contents)
4527
+
4528
+ ---
4529
+
4530
+
4531
+ ### `carbon.white_label.delete`<a id="carbonwhite_labeldelete"></a>
4532
+
4533
+ Delete White Labels
4534
+
4535
+ #### 🛠️ Usage<a id="🛠️-usage"></a>
4536
+
4537
+ ```ruby
4538
+ result = carbon.white_label.delete(
4539
+ ids: [
4540
+ 1
4541
+ ],
4542
+ )
4543
+ p result
4544
+ ```
4545
+
4546
+ #### ⚙️ Parameters<a id="⚙️-parameters"></a>
4547
+
4548
+ ##### ids: Array<`Integer`><a id="ids-array"></a>
4549
+ #### 🌐 Endpoint<a id="🌐-endpoint"></a>
4550
+
4551
+ `/white_label/delete` `POST`
4552
+
4553
+ [🔙 **Back to Table of Contents**](#table-of-contents)
4554
+
4555
+ ---
4556
+
4557
+
4558
+ ### `carbon.white_label.list`<a id="carbonwhite_labellist"></a>
4559
+
4560
+ List White Labels
4561
+
4562
+ #### 🛠️ Usage<a id="🛠️-usage"></a>
4563
+
4564
+ ```ruby
4565
+ result = carbon.white_label.list(
4566
+ pagination: {
4567
+ "limit" => 10,
4568
+ "offset" => 0,
4569
+ },
4570
+ order_by: "created_at",
4571
+ order_dir: "desc",
4572
+ filters: {
4573
+ "ids" => [],
4574
+ "data_source_type" => [],
4575
+ },
4576
+ )
4577
+ p result
4578
+ ```
4579
+
4580
+ #### ⚙️ Parameters<a id="⚙️-parameters"></a>
4581
+
4582
+ ##### pagination: [`Pagination`](./lib/carbon_ruby_sdk/models/pagination.rb)<a id="pagination-paginationlibcarbon_ruby_sdkmodelspaginationrb"></a>
4583
+ ##### order_by: [`WhiteLabelOrderByColumns`](./lib/carbon_ruby_sdk/models/white_label_order_by_columns.rb)<a id="order_by-whitelabelorderbycolumnslibcarbon_ruby_sdkmodelswhite_label_order_by_columnsrb"></a>
4584
+ ##### order_dir: [`OrderDir`](./lib/carbon_ruby_sdk/models/order_dir.rb)<a id="order_dir-orderdirlibcarbon_ruby_sdkmodelsorder_dirrb"></a>
4585
+ ##### filters: [`WhiteLabelFilters`](./lib/carbon_ruby_sdk/models/white_label_filters.rb)<a id="filters-whitelabelfilterslibcarbon_ruby_sdkmodelswhite_label_filtersrb"></a>
4586
+ #### 🌐 Endpoint<a id="🌐-endpoint"></a>
4587
+
4588
+ `/white_label/list` `POST`
4589
+
4590
+ [🔙 **Back to Table of Contents**](#table-of-contents)
4591
+
4592
+ ---
4593
+
4594
+
4595
+ ### `carbon.white_label.update`<a id="carbonwhite_labelupdate"></a>
4596
+
4597
+ Update White Label
4598
+
4599
+ #### 🛠️ Usage<a id="🛠️-usage"></a>
4600
+
4601
+ ```ruby
4602
+ result = carbon.white_label.update(
4603
+ data_source_type: "INTERCOM",
4604
+ credentials: {
4605
+ "client_id" => "client_id_example",
4606
+ "redirect_uri" => "redirect_uri_example",
4607
+ },
4608
+ body: {
4609
+ "data_source_type" => None,
4610
+ "credentials" => {
4611
+ "client_id" => "client_id_example",
4612
+ "redirect_uri" => "redirect_uri_example",
4613
+ },
4614
+ },
4615
+ )
4616
+ p result
4617
+ ```
4618
+
4619
+ #### ⚙️ Parameters<a id="⚙️-parameters"></a>
4620
+
4621
+ ##### data_source_type: [`WhiteLabelInputDataSourceType`](./lib/carbon_ruby_sdk/models/white_label_input_data_source_type.rb)<a id="data_source_type-whitelabelinputdatasourcetypelibcarbon_ruby_sdkmodelswhite_label_input_data_source_typerb"></a>
4622
+ ##### credentials: [`Credentials`](./lib/carbon_ruby_sdk/models/credentials.rb)<a id="credentials-credentialslibcarbon_ruby_sdkmodelscredentialsrb"></a>
4623
+ #### 🌐 Endpoint<a id="🌐-endpoint"></a>
4624
+
4625
+ `/white_label/update` `POST`
4626
+
4627
+ [🔙 **Back to Table of Contents**](#table-of-contents)
4628
+
4629
+ ---
4630
+
4631
+
4362
4632
  ## Author<a id="author"></a>
4363
4633
  This TypeScript package is automatically generated by [Konfig](https://konfigthis.com)
@@ -16,6 +16,102 @@ module Carbon
16
16
  @api_client = api_client
17
17
  end
18
18
 
19
+ # Add Data Source Tags
20
+ #
21
+ # @param tags [Object]
22
+ # @param data_source_id [Integer]
23
+ # @param body [AddDataSourceTagsInput]
24
+ # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
25
+ def add_tags(tags:, data_source_id:, extra: {})
26
+ _body = {}
27
+ _body[:tags] = tags if tags != SENTINEL
28
+ _body[:data_source_id] = data_source_id if data_source_id != SENTINEL
29
+ add_data_source_tags_input = _body
30
+ api_response = add_tags_with_http_info_impl(add_data_source_tags_input, extra)
31
+ api_response.data
32
+ end
33
+
34
+ # Add Data Source Tags
35
+ #
36
+ # @param tags [Object]
37
+ # @param data_source_id [Integer]
38
+ # @param body [AddDataSourceTagsInput]
39
+ # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
40
+ def add_tags_with_http_info(tags:, data_source_id:, extra: {})
41
+ _body = {}
42
+ _body[:tags] = tags if tags != SENTINEL
43
+ _body[:data_source_id] = data_source_id if data_source_id != SENTINEL
44
+ add_data_source_tags_input = _body
45
+ add_tags_with_http_info_impl(add_data_source_tags_input, extra)
46
+ end
47
+
48
+ # Add Data Source Tags
49
+ # @param add_data_source_tags_input [AddDataSourceTagsInput]
50
+ # @param [Hash] opts the optional parameters
51
+ # @return [OrganizationUserDataSourceAPI]
52
+ private def add_tags_impl(add_data_source_tags_input, opts = {})
53
+ data, _status_code, _headers = add_tags_with_http_info(add_data_source_tags_input, opts)
54
+ data
55
+ end
56
+
57
+ # Add Data Source Tags
58
+ # @param add_data_source_tags_input [AddDataSourceTagsInput]
59
+ # @param [Hash] opts the optional parameters
60
+ # @return [APIResponse] data is OrganizationUserDataSourceAPI, status code, headers and response
61
+ private def add_tags_with_http_info_impl(add_data_source_tags_input, opts = {})
62
+ if @api_client.config.debugging
63
+ @api_client.config.logger.debug 'Calling API: DataSourcesApi.add_tags ...'
64
+ end
65
+ # verify the required parameter 'add_data_source_tags_input' is set
66
+ if @api_client.config.client_side_validation && add_data_source_tags_input.nil?
67
+ fail ArgumentError, "Missing the required parameter 'add_data_source_tags_input' when calling DataSourcesApi.add_tags"
68
+ end
69
+ # resource path
70
+ local_var_path = '/data_sources/tags/add'
71
+
72
+ # query parameters
73
+ query_params = opts[:query_params] || {}
74
+
75
+ # header parameters
76
+ header_params = opts[:header_params] || {}
77
+ # HTTP header 'Accept' (if needed)
78
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
79
+ # HTTP header 'Content-Type'
80
+ content_type = @api_client.select_header_content_type(['application/json'])
81
+ if !content_type.nil?
82
+ header_params['Content-Type'] = content_type
83
+ end
84
+
85
+ # form parameters
86
+ form_params = opts[:form_params] || {}
87
+
88
+ # http body (model)
89
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(add_data_source_tags_input)
90
+
91
+ # return_type
92
+ return_type = opts[:debug_return_type] || 'OrganizationUserDataSourceAPI'
93
+
94
+ # auth_names
95
+ auth_names = opts[:debug_auth_names] || ['accessToken', 'apiKey', 'customerId']
96
+
97
+ new_options = opts.merge(
98
+ :operation => :"DataSourcesApi.add_tags",
99
+ :header_params => header_params,
100
+ :query_params => query_params,
101
+ :form_params => form_params,
102
+ :body => post_body,
103
+ :auth_names => auth_names,
104
+ :return_type => return_type
105
+ )
106
+
107
+ data, status_code, headers, response = @api_client.call_api(:POST, local_var_path, new_options)
108
+ if @api_client.config.debugging
109
+ @api_client.config.logger.debug "API called: DataSourcesApi#add_tags\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
110
+ end
111
+ APIResponse::new(data, status_code, headers, response)
112
+ end
113
+
114
+
19
115
  # User Data Sources
20
116
  #
21
117
  # @param pagination [Pagination]
@@ -120,6 +216,106 @@ module Carbon
120
216
  end
121
217
 
122
218
 
219
+ # Remove Data Source Tags
220
+ #
221
+ # @param data_source_id [Integer]
222
+ # @param tags_to_remove [Array<String>]
223
+ # @param remove_all_tags [Boolean]
224
+ # @param body [RemoveDataSourceTagsInput]
225
+ # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
226
+ def remove_tags(data_source_id:, tags_to_remove: SENTINEL, remove_all_tags: false, extra: {})
227
+ _body = {}
228
+ _body[:data_source_id] = data_source_id if data_source_id != SENTINEL
229
+ _body[:tags_to_remove] = tags_to_remove if tags_to_remove != SENTINEL
230
+ _body[:remove_all_tags] = remove_all_tags if remove_all_tags != SENTINEL
231
+ remove_data_source_tags_input = _body
232
+ api_response = remove_tags_with_http_info_impl(remove_data_source_tags_input, extra)
233
+ api_response.data
234
+ end
235
+
236
+ # Remove Data Source Tags
237
+ #
238
+ # @param data_source_id [Integer]
239
+ # @param tags_to_remove [Array<String>]
240
+ # @param remove_all_tags [Boolean]
241
+ # @param body [RemoveDataSourceTagsInput]
242
+ # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
243
+ def remove_tags_with_http_info(data_source_id:, tags_to_remove: SENTINEL, remove_all_tags: false, extra: {})
244
+ _body = {}
245
+ _body[:data_source_id] = data_source_id if data_source_id != SENTINEL
246
+ _body[:tags_to_remove] = tags_to_remove if tags_to_remove != SENTINEL
247
+ _body[:remove_all_tags] = remove_all_tags if remove_all_tags != SENTINEL
248
+ remove_data_source_tags_input = _body
249
+ remove_tags_with_http_info_impl(remove_data_source_tags_input, extra)
250
+ end
251
+
252
+ # Remove Data Source Tags
253
+ # @param remove_data_source_tags_input [RemoveDataSourceTagsInput]
254
+ # @param [Hash] opts the optional parameters
255
+ # @return [OrganizationUserDataSourceAPI]
256
+ private def remove_tags_impl(remove_data_source_tags_input, opts = {})
257
+ data, _status_code, _headers = remove_tags_with_http_info(remove_data_source_tags_input, opts)
258
+ data
259
+ end
260
+
261
+ # Remove Data Source Tags
262
+ # @param remove_data_source_tags_input [RemoveDataSourceTagsInput]
263
+ # @param [Hash] opts the optional parameters
264
+ # @return [APIResponse] data is OrganizationUserDataSourceAPI, status code, headers and response
265
+ private def remove_tags_with_http_info_impl(remove_data_source_tags_input, opts = {})
266
+ if @api_client.config.debugging
267
+ @api_client.config.logger.debug 'Calling API: DataSourcesApi.remove_tags ...'
268
+ end
269
+ # verify the required parameter 'remove_data_source_tags_input' is set
270
+ if @api_client.config.client_side_validation && remove_data_source_tags_input.nil?
271
+ fail ArgumentError, "Missing the required parameter 'remove_data_source_tags_input' when calling DataSourcesApi.remove_tags"
272
+ end
273
+ # resource path
274
+ local_var_path = '/data_sources/tags/remove'
275
+
276
+ # query parameters
277
+ query_params = opts[:query_params] || {}
278
+
279
+ # header parameters
280
+ header_params = opts[:header_params] || {}
281
+ # HTTP header 'Accept' (if needed)
282
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
283
+ # HTTP header 'Content-Type'
284
+ content_type = @api_client.select_header_content_type(['application/json'])
285
+ if !content_type.nil?
286
+ header_params['Content-Type'] = content_type
287
+ end
288
+
289
+ # form parameters
290
+ form_params = opts[:form_params] || {}
291
+
292
+ # http body (model)
293
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(remove_data_source_tags_input)
294
+
295
+ # return_type
296
+ return_type = opts[:debug_return_type] || 'OrganizationUserDataSourceAPI'
297
+
298
+ # auth_names
299
+ auth_names = opts[:debug_auth_names] || ['accessToken', 'apiKey', 'customerId']
300
+
301
+ new_options = opts.merge(
302
+ :operation => :"DataSourcesApi.remove_tags",
303
+ :header_params => header_params,
304
+ :query_params => query_params,
305
+ :form_params => form_params,
306
+ :body => post_body,
307
+ :auth_names => auth_names,
308
+ :return_type => return_type
309
+ )
310
+
311
+ data, status_code, headers, response = @api_client.call_api(:POST, local_var_path, new_options)
312
+ if @api_client.config.debugging
313
+ @api_client.config.logger.debug "API called: DataSourcesApi#remove_tags\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
314
+ end
315
+ APIResponse::new(data, status_code, headers, response)
316
+ end
317
+
318
+
123
319
  # Revoke Access Token
124
320
  #
125
321
  # @param data_source_id [Integer]