trieve_ruby_client 0.3.4 → 0.4.0

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 (128) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +78 -81
  3. data/docs/AuthApi.md +29 -40
  4. data/docs/AuthQuery.md +22 -0
  5. data/docs/BatchQueuedChunkResponse.md +20 -0
  6. data/docs/ChunkApi.md +80 -214
  7. data/docs/ChunkData.md +42 -0
  8. data/docs/ChunkGroupApi.md +183 -174
  9. data/docs/CreateChunkData.md +41 -34
  10. data/docs/DatasetApi.md +37 -67
  11. data/docs/EventsApi.md +14 -19
  12. data/docs/FileApi.md +25 -45
  13. data/docs/GetEventsData.md +22 -0
  14. data/docs/HealthApi.md +6 -4
  15. data/docs/InvitationApi.md +7 -12
  16. data/docs/MessageApi.md +25 -45
  17. data/docs/OrganizationApi.md +37 -67
  18. data/docs/ReturnQueuedChunk.md +39 -10
  19. data/docs/SingleQueuedChunkResponse.md +20 -0
  20. data/docs/StripeApi.md +23 -25
  21. data/docs/TopicApi.md +25 -45
  22. data/docs/UserApi.md +19 -34
  23. data/lib/trieve_ruby_client/api/auth_api.rb +28 -35
  24. data/lib/trieve_ruby_client/api/chunk_api.rb +68 -143
  25. data/lib/trieve_ruby_client/api/chunk_group_api.rb +164 -76
  26. data/lib/trieve_ruby_client/api/dataset_api.rb +31 -31
  27. data/lib/trieve_ruby_client/api/events_api.rb +22 -17
  28. data/lib/trieve_ruby_client/api/file_api.rb +21 -21
  29. data/lib/trieve_ruby_client/api/health_api.rb +5 -1
  30. data/lib/trieve_ruby_client/api/invitation_api.rb +6 -6
  31. data/lib/trieve_ruby_client/api/message_api.rb +21 -21
  32. data/lib/trieve_ruby_client/api/organization_api.rb +31 -31
  33. data/lib/trieve_ruby_client/api/stripe_api.rb +19 -3
  34. data/lib/trieve_ruby_client/api/topic_api.rb +21 -21
  35. data/lib/trieve_ruby_client/api/user_api.rb +16 -16
  36. data/lib/trieve_ruby_client/api_client.rb +1 -1
  37. data/lib/trieve_ruby_client/api_error.rb +1 -1
  38. data/lib/trieve_ruby_client/configuration.rb +8 -11
  39. data/lib/trieve_ruby_client/models/add_chunk_to_group_data.rb +1 -1
  40. data/lib/trieve_ruby_client/models/api_key_dto.rb +1 -1
  41. data/lib/trieve_ruby_client/models/auth_query.rb +238 -0
  42. data/lib/trieve_ruby_client/models/batch_queued_chunk_response.rb +240 -0
  43. data/lib/trieve_ruby_client/models/bookmark_data.rb +1 -1
  44. data/lib/trieve_ruby_client/models/bookmark_group_result.rb +1 -1
  45. data/lib/trieve_ruby_client/models/chat_message_proxy.rb +1 -1
  46. data/lib/trieve_ruby_client/models/chunk_data.rb +356 -0
  47. data/lib/trieve_ruby_client/models/chunk_filter.rb +1 -1
  48. data/lib/trieve_ruby_client/models/chunk_group.rb +1 -1
  49. data/lib/trieve_ruby_client/models/chunk_group_and_file.rb +1 -1
  50. data/lib/trieve_ruby_client/models/chunk_metadata.rb +1 -1
  51. data/lib/trieve_ruby_client/models/chunk_metadata_with_file_data.rb +1 -1
  52. data/lib/trieve_ruby_client/models/client_dataset_configuration.rb +1 -1
  53. data/lib/trieve_ruby_client/models/create_chunk_data.rb +79 -330
  54. data/lib/trieve_ruby_client/models/create_chunk_group_data.rb +1 -1
  55. data/lib/trieve_ruby_client/models/create_dataset_request.rb +1 -1
  56. data/lib/trieve_ruby_client/models/create_message_data.rb +1 -1
  57. data/lib/trieve_ruby_client/models/create_organization_data.rb +1 -1
  58. data/lib/trieve_ruby_client/models/create_topic_data.rb +1 -1
  59. data/lib/trieve_ruby_client/models/dataset.rb +1 -1
  60. data/lib/trieve_ruby_client/models/dataset_and_usage.rb +1 -1
  61. data/lib/trieve_ruby_client/models/dataset_dto.rb +1 -1
  62. data/lib/trieve_ruby_client/models/dataset_usage_count.rb +1 -1
  63. data/lib/trieve_ruby_client/models/delete_dataset_request.rb +1 -1
  64. data/lib/trieve_ruby_client/models/delete_topic_data.rb +1 -1
  65. data/lib/trieve_ruby_client/models/delete_user_api_key_request.rb +1 -1
  66. data/lib/trieve_ruby_client/models/edit_message_data.rb +1 -1
  67. data/lib/trieve_ruby_client/models/error_response_body.rb +1 -1
  68. data/lib/trieve_ruby_client/models/event.rb +1 -1
  69. data/lib/trieve_ruby_client/models/event_return.rb +1 -1
  70. data/lib/trieve_ruby_client/models/field_condition.rb +1 -1
  71. data/lib/trieve_ruby_client/models/file.rb +1 -1
  72. data/lib/trieve_ruby_client/models/file_dto.rb +1 -1
  73. data/lib/trieve_ruby_client/models/generate_chunks_request.rb +1 -1
  74. data/lib/trieve_ruby_client/models/get_events_data.rb +240 -0
  75. data/lib/trieve_ruby_client/models/get_groups_for_chunks_data.rb +1 -1
  76. data/lib/trieve_ruby_client/models/group_data.rb +1 -1
  77. data/lib/trieve_ruby_client/models/group_score_chunk_dto.rb +1 -1
  78. data/lib/trieve_ruby_client/models/invitation_data.rb +1 -1
  79. data/lib/trieve_ruby_client/models/match_condition.rb +1 -1
  80. data/lib/trieve_ruby_client/models/message.rb +1 -1
  81. data/lib/trieve_ruby_client/models/organization.rb +1 -1
  82. data/lib/trieve_ruby_client/models/organization_usage_count.rb +1 -1
  83. data/lib/trieve_ruby_client/models/range.rb +1 -1
  84. data/lib/trieve_ruby_client/models/reccomend_group_chunks_request.rb +1 -1
  85. data/lib/trieve_ruby_client/models/recommend_chunks_request.rb +1 -1
  86. data/lib/trieve_ruby_client/models/regenerate_message_data.rb +1 -1
  87. data/lib/trieve_ruby_client/models/return_queued_chunk.rb +75 -207
  88. data/lib/trieve_ruby_client/models/score_chunk_dto.rb +1 -1
  89. data/lib/trieve_ruby_client/models/search_chunk_data.rb +1 -1
  90. data/lib/trieve_ruby_client/models/search_chunk_query_response_body.rb +1 -1
  91. data/lib/trieve_ruby_client/models/search_groups_result.rb +1 -1
  92. data/lib/trieve_ruby_client/models/search_over_groups_data.rb +1 -1
  93. data/lib/trieve_ruby_client/models/search_over_groups_response_body.rb +1 -1
  94. data/lib/trieve_ruby_client/models/search_within_group_data.rb +1 -1
  95. data/lib/trieve_ruby_client/models/set_user_api_key_request.rb +1 -1
  96. data/lib/trieve_ruby_client/models/set_user_api_key_response.rb +1 -1
  97. data/lib/trieve_ruby_client/models/single_queued_chunk_response.rb +238 -0
  98. data/lib/trieve_ruby_client/models/slim_group.rb +1 -1
  99. data/lib/trieve_ruby_client/models/slim_user.rb +1 -1
  100. data/lib/trieve_ruby_client/models/stripe_plan.rb +1 -1
  101. data/lib/trieve_ruby_client/models/stripe_subscription.rb +1 -1
  102. data/lib/trieve_ruby_client/models/suggested_queries_request.rb +1 -1
  103. data/lib/trieve_ruby_client/models/suggested_queries_response.rb +1 -1
  104. data/lib/trieve_ruby_client/models/topic.rb +1 -1
  105. data/lib/trieve_ruby_client/models/update_chunk_by_tracking_id_data.rb +1 -1
  106. data/lib/trieve_ruby_client/models/update_chunk_data.rb +1 -1
  107. data/lib/trieve_ruby_client/models/update_chunk_group_data.rb +1 -1
  108. data/lib/trieve_ruby_client/models/update_dataset_request.rb +1 -1
  109. data/lib/trieve_ruby_client/models/update_group_by_tracking_id_data.rb +1 -1
  110. data/lib/trieve_ruby_client/models/update_organization_data.rb +1 -1
  111. data/lib/trieve_ruby_client/models/update_topic_data.rb +1 -1
  112. data/lib/trieve_ruby_client/models/update_user_data.rb +1 -1
  113. data/lib/trieve_ruby_client/models/upload_file_data.rb +1 -1
  114. data/lib/trieve_ruby_client/models/upload_file_result.rb +1 -1
  115. data/lib/trieve_ruby_client/models/user_organization.rb +1 -1
  116. data/lib/trieve_ruby_client/version.rb +2 -2
  117. data/lib/trieve_ruby_client.rb +6 -2
  118. data/openapi-generator.yaml +2 -2
  119. data/openapi.json +1280 -876
  120. data/spec/models/auth_query_spec.rb +48 -0
  121. data/spec/models/batch_queued_chunk_response_spec.rb +42 -0
  122. data/spec/models/chunk_data_spec.rb +108 -0
  123. data/spec/models/get_events_data_spec.rb +48 -0
  124. data/spec/models/single_queued_chunk_response_spec.rb +42 -0
  125. data/spec/spec_helper.rb +1 -1
  126. data/trieve_ruby_client-0.3.5.gem +0 -0
  127. data/trieve_ruby_client.gemspec +2 -2
  128. metadata +25 -3
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: b182ca3ab9a91c173007984bb1699894ccdc8210908ed67ed0e9825dcc51d060
4
- data.tar.gz: de0527963f83607557a05e2e51946af9739645a5a3a1454fa1e0404305843407
3
+ metadata.gz: 428109731fb106d9fb3729b1d014c1791762e06e6ab980105e985def7887983c
4
+ data.tar.gz: 522971264c88fac99b1f3d71091fc069a6295db96d9214d2d27f5fba9d39a4a1
5
5
  SHA512:
6
- metadata.gz: 2506ef4cc37d376616503952fff65408efbe074f75acd3a77861e9bc62072fa0892fbda9b9db99ac59679f85dff80a4ec3ad247d7be1e3535f4aeec90d152a73
7
- data.tar.gz: 6bfef3a7504a6478c1a45cca713332021a4e16c2ca8d33f022f26ead18c6972bd38cfbb2cae7c088aa88cb3cb9aa10685cc7b842dbda61aafcf993211e0c372e
6
+ metadata.gz: 2206deffff5229fbd5a7c27277055365ad77d12408e7159c595ae4a23decba33b693d626e7c4e7dccfd216f4097b9efc56eb5612bdd4d1043a17be5487d80f54
7
+ data.tar.gz: d6a29402668fadb5bfd7aed3988264487a94c80d24f1e5aaee5d24129fb0b64566d6d05ad4ad9eae4ab952e57b64f6afabc90ef2254a3cca45bcbd42e6c06901
data/README.md CHANGED
@@ -6,8 +6,8 @@ Trieve OpenAPI Specification. This document describes all of the operations avai
6
6
 
7
7
  This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
8
8
 
9
- - API version: 0.3.4
10
- - Package version: 0.3.4
9
+ - API version: 0.4.0
10
+ - Package version: 0.4.0
11
11
  - Generator version: 7.4.0
12
12
  - Build package: org.openapitools.codegen.languages.RubyClientCodegen
13
13
  For more information, please visit [https://trieve.ai](https://trieve.ai)
@@ -25,16 +25,16 @@ gem build trieve_ruby_client.gemspec
25
25
  Then either install the gem locally:
26
26
 
27
27
  ```shell
28
- gem install ./trieve_ruby_client-0.3.4.gem
28
+ gem install ./trieve_ruby_client-0.4.0.gem
29
29
  ```
30
30
 
31
- (for development, run `gem install --dev ./trieve_ruby_client-0.3.4.gem` to install the development dependencies)
31
+ (for development, run `gem install --dev ./trieve_ruby_client-0.4.0.gem` to install the development dependencies)
32
32
 
33
33
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
34
34
 
35
35
  Finally add this to the Gemfile:
36
36
 
37
- gem 'trieve_ruby_client', '~> 0.3.4'
37
+ gem 'trieve_ruby_client', '~> 0.4.0'
38
38
 
39
39
  ### Install from Git
40
40
 
@@ -61,7 +61,7 @@ require 'trieve_ruby_client'
61
61
  api_instance = TrieveRubyClient::AuthApi.new
62
62
 
63
63
  begin
64
- #openid_callback
64
+ #OpenID Connect callback
65
65
  result = api_instance.callback
66
66
  p result
67
67
  rescue TrieveRubyClient::ApiError => e
@@ -72,85 +72,88 @@ end
72
72
 
73
73
  ## Documentation for API Endpoints
74
74
 
75
- All URIs are relative to *http://localhost*
75
+ All URIs are relative to *http://localhost:8090*
76
76
 
77
77
  Class | Method | HTTP request | Description
78
78
  ------------ | ------------- | ------------- | -------------
79
- *TrieveRubyClient::AuthApi* | [**callback**](docs/AuthApi.md#callback) | **GET** /api/auth/callback | openid_callback
80
- *TrieveRubyClient::AuthApi* | [**get_me**](docs/AuthApi.md#get_me) | **GET** /api/auth/me | get_me
81
- *TrieveRubyClient::AuthApi* | [**login**](docs/AuthApi.md#login) | **GET** /api/auth | login
82
- *TrieveRubyClient::AuthApi* | [**logout**](docs/AuthApi.md#logout) | **DELETE** /api/auth | logout
83
- *TrieveRubyClient::ChunkApi* | [**bulk_create_chunk**](docs/ChunkApi.md#bulk_create_chunk) | **POST** /api/chunk/bulk | bulk_create_chunk
84
- *TrieveRubyClient::ChunkApi* | [**create_chunk**](docs/ChunkApi.md#create_chunk) | **POST** /api/chunk | create_chunk
85
- *TrieveRubyClient::ChunkApi* | [**create_suggested_queries_handler**](docs/ChunkApi.md#create_suggested_queries_handler) | **POST** /api/chunk/gen_suggestions | get_suggested_queries
86
- *TrieveRubyClient::ChunkApi* | [**delete_chunk**](docs/ChunkApi.md#delete_chunk) | **DELETE** /api/{tracking_or_chunk}/{chunk_id} | delete_chunk
87
- *TrieveRubyClient::ChunkApi* | [**delete_chunk_by_tracking_id**](docs/ChunkApi.md#delete_chunk_by_tracking_id) | **DELETE** /api/chunk/tracking_id/{tracking_id} | delete_chunk_by_tracking_id
88
- *TrieveRubyClient::ChunkApi* | [**generate_off_chunks**](docs/ChunkApi.md#generate_off_chunks) | **POST** /api/chunk/generate | augmented_generation_from_chunks
89
- *TrieveRubyClient::ChunkApi* | [**get_chunk_by_id**](docs/ChunkApi.md#get_chunk_by_id) | **GET** /api/{tracking_or_chunk}/{chunk_id} | get_chunk
90
- *TrieveRubyClient::ChunkApi* | [**get_chunk_by_tracking_id**](docs/ChunkApi.md#get_chunk_by_tracking_id) | **GET** /api/chunk/tracking_id/{tracking_id} | get_chunk_by_tracking_id
91
- *TrieveRubyClient::ChunkApi* | [**get_recommended_chunks**](docs/ChunkApi.md#get_recommended_chunks) | **POST** /api/chunk/recommend | get_recommended_chunks
92
- *TrieveRubyClient::ChunkApi* | [**search_chunk**](docs/ChunkApi.md#search_chunk) | **POST** /api/chunk/search | search
93
- *TrieveRubyClient::ChunkApi* | [**update_chunk**](docs/ChunkApi.md#update_chunk) | **PUT** /api/chunk/update | update_chunk
94
- *TrieveRubyClient::ChunkApi* | [**update_chunk_by_tracking_id**](docs/ChunkApi.md#update_chunk_by_tracking_id) | **PUT** /api/chunk/tracking_id/update | update_chunk_by_tracking_id
95
- *TrieveRubyClient::ChunkGroupApi* | [**add_chunk_to_group**](docs/ChunkGroupApi.md#add_chunk_to_group) | **POST** /api/chunk_group/chunk/{group_id} | add_chunk_to_group
96
- *TrieveRubyClient::ChunkGroupApi* | [**add_chunk_to_group_by_tracking_id**](docs/ChunkGroupApi.md#add_chunk_to_group_by_tracking_id) | **POST** /api/chunk_group/tracking_id/{tracking_id} | add_chunk_to_group_by_tracking_id
97
- *TrieveRubyClient::ChunkGroupApi* | [**create_chunk_group**](docs/ChunkGroupApi.md#create_chunk_group) | **POST** /api/chunk_group | create_chunk_group
98
- *TrieveRubyClient::ChunkGroupApi* | [**delete_chunk_group**](docs/ChunkGroupApi.md#delete_chunk_group) | **DELETE** /api/{tracking_or_chunk}/{group_id} | delete_chunk_group
99
- *TrieveRubyClient::ChunkGroupApi* | [**delete_group_by_tracking_id**](docs/ChunkGroupApi.md#delete_group_by_tracking_id) | **DELETE** /api/chunk_group/tracking_id/{tracking_id} |
100
- *TrieveRubyClient::ChunkGroupApi* | [**get_chunks_in_group**](docs/ChunkGroupApi.md#get_chunks_in_group) | **GET** /api/chunk_group/{tracking_or_chunk}/{group_id}/{page} | get_chunks_in_group
101
- *TrieveRubyClient::ChunkGroupApi* | [**get_chunks_in_group_by_tracking_id**](docs/ChunkGroupApi.md#get_chunks_in_group_by_tracking_id) | **GET** /api/chunk_group/tracking_id/{group_tracking_id}/{page} | get_chunks_in_group_by_tracking_id
102
- *TrieveRubyClient::ChunkGroupApi* | [**get_group_by_tracking_id**](docs/ChunkGroupApi.md#get_group_by_tracking_id) | **GET** /api/chunk_group/tracking_id/{tracking_id} | get_group_by_tracking_id
103
- *TrieveRubyClient::ChunkGroupApi* | [**get_groups_chunk_is_in**](docs/ChunkGroupApi.md#get_groups_chunk_is_in) | **POST** /api/chunk_group/chunks |
104
- *TrieveRubyClient::ChunkGroupApi* | [**get_recommended_groups**](docs/ChunkGroupApi.md#get_recommended_groups) | **POST** /api/chunk_group/recommend |
105
- *TrieveRubyClient::ChunkGroupApi* | [**get_specific_dataset_chunk_groups**](docs/ChunkGroupApi.md#get_specific_dataset_chunk_groups) | **GET** /api/dataset/groups/{dataset_id}/{page} | get_dataset_groups
106
- *TrieveRubyClient::ChunkGroupApi* | [**remove_chunk_from_group**](docs/ChunkGroupApi.md#remove_chunk_from_group) | **DELETE** /api/chunk_group/chunk/{group_id} | remove_chunk_from_group
107
- *TrieveRubyClient::ChunkGroupApi* | [**search_over_groups**](docs/ChunkGroupApi.md#search_over_groups) | **POST** /api/chunk_group/group_oriented_search | group_oriented_search
108
- *TrieveRubyClient::ChunkGroupApi* | [**search_within_group**](docs/ChunkGroupApi.md#search_within_group) | **POST** /api/chunk_group/search | search_within_group
109
- *TrieveRubyClient::ChunkGroupApi* | [**update_chunk_group**](docs/ChunkGroupApi.md#update_chunk_group) | **PUT** /api/chunk_group | update_chunk_group
110
- *TrieveRubyClient::ChunkGroupApi* | [**update_group_by_tracking_id**](docs/ChunkGroupApi.md#update_group_by_tracking_id) | **PUT** /api/chunk_group/tracking_id/{tracking_id} |
111
- *TrieveRubyClient::DatasetApi* | [**create_dataset**](docs/DatasetApi.md#create_dataset) | **POST** /api/dataset | create_dataset
112
- *TrieveRubyClient::DatasetApi* | [**delete_dataset**](docs/DatasetApi.md#delete_dataset) | **DELETE** /api/dataset | delete_dataset
113
- *TrieveRubyClient::DatasetApi* | [**get_client_dataset_config**](docs/DatasetApi.md#get_client_dataset_config) | **GET** /api/dataset/envs | get_client_dataset_config
114
- *TrieveRubyClient::DatasetApi* | [**get_dataset**](docs/DatasetApi.md#get_dataset) | **GET** /api/dataset/{dataset_id} | get_dataset
115
- *TrieveRubyClient::DatasetApi* | [**get_datasets_from_organization**](docs/DatasetApi.md#get_datasets_from_organization) | **GET** /api/dataset/organization/{organization_id} | get_organization_datasets
116
- *TrieveRubyClient::DatasetApi* | [**update_dataset**](docs/DatasetApi.md#update_dataset) | **PUT** /api/dataset | update_dataset
117
- *TrieveRubyClient::EventsApi* | [**get_events**](docs/EventsApi.md#get_events) | **GET** /api/events/{page} | get_events
118
- *TrieveRubyClient::FileApi* | [**delete_file_handler**](docs/FileApi.md#delete_file_handler) | **DELETE** /api/file/{file_id} | delete_file
119
- *TrieveRubyClient::FileApi* | [**get_dataset_files_handler**](docs/FileApi.md#get_dataset_files_handler) | **GET** /api/dataset/files/{dataset_id}/{page} | get_dataset_files
120
- *TrieveRubyClient::FileApi* | [**get_file_handler**](docs/FileApi.md#get_file_handler) | **GET** /api/file/{file_id} | get_file
121
- *TrieveRubyClient::FileApi* | [**upload_file_handler**](docs/FileApi.md#upload_file_handler) | **POST** /api/file | upload_file
122
- *TrieveRubyClient::HealthApi* | [**health_check**](docs/HealthApi.md#health_check) | **GET** /api/health |
123
- *TrieveRubyClient::InvitationApi* | [**post_invitation**](docs/InvitationApi.md#post_invitation) | **POST** /api/invitation | send_invitation
124
- *TrieveRubyClient::MessageApi* | [**create_message_completion_handler**](docs/MessageApi.md#create_message_completion_handler) | **POST** /api/message | create_message
125
- *TrieveRubyClient::MessageApi* | [**edit_message_handler**](docs/MessageApi.md#edit_message_handler) | **PUT** /api/message | edit_message
126
- *TrieveRubyClient::MessageApi* | [**get_all_topic_messages**](docs/MessageApi.md#get_all_topic_messages) | **GET** /api/messages/{messages_topic_id} | get_all_messages
127
- *TrieveRubyClient::MessageApi* | [**regenerate_message_handler**](docs/MessageApi.md#regenerate_message_handler) | **DELETE** /api/message | regenerate_message
128
- *TrieveRubyClient::OrganizationApi* | [**create_organization**](docs/OrganizationApi.md#create_organization) | **POST** /api/organization | create_organization
129
- *TrieveRubyClient::OrganizationApi* | [**delete_organization_by_id**](docs/OrganizationApi.md#delete_organization_by_id) | **DELETE** /api/organization/{organization_id} | delete_organization
130
- *TrieveRubyClient::OrganizationApi* | [**get_organization_by_id**](docs/OrganizationApi.md#get_organization_by_id) | **GET** /api/organization/{organization_id} | get_organization
131
- *TrieveRubyClient::OrganizationApi* | [**get_organization_usage**](docs/OrganizationApi.md#get_organization_usage) | **GET** /api/organization/usage/{organization_id} | get_organization_usage
132
- *TrieveRubyClient::OrganizationApi* | [**get_organization_users**](docs/OrganizationApi.md#get_organization_users) | **GET** /api/organization/users/{organization_id} | get_organization_users
133
- *TrieveRubyClient::OrganizationApi* | [**update_organization**](docs/OrganizationApi.md#update_organization) | **PUT** /api/organization | update_organization
134
- *TrieveRubyClient::StripeApi* | [**cancel_subscription**](docs/StripeApi.md#cancel_subscription) | **DELETE** /api/stripe/subscription/{subscription_id} |
135
- *TrieveRubyClient::StripeApi* | [**direct_to_payment_link**](docs/StripeApi.md#direct_to_payment_link) | **GET** /api/stripe/payment_link/{plan_id}/{organization_id} |
136
- *TrieveRubyClient::StripeApi* | [**get_all_plans**](docs/StripeApi.md#get_all_plans) | **GET** /api/stripe/plans |
137
- *TrieveRubyClient::StripeApi* | [**update_subscription_plan**](docs/StripeApi.md#update_subscription_plan) | **PATCH** /api/stripe/subscription_plan/{subscription_id}/{plan_id} |
138
- *TrieveRubyClient::TopicApi* | [**create_topic**](docs/TopicApi.md#create_topic) | **POST** /api/topic | create_topic
139
- *TrieveRubyClient::TopicApi* | [**delete_topic**](docs/TopicApi.md#delete_topic) | **DELETE** /api/topic | delete_topic
140
- *TrieveRubyClient::TopicApi* | [**get_all_topics_for_user**](docs/TopicApi.md#get_all_topics_for_user) | **GET** /api/topic/user/{user_id} | get_all_topics_for_user
141
- *TrieveRubyClient::TopicApi* | [**update_topic**](docs/TopicApi.md#update_topic) | **PUT** /api/topic | update_topic
142
- *TrieveRubyClient::UserApi* | [**delete_user_api_key**](docs/UserApi.md#delete_user_api_key) | **DELETE** /api/user/delete_api_key | delete_user_api_key
143
- *TrieveRubyClient::UserApi* | [**set_user_api_key**](docs/UserApi.md#set_user_api_key) | **POST** /api/user/set_api_key | set_user_api_key
144
- *TrieveRubyClient::UserApi* | [**update_user**](docs/UserApi.md#update_user) | **PUT** /api/user | update_user
79
+ *TrieveRubyClient::AuthApi* | [**callback**](docs/AuthApi.md#callback) | **GET** /api/auth/callback | OpenID Connect callback
80
+ *TrieveRubyClient::AuthApi* | [**get_me**](docs/AuthApi.md#get_me) | **GET** /api/auth/me | Get Me
81
+ *TrieveRubyClient::AuthApi* | [**login**](docs/AuthApi.md#login) | **GET** /api/auth | Login
82
+ *TrieveRubyClient::AuthApi* | [**logout**](docs/AuthApi.md#logout) | **DELETE** /api/auth | Logout
83
+ *TrieveRubyClient::ChunkApi* | [**create_chunk**](docs/ChunkApi.md#create_chunk) | **POST** /api/chunk | Create Chunk
84
+ *TrieveRubyClient::ChunkApi* | [**create_suggested_queries_handler**](docs/ChunkApi.md#create_suggested_queries_handler) | **POST** /api/chunk/gen_suggestions | Generate suggested queries
85
+ *TrieveRubyClient::ChunkApi* | [**delete_chunk**](docs/ChunkApi.md#delete_chunk) | **DELETE** /api/chunk/{tracking_or_chunk}/{chunk_id} | Delete Chunk
86
+ *TrieveRubyClient::ChunkApi* | [**delete_chunk_by_tracking_id**](docs/ChunkApi.md#delete_chunk_by_tracking_id) | **DELETE** /api/chunk/tracking_id/{tracking_id} | Delete Chunk By Tracking Id
87
+ *TrieveRubyClient::ChunkApi* | [**generate_off_chunks**](docs/ChunkApi.md#generate_off_chunks) | **POST** /api/chunk/generate | RAG on User Defined Chunks
88
+ *TrieveRubyClient::ChunkApi* | [**get_chunk_by_id**](docs/ChunkApi.md#get_chunk_by_id) | **GET** /api/chunk/{tracking_or_chunk}/{chunk_id} | Get Chunk By Id
89
+ *TrieveRubyClient::ChunkApi* | [**get_chunk_by_tracking_id**](docs/ChunkApi.md#get_chunk_by_tracking_id) | **GET** /api/chunk/tracking_id/{tracking_id} | Get Chunk By Tracking Id
90
+ *TrieveRubyClient::ChunkApi* | [**get_recommended_chunks**](docs/ChunkApi.md#get_recommended_chunks) | **POST** /api/chunk/recommend | Get Recommended Chunks
91
+ *TrieveRubyClient::ChunkApi* | [**search_chunk**](docs/ChunkApi.md#search_chunk) | **POST** /api/chunk/search | Search
92
+ *TrieveRubyClient::ChunkApi* | [**update_chunk**](docs/ChunkApi.md#update_chunk) | **PUT** /api/chunk/update | Update Chunk
93
+ *TrieveRubyClient::ChunkApi* | [**update_chunk_by_tracking_id**](docs/ChunkApi.md#update_chunk_by_tracking_id) | **PUT** /api/chunk/tracking_id/update | Update Chunk By Tracking Id
94
+ *TrieveRubyClient::ChunkGroupApi* | [**add_chunk_to_group**](docs/ChunkGroupApi.md#add_chunk_to_group) | **POST** /api/chunk_group/chunk/{group_id} | Add Chunk to Group
95
+ *TrieveRubyClient::ChunkGroupApi* | [**add_chunk_to_group_by_tracking_id**](docs/ChunkGroupApi.md#add_chunk_to_group_by_tracking_id) | **POST** /api/chunk_group/tracking_id/{tracking_id} | Add Chunk to Group by Tracking ID
96
+ *TrieveRubyClient::ChunkGroupApi* | [**create_chunk_group**](docs/ChunkGroupApi.md#create_chunk_group) | **POST** /api/chunk_group | Create Chunk Group
97
+ *TrieveRubyClient::ChunkGroupApi* | [**delete_chunk_group**](docs/ChunkGroupApi.md#delete_chunk_group) | **DELETE** /api/chunk_group/{tracking_or_chunk}/{group_id} | Delete Group
98
+ *TrieveRubyClient::ChunkGroupApi* | [**delete_group_by_tracking_id**](docs/ChunkGroupApi.md#delete_group_by_tracking_id) | **DELETE** /api/chunk_group/tracking_id/{tracking_id} | Delete Group by Tracking ID
99
+ *TrieveRubyClient::ChunkGroupApi* | [**get_chunk_group**](docs/ChunkGroupApi.md#get_chunk_group) | **GET** /api/chunk_group/{tracking_or_chunk}/{group_id} | Get Group
100
+ *TrieveRubyClient::ChunkGroupApi* | [**get_chunks_in_group**](docs/ChunkGroupApi.md#get_chunks_in_group) | **GET** /api/chunk_group/{tracking_or_chunk}/{group_id}/{page} | Get Chunks in Group
101
+ *TrieveRubyClient::ChunkGroupApi* | [**get_chunks_in_group_by_tracking_id**](docs/ChunkGroupApi.md#get_chunks_in_group_by_tracking_id) | **GET** /api/chunk_group/tracking_id/{group_tracking_id}/{page} | Get Chunks in Group by Tracking ID
102
+ *TrieveRubyClient::ChunkGroupApi* | [**get_group_by_tracking_id**](docs/ChunkGroupApi.md#get_group_by_tracking_id) | **GET** /api/chunk_group/tracking_id/{tracking_id} | Get Group by Tracking ID
103
+ *TrieveRubyClient::ChunkGroupApi* | [**get_groups_chunk_is_in**](docs/ChunkGroupApi.md#get_groups_chunk_is_in) | **POST** /api/chunk_group/chunks | Get Groups for Chunks
104
+ *TrieveRubyClient::ChunkGroupApi* | [**get_recommended_groups**](docs/ChunkGroupApi.md#get_recommended_groups) | **POST** /api/chunk_group/recommend | Get Recommended Groups
105
+ *TrieveRubyClient::ChunkGroupApi* | [**get_specific_dataset_chunk_groups**](docs/ChunkGroupApi.md#get_specific_dataset_chunk_groups) | **GET** /api/dataset/groups/{dataset_id}/{page} | Get Groups for Dataset
106
+ *TrieveRubyClient::ChunkGroupApi* | [**remove_chunk_from_group**](docs/ChunkGroupApi.md#remove_chunk_from_group) | **DELETE** /api/chunk_group/chunk/{group_id} | Remove Chunk from Group
107
+ *TrieveRubyClient::ChunkGroupApi* | [**search_over_groups**](docs/ChunkGroupApi.md#search_over_groups) | **POST** /api/chunk_group/group_oriented_search | Search Over Groups
108
+ *TrieveRubyClient::ChunkGroupApi* | [**search_within_group**](docs/ChunkGroupApi.md#search_within_group) | **POST** /api/chunk_group/search | Search Within Group
109
+ *TrieveRubyClient::ChunkGroupApi* | [**update_chunk_group**](docs/ChunkGroupApi.md#update_chunk_group) | **PUT** /api/chunk_group | Update Group
110
+ *TrieveRubyClient::ChunkGroupApi* | [**update_group_by_tracking_id**](docs/ChunkGroupApi.md#update_group_by_tracking_id) | **PUT** /api/chunk_group/tracking_id/{tracking_id} | Update Group by Tracking ID
111
+ *TrieveRubyClient::DatasetApi* | [**create_dataset**](docs/DatasetApi.md#create_dataset) | **POST** /api/dataset | Create dataset
112
+ *TrieveRubyClient::DatasetApi* | [**delete_dataset**](docs/DatasetApi.md#delete_dataset) | **DELETE** /api/dataset | Delete Dataset
113
+ *TrieveRubyClient::DatasetApi* | [**get_client_dataset_config**](docs/DatasetApi.md#get_client_dataset_config) | **GET** /api/dataset/envs | Get Client Configuration
114
+ *TrieveRubyClient::DatasetApi* | [**get_dataset**](docs/DatasetApi.md#get_dataset) | **GET** /api/dataset/{dataset_id} | Get Dataset
115
+ *TrieveRubyClient::DatasetApi* | [**get_datasets_from_organization**](docs/DatasetApi.md#get_datasets_from_organization) | **GET** /api/dataset/organization/{organization_id} | Get Datasets from Organization
116
+ *TrieveRubyClient::DatasetApi* | [**update_dataset**](docs/DatasetApi.md#update_dataset) | **PUT** /api/dataset | Update Dataset
117
+ *TrieveRubyClient::EventsApi* | [**get_events**](docs/EventsApi.md#get_events) | **POST** /api/events | Get events for the dataset
118
+ *TrieveRubyClient::FileApi* | [**delete_file_handler**](docs/FileApi.md#delete_file_handler) | **DELETE** /api/file/{file_id} | Delete File
119
+ *TrieveRubyClient::FileApi* | [**get_dataset_files_handler**](docs/FileApi.md#get_dataset_files_handler) | **GET** /api/dataset/files/{dataset_id}/{page} | Get Files for Dataset
120
+ *TrieveRubyClient::FileApi* | [**get_file_handler**](docs/FileApi.md#get_file_handler) | **GET** /api/file/{file_id} | Get File
121
+ *TrieveRubyClient::FileApi* | [**upload_file_handler**](docs/FileApi.md#upload_file_handler) | **POST** /api/file | Upload File
122
+ *TrieveRubyClient::HealthApi* | [**health_check**](docs/HealthApi.md#health_check) | **GET** /api/health | Health Check
123
+ *TrieveRubyClient::InvitationApi* | [**post_invitation**](docs/InvitationApi.md#post_invitation) | **POST** /api/invitation | Send Invitation
124
+ *TrieveRubyClient::MessageApi* | [**create_message_completion_handler**](docs/MessageApi.md#create_message_completion_handler) | **POST** /api/message | Create a message
125
+ *TrieveRubyClient::MessageApi* | [**edit_message_handler**](docs/MessageApi.md#edit_message_handler) | **PUT** /api/message | Edit a message
126
+ *TrieveRubyClient::MessageApi* | [**get_all_topic_messages**](docs/MessageApi.md#get_all_topic_messages) | **GET** /api/messages/{messages_topic_id} | Get all messages for a given topic
127
+ *TrieveRubyClient::MessageApi* | [**regenerate_message_handler**](docs/MessageApi.md#regenerate_message_handler) | **DELETE** /api/message | Regenerate message
128
+ *TrieveRubyClient::OrganizationApi* | [**create_organization**](docs/OrganizationApi.md#create_organization) | **POST** /api/organization | Create Organization
129
+ *TrieveRubyClient::OrganizationApi* | [**delete_organization_by_id**](docs/OrganizationApi.md#delete_organization_by_id) | **DELETE** /api/organization/{organization_id} | Delete Organization
130
+ *TrieveRubyClient::OrganizationApi* | [**get_organization_by_id**](docs/OrganizationApi.md#get_organization_by_id) | **GET** /api/organization/{organization_id} | Get Organization
131
+ *TrieveRubyClient::OrganizationApi* | [**get_organization_usage**](docs/OrganizationApi.md#get_organization_usage) | **GET** /api/organization/usage/{organization_id} | Get Organization Usage
132
+ *TrieveRubyClient::OrganizationApi* | [**get_organization_users**](docs/OrganizationApi.md#get_organization_users) | **GET** /api/organization/users/{organization_id} | Get Organization Users
133
+ *TrieveRubyClient::OrganizationApi* | [**update_organization**](docs/OrganizationApi.md#update_organization) | **PUT** /api/organization | Update Organization
134
+ *TrieveRubyClient::StripeApi* | [**cancel_subscription**](docs/StripeApi.md#cancel_subscription) | **DELETE** /api/stripe/subscription/{subscription_id} | Cancel Subscription
135
+ *TrieveRubyClient::StripeApi* | [**direct_to_payment_link**](docs/StripeApi.md#direct_to_payment_link) | **GET** /api/stripe/payment_link/{plan_id}/{organization_id} | Checkout
136
+ *TrieveRubyClient::StripeApi* | [**get_all_plans**](docs/StripeApi.md#get_all_plans) | **GET** /api/stripe/plans | Get All Plans
137
+ *TrieveRubyClient::StripeApi* | [**update_subscription_plan**](docs/StripeApi.md#update_subscription_plan) | **PATCH** /api/stripe/subscription_plan/{subscription_id}/{plan_id} | Update Subscription Plan
138
+ *TrieveRubyClient::TopicApi* | [**create_topic**](docs/TopicApi.md#create_topic) | **POST** /api/topic | Create Topic
139
+ *TrieveRubyClient::TopicApi* | [**delete_topic**](docs/TopicApi.md#delete_topic) | **DELETE** /api/topic | Delete Topic
140
+ *TrieveRubyClient::TopicApi* | [**get_all_topics_for_user**](docs/TopicApi.md#get_all_topics_for_user) | **GET** /api/topic/user/{user_id} | Get All Topics for User
141
+ *TrieveRubyClient::TopicApi* | [**update_topic**](docs/TopicApi.md#update_topic) | **PUT** /api/topic | Update Topic
142
+ *TrieveRubyClient::UserApi* | [**delete_user_api_key**](docs/UserApi.md#delete_user_api_key) | **DELETE** /api/user/delete_api_key | Delete User Api Key
143
+ *TrieveRubyClient::UserApi* | [**set_user_api_key**](docs/UserApi.md#set_user_api_key) | **POST** /api/user/set_api_key | Set User Api Key
144
+ *TrieveRubyClient::UserApi* | [**update_user**](docs/UserApi.md#update_user) | **PUT** /api/user | Update User
145
145
 
146
146
 
147
147
  ## Documentation for Models
148
148
 
149
149
  - [TrieveRubyClient::AddChunkToGroupData](docs/AddChunkToGroupData.md)
150
150
  - [TrieveRubyClient::ApiKeyDTO](docs/ApiKeyDTO.md)
151
+ - [TrieveRubyClient::AuthQuery](docs/AuthQuery.md)
152
+ - [TrieveRubyClient::BatchQueuedChunkResponse](docs/BatchQueuedChunkResponse.md)
151
153
  - [TrieveRubyClient::BookmarkData](docs/BookmarkData.md)
152
154
  - [TrieveRubyClient::BookmarkGroupResult](docs/BookmarkGroupResult.md)
153
155
  - [TrieveRubyClient::ChatMessageProxy](docs/ChatMessageProxy.md)
156
+ - [TrieveRubyClient::ChunkData](docs/ChunkData.md)
154
157
  - [TrieveRubyClient::ChunkFilter](docs/ChunkFilter.md)
155
158
  - [TrieveRubyClient::ChunkGroup](docs/ChunkGroup.md)
156
159
  - [TrieveRubyClient::ChunkGroupAndFile](docs/ChunkGroupAndFile.md)
@@ -178,6 +181,7 @@ Class | Method | HTTP request | Description
178
181
  - [TrieveRubyClient::File](docs/File.md)
179
182
  - [TrieveRubyClient::FileDTO](docs/FileDTO.md)
180
183
  - [TrieveRubyClient::GenerateChunksRequest](docs/GenerateChunksRequest.md)
184
+ - [TrieveRubyClient::GetEventsData](docs/GetEventsData.md)
181
185
  - [TrieveRubyClient::GetGroupsForChunksData](docs/GetGroupsForChunksData.md)
182
186
  - [TrieveRubyClient::GroupData](docs/GroupData.md)
183
187
  - [TrieveRubyClient::GroupScoreChunkDTO](docs/GroupScoreChunkDTO.md)
@@ -200,10 +204,10 @@ Class | Method | HTTP request | Description
200
204
  - [TrieveRubyClient::SearchWithinGroupData](docs/SearchWithinGroupData.md)
201
205
  - [TrieveRubyClient::SetUserApiKeyRequest](docs/SetUserApiKeyRequest.md)
202
206
  - [TrieveRubyClient::SetUserApiKeyResponse](docs/SetUserApiKeyResponse.md)
207
+ - [TrieveRubyClient::SingleQueuedChunkResponse](docs/SingleQueuedChunkResponse.md)
203
208
  - [TrieveRubyClient::SlimGroup](docs/SlimGroup.md)
204
209
  - [TrieveRubyClient::SlimUser](docs/SlimUser.md)
205
210
  - [TrieveRubyClient::StripePlan](docs/StripePlan.md)
206
- - [TrieveRubyClient::StripeSubscription](docs/StripeSubscription.md)
207
211
  - [TrieveRubyClient::SuggestedQueriesRequest](docs/SuggestedQueriesRequest.md)
208
212
  - [TrieveRubyClient::SuggestedQueriesResponse](docs/SuggestedQueriesResponse.md)
209
213
  - [TrieveRubyClient::Topic](docs/Topic.md)
@@ -231,10 +235,3 @@ Authentication schemes defined for the API:
231
235
  - **API key parameter name**: Authorization
232
236
  - **Location**: HTTP header
233
237
 
234
- ### Cookie
235
-
236
-
237
- - **Type**: API key
238
- - **API key parameter name**: Authorization
239
- - **Location**:
240
-
data/docs/AuthApi.md CHANGED
@@ -1,22 +1,22 @@
1
1
  # TrieveRubyClient::AuthApi
2
2
 
3
- All URIs are relative to *http://localhost*
3
+ All URIs are relative to *http://localhost:8090*
4
4
 
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
7
- | [**callback**](AuthApi.md#callback) | **GET** /api/auth/callback | openid_callback |
8
- | [**get_me**](AuthApi.md#get_me) | **GET** /api/auth/me | get_me |
9
- | [**login**](AuthApi.md#login) | **GET** /api/auth | login |
10
- | [**logout**](AuthApi.md#logout) | **DELETE** /api/auth | logout |
7
+ | [**callback**](AuthApi.md#callback) | **GET** /api/auth/callback | OpenID Connect callback |
8
+ | [**get_me**](AuthApi.md#get_me) | **GET** /api/auth/me | Get Me |
9
+ | [**login**](AuthApi.md#login) | **GET** /api/auth | Login |
10
+ | [**logout**](AuthApi.md#logout) | **DELETE** /api/auth | Logout |
11
11
 
12
12
 
13
13
  ## callback
14
14
 
15
15
  > <SlimUser> callback
16
16
 
17
- openid_callback
17
+ OpenID Connect callback
18
18
 
19
- openid_callback This is the callback route for the OAuth provider, it should not be called directly. Redirects to browser with set-cookie header.
19
+ OpenID Connect callback This is the callback route for the OAuth provider, it should not be called directly. Redirects to browser with set-cookie header.
20
20
 
21
21
  ### Examples
22
22
 
@@ -27,7 +27,7 @@ require 'trieve_ruby_client'
27
27
  api_instance = TrieveRubyClient::AuthApi.new
28
28
 
29
29
  begin
30
- # openid_callback
30
+ # OpenID Connect callback
31
31
  result = api_instance.callback
32
32
  p result
33
33
  rescue TrieveRubyClient::ApiError => e
@@ -43,7 +43,7 @@ This returns an Array which contains the response data, status code and headers.
43
43
 
44
44
  ```ruby
45
45
  begin
46
- # openid_callback
46
+ # OpenID Connect callback
47
47
  data, status_code, headers = api_instance.callback_with_http_info
48
48
  p status_code # => 2xx
49
49
  p headers # => { ... }
@@ -75,9 +75,9 @@ No authorization required
75
75
 
76
76
  > <SlimUser> get_me
77
77
 
78
- get_me
78
+ Get Me
79
79
 
80
- get_me Get the user corresponding to your current auth credentials.
80
+ Get Me Get the user corresponding to your current auth credentials.
81
81
 
82
82
  ### Examples
83
83
 
@@ -86,11 +86,6 @@ require 'time'
86
86
  require 'trieve_ruby_client'
87
87
  # setup authorization
88
88
  TrieveRubyClient.configure do |config|
89
- # Configure API key authorization: Cookie
90
- config.api_key['Cookie'] = 'YOUR API KEY'
91
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
92
- # config.api_key_prefix['Cookie'] = 'Bearer'
93
-
94
89
  # Configure API key authorization: ApiKey
95
90
  config.api_key['ApiKey'] = 'YOUR API KEY'
96
91
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
@@ -100,7 +95,7 @@ end
100
95
  api_instance = TrieveRubyClient::AuthApi.new
101
96
 
102
97
  begin
103
- # get_me
98
+ # Get Me
104
99
  result = api_instance.get_me
105
100
  p result
106
101
  rescue TrieveRubyClient::ApiError => e
@@ -116,7 +111,7 @@ This returns an Array which contains the response data, status code and headers.
116
111
 
117
112
  ```ruby
118
113
  begin
119
- # get_me
114
+ # Get Me
120
115
  data, status_code, headers = api_instance.get_me_with_http_info
121
116
  p status_code # => 2xx
122
117
  p headers # => { ... }
@@ -136,7 +131,7 @@ This endpoint does not need any parameter.
136
131
 
137
132
  ### Authorization
138
133
 
139
- [Cookie](../README.md#Cookie), [ApiKey](../README.md#ApiKey)
134
+ [ApiKey](../README.md#ApiKey)
140
135
 
141
136
  ### HTTP request headers
142
137
 
@@ -146,11 +141,11 @@ This endpoint does not need any parameter.
146
141
 
147
142
  ## login
148
143
 
149
- > login(opts)
144
+ > login(content)
150
145
 
151
- login
146
+ Login
152
147
 
153
- login This will redirect you to the OAuth provider for authentication with email/pass, SSO, Google, Github, etc.
148
+ Login This will redirect you to the OAuth provider for authentication with email/pass, SSO, Google, Github, etc.
154
149
 
155
150
  ### Examples
156
151
 
@@ -159,15 +154,11 @@ require 'time'
159
154
  require 'trieve_ruby_client'
160
155
 
161
156
  api_instance = TrieveRubyClient::AuthApi.new
162
- opts = {
163
- inv_code: '38400000-8cf0-11bd-b23e-10b96e4ef00d', # String | Code sent via email as a result of successful call to send_invitation
164
- organization_id: '38400000-8cf0-11bd-b23e-10b96e4ef00d', # String | ID of organization to authenticate into
165
- redirect_uri: 'redirect_uri_example' # String | URL to redirect to after successful login
166
- }
157
+ content = TrieveRubyClient::AuthQuery.new # AuthQuery | Query parameters for login to be included as kv pairs after ? on the request URL.
167
158
 
168
159
  begin
169
- # login
170
- api_instance.login(opts)
160
+ # Login
161
+ api_instance.login(content)
171
162
  rescue TrieveRubyClient::ApiError => e
172
163
  puts "Error when calling AuthApi->login: #{e}"
173
164
  end
@@ -177,12 +168,12 @@ end
177
168
 
178
169
  This returns an Array which contains the response data (`nil` in this case), status code and headers.
179
170
 
180
- > <Array(nil, Integer, Hash)> login_with_http_info(opts)
171
+ > <Array(nil, Integer, Hash)> login_with_http_info(content)
181
172
 
182
173
  ```ruby
183
174
  begin
184
- # login
185
- data, status_code, headers = api_instance.login_with_http_info(opts)
175
+ # Login
176
+ data, status_code, headers = api_instance.login_with_http_info(content)
186
177
  p status_code # => 2xx
187
178
  p headers # => { ... }
188
179
  p data # => nil
@@ -195,9 +186,7 @@ end
195
186
 
196
187
  | Name | Type | Description | Notes |
197
188
  | ---- | ---- | ----------- | ----- |
198
- | **inv_code** | **String** | Code sent via email as a result of successful call to send_invitation | [optional] |
199
- | **organization_id** | **String** | ID of organization to authenticate into | [optional] |
200
- | **redirect_uri** | **String** | URL to redirect to after successful login | [optional] |
189
+ | **content** | [**AuthQuery**](.md) | Query parameters for login to be included as kv pairs after ? on the request URL. | |
201
190
 
202
191
  ### Return type
203
192
 
@@ -209,7 +198,7 @@ No authorization required
209
198
 
210
199
  ### HTTP request headers
211
200
 
212
- - **Content-Type**: application/x-www-form-urlencoded
201
+ - **Content-Type**: Not defined
213
202
  - **Accept**: application/json
214
203
 
215
204
 
@@ -217,9 +206,9 @@ No authorization required
217
206
 
218
207
  > logout
219
208
 
220
- logout
209
+ Logout
221
210
 
222
- logout Invalidate your current auth credential stored typically stored in a cookie. This does not invalidate your API key.
211
+ Logout Invalidate your current auth credential stored typically stored in a cookie. This does not invalidate your API key.
223
212
 
224
213
  ### Examples
225
214
 
@@ -230,7 +219,7 @@ require 'trieve_ruby_client'
230
219
  api_instance = TrieveRubyClient::AuthApi.new
231
220
 
232
221
  begin
233
- # logout
222
+ # Logout
234
223
  api_instance.logout
235
224
  rescue TrieveRubyClient::ApiError => e
236
225
  puts "Error when calling AuthApi->logout: #{e}"
@@ -245,7 +234,7 @@ This returns an Array which contains the response data (`nil` in this case), sta
245
234
 
246
235
  ```ruby
247
236
  begin
248
- # logout
237
+ # Logout
249
238
  data, status_code, headers = api_instance.logout_with_http_info
250
239
  p status_code # => 2xx
251
240
  p headers # => { ... }
data/docs/AuthQuery.md ADDED
@@ -0,0 +1,22 @@
1
+ # TrieveRubyClient::AuthQuery
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **inv_code** | **String** | Code sent via email as a result of successful call to send_invitation | [optional] |
8
+ | **organization_id** | **String** | ID of organization to authenticate into | [optional] |
9
+ | **redirect_uri** | **String** | URL to redirect to after successful login | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'trieve_ruby_client'
15
+
16
+ instance = TrieveRubyClient::AuthQuery.new(
17
+ inv_code: null,
18
+ organization_id: null,
19
+ redirect_uri: null
20
+ )
21
+ ```
22
+
data/docs/BatchQueuedChunkResponse.md ADDED
@@ -0,0 +1,20 @@
1
+ # TrieveRubyClient::BatchQueuedChunkResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **chunk_metadata** | [**Array&lt;ChunkMetadata&gt;**](ChunkMetadata.md) | | |
8
+ | **pos_in_queue** | **Integer** | The current position the last access item is in the queue | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'trieve_ruby_client'
14
+
15
+ instance = TrieveRubyClient::BatchQueuedChunkResponse.new(
16
+ chunk_metadata: null,
17
+ pos_in_queue: null
18
+ )
19
+ ```
20
+