ragie_ruby_sdk 1.0.1

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 (454) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +9 -0
  3. data/README.md +291 -0
  4. data/Rakefile +10 -0
  5. data/docs/AccessTokenCredentials.md +18 -0
  6. data/docs/AsyncDocumentMetadataUpdate.md +18 -0
  7. data/docs/AudioModalityData.md +20 -0
  8. data/docs/AuthenticatorConfluenceConnection.md +22 -0
  9. data/docs/AuthenticatorDropboxConnection.md +24 -0
  10. data/docs/AuthenticatorGmailConnection.md +24 -0
  11. data/docs/AuthenticatorGoogleDriveConnection.md +24 -0
  12. data/docs/AuthenticatorHubspotConnection.md +26 -0
  13. data/docs/AuthenticatorJiraConnection.md +20 -0
  14. data/docs/AuthenticatorList.md +20 -0
  15. data/docs/AuthenticatorNotionConnection.md +26 -0
  16. data/docs/AuthenticatorOnedriveConnection.md +24 -0
  17. data/docs/AuthenticatorSalesforceConnection.md +24 -0
  18. data/docs/AuthenticatorSharepointConnection.md +24 -0
  19. data/docs/AuthenticatorSlackConnection.md +24 -0
  20. data/docs/AuthenticatorsApi.md +293 -0
  21. data/docs/BackblazeCredentials.md +24 -0
  22. data/docs/BaseGetAuthenticator.md +22 -0
  23. data/docs/BetaApi.md +363 -0
  24. data/docs/Body.md +22 -0
  25. data/docs/BodyCreateDocument.md +28 -0
  26. data/docs/BodyUpdateDocumentFile.md +20 -0
  27. data/docs/BucketData.md +22 -0
  28. data/docs/ConfluenceData.md +24 -0
  29. data/docs/Connection.md +44 -0
  30. data/docs/Connection1.md +106 -0
  31. data/docs/Connection2.md +91 -0
  32. data/docs/ConnectionBase.md +22 -0
  33. data/docs/ConnectionLimitExceededWebhook.md +22 -0
  34. data/docs/ConnectionLimitExceededWebhookPayload.md +24 -0
  35. data/docs/ConnectionLimitParams.md +18 -0
  36. data/docs/ConnectionList.md +20 -0
  37. data/docs/ConnectionStats.md +20 -0
  38. data/docs/ConnectionSyncFinishedWebhook.md +22 -0
  39. data/docs/ConnectionSyncFinishedWebhookPayload.md +24 -0
  40. data/docs/ConnectionSyncProgressWebhook.md +22 -0
  41. data/docs/ConnectionSyncProgressWebhookPayload.md +42 -0
  42. data/docs/ConnectionSyncStartedWebhook.md +22 -0
  43. data/docs/ConnectionSyncStartedWebhookPayload.md +32 -0
  44. data/docs/ConnectionsApi.md +790 -0
  45. data/docs/ConnectorSource.md +15 -0
  46. data/docs/ConnectorSourceTypeInfo.md +24 -0
  47. data/docs/CreateAuthenticatorConnection.md +28 -0
  48. data/docs/CreateDocumentFromUrlParams.md +28 -0
  49. data/docs/CreateDocumentRawParams.md +26 -0
  50. data/docs/CreateGoogleAuthenticator.md +28 -0
  51. data/docs/CreateInstructionParams.md +30 -0
  52. data/docs/CreatePartitionParams.md +42 -0
  53. data/docs/Data.md +15 -0
  54. data/docs/DefaultApi.md +77 -0
  55. data/docs/DeleteConnectionPayload.md +18 -0
  56. data/docs/Document.md +36 -0
  57. data/docs/DocumentChunk.md +26 -0
  58. data/docs/DocumentChunkDetail.md +28 -0
  59. data/docs/DocumentChunkDetailModalityData.md +79 -0
  60. data/docs/DocumentChunkList.md +20 -0
  61. data/docs/DocumentDelete.md +18 -0
  62. data/docs/DocumentDeleteWebhook.md +22 -0
  63. data/docs/DocumentDeleteWebhookPayload.md +30 -0
  64. data/docs/DocumentFileUpdate.md +18 -0
  65. data/docs/DocumentGet.md +38 -0
  66. data/docs/DocumentList.md +20 -0
  67. data/docs/DocumentMetadataUpdate.md +18 -0
  68. data/docs/DocumentRawUpdate.md +18 -0
  69. data/docs/DocumentSummary.md +20 -0
  70. data/docs/DocumentUpdateWebhook.md +22 -0
  71. data/docs/DocumentUpdateWebhookPayload.md +34 -0
  72. data/docs/DocumentUrlUpdate.md +18 -0
  73. data/docs/DocumentWithContent.md +38 -0
  74. data/docs/DocumentsApi.md +1221 -0
  75. data/docs/EnterpriseApi.md +363 -0
  76. data/docs/EntitiesApi.md +436 -0
  77. data/docs/Entity.md +30 -0
  78. data/docs/EntityExtractedWebhook.md +22 -0
  79. data/docs/EntityExtractedWebhookPayload.md +34 -0
  80. data/docs/EntityList.md +20 -0
  81. data/docs/ErrorMessage.md +18 -0
  82. data/docs/FolderData.md +20 -0
  83. data/docs/FreshdeskCredentials.md +20 -0
  84. data/docs/FreshdeskData.md +20 -0
  85. data/docs/GmailData.md +18 -0
  86. data/docs/GoogleFolderData.md +22 -0
  87. data/docs/HTTPValidationError.md +18 -0
  88. data/docs/HubspotData.md +30 -0
  89. data/docs/Instruction.md +36 -0
  90. data/docs/IntercomCredentials.md +22 -0
  91. data/docs/IntercomData.md +28 -0
  92. data/docs/Link.md +20 -0
  93. data/docs/ListConnectorSourceTypeInfo.md +18 -0
  94. data/docs/MediaModeParam.md +22 -0
  95. data/docs/MediaType.md +15 -0
  96. data/docs/MetadataValue.md +15 -0
  97. data/docs/MetadataValue1.md +53 -0
  98. data/docs/Mode.md +22 -0
  99. data/docs/Mode1.md +22 -0
  100. data/docs/Mode2.md +49 -0
  101. data/docs/Mode2OneOf.md +22 -0
  102. data/docs/OAuthCredentials.md +26 -0
  103. data/docs/OAuthRefreshTokenCredentials.md +18 -0
  104. data/docs/OAuthUrlCreate.md +34 -0
  105. data/docs/OAuthUrlResponse.md +18 -0
  106. data/docs/OnedriveData.md +22 -0
  107. data/docs/Pagination.md +20 -0
  108. data/docs/Partition.md +24 -0
  109. data/docs/PartitionDetail.md +26 -0
  110. data/docs/PartitionLimitExceededWebhook.md +22 -0
  111. data/docs/PartitionLimitExceededWebhookPayload.md +20 -0
  112. data/docs/PartitionLimitParams.md +40 -0
  113. data/docs/PartitionLimitResetWebhook.md +22 -0
  114. data/docs/PartitionLimitResetWebhookPayload.md +18 -0
  115. data/docs/PartitionLimits.md +40 -0
  116. data/docs/PartitionList.md +20 -0
  117. data/docs/PartitionStats.md +42 -0
  118. data/docs/PartitionStrategy.md +22 -0
  119. data/docs/PartitionsApi.md +363 -0
  120. data/docs/PatchDocumentMetadataParams.md +20 -0
  121. data/docs/Payload.md +84 -0
  122. data/docs/PublicBackblazeConnection.md +22 -0
  123. data/docs/PublicCreateConnection.md +28 -0
  124. data/docs/PublicFreshdeskConnection.md +24 -0
  125. data/docs/PublicGCSConnection.md +22 -0
  126. data/docs/PublicIntercomConnection.md +22 -0
  127. data/docs/PublicS3CompatibleConnection.md +22 -0
  128. data/docs/PublicZendeskConnection.md +22 -0
  129. data/docs/ResponseOK.md +18 -0
  130. data/docs/ResponsePatchdocumentmetadata.md +20 -0
  131. data/docs/Retrieval.md +18 -0
  132. data/docs/RetrievalsApi.md +75 -0
  133. data/docs/RetrieveParams.md +30 -0
  134. data/docs/S3CompatibleCredentials.md +24 -0
  135. data/docs/ScoredChunk.md +34 -0
  136. data/docs/SetConnectionEnabledPayload.md +20 -0
  137. data/docs/SharepointData.md +20 -0
  138. data/docs/SharepointFileData.md +22 -0
  139. data/docs/SharepointSiteData.md +20 -0
  140. data/docs/SlackData.md +20 -0
  141. data/docs/Source.md +15 -0
  142. data/docs/Status.md +15 -0
  143. data/docs/UpdateDocumentFromUrlParams.md +20 -0
  144. data/docs/UpdateDocumentRawParams.md +18 -0
  145. data/docs/UpdateInstructionParams.md +18 -0
  146. data/docs/ValidationError.md +22 -0
  147. data/docs/ValidationErrorLocInner.md +15 -0
  148. data/docs/VideoModalityData.md +20 -0
  149. data/docs/WordTimestamp.md +24 -0
  150. data/docs/ZendeskCredentials.md +22 -0
  151. data/docs/ZendeskData.md +18 -0
  152. data/git_push.sh +57 -0
  153. data/lib/ragie_ruby_sdk/api/authenticators_api.rb +298 -0
  154. data/lib/ragie_ruby_sdk/api/beta_api.rb +366 -0
  155. data/lib/ragie_ruby_sdk/api/connections_api.rb +777 -0
  156. data/lib/ragie_ruby_sdk/api/default_api.rb +90 -0
  157. data/lib/ragie_ruby_sdk/api/documents_api.rb +1206 -0
  158. data/lib/ragie_ruby_sdk/api/enterprise_api.rb +366 -0
  159. data/lib/ragie_ruby_sdk/api/entities_api.rb +438 -0
  160. data/lib/ragie_ruby_sdk/api/partitions_api.rb +361 -0
  161. data/lib/ragie_ruby_sdk/api/retrievals_api.rb +88 -0
  162. data/lib/ragie_ruby_sdk/api_client.rb +393 -0
  163. data/lib/ragie_ruby_sdk/api_error.rb +58 -0
  164. data/lib/ragie_ruby_sdk/configuration.rb +308 -0
  165. data/lib/ragie_ruby_sdk/models/access_token_credentials.rb +237 -0
  166. data/lib/ragie_ruby_sdk/models/async_document_metadata_update.rb +237 -0
  167. data/lib/ragie_ruby_sdk/models/audio_modality_data.rb +267 -0
  168. data/lib/ragie_ruby_sdk/models/authenticator_confluence_connection.rb +315 -0
  169. data/lib/ragie_ruby_sdk/models/authenticator_dropbox_connection.rb +340 -0
  170. data/lib/ragie_ruby_sdk/models/authenticator_gmail_connection.rb +340 -0
  171. data/lib/ragie_ruby_sdk/models/authenticator_google_drive_connection.rb +342 -0
  172. data/lib/ragie_ruby_sdk/models/authenticator_hubspot_connection.rb +365 -0
  173. data/lib/ragie_ruby_sdk/models/authenticator_jira_connection.rb +287 -0
  174. data/lib/ragie_ruby_sdk/models/authenticator_list.rb +265 -0
  175. data/lib/ragie_ruby_sdk/models/authenticator_notion_connection.rb +366 -0
  176. data/lib/ragie_ruby_sdk/models/authenticator_onedrive_connection.rb +340 -0
  177. data/lib/ragie_ruby_sdk/models/authenticator_salesforce_connection.rb +341 -0
  178. data/lib/ragie_ruby_sdk/models/authenticator_sharepoint_connection.rb +340 -0
  179. data/lib/ragie_ruby_sdk/models/authenticator_slack_connection.rb +340 -0
  180. data/lib/ragie_ruby_sdk/models/backblaze_credentials.rb +315 -0
  181. data/lib/ragie_ruby_sdk/models/base_get_authenticator.rb +290 -0
  182. data/lib/ragie_ruby_sdk/models/body.rb +111 -0
  183. data/lib/ragie_ruby_sdk/models/body_create_document.rb +292 -0
  184. data/lib/ragie_ruby_sdk/models/body_update_document_file.rb +250 -0
  185. data/lib/ragie_ruby_sdk/models/bucket_data.rb +258 -0
  186. data/lib/ragie_ruby_sdk/models/confluence_data.rb +315 -0
  187. data/lib/ragie_ruby_sdk/models/connection.rb +521 -0
  188. data/lib/ragie_ruby_sdk/models/connection1.rb +73 -0
  189. data/lib/ragie_ruby_sdk/models/connection2.rb +63 -0
  190. data/lib/ragie_ruby_sdk/models/connection_base.rb +274 -0
  191. data/lib/ragie_ruby_sdk/models/connection_limit_exceeded_webhook.rb +313 -0
  192. data/lib/ragie_ruby_sdk/models/connection_limit_exceeded_webhook_payload.rb +327 -0
  193. data/lib/ragie_ruby_sdk/models/connection_limit_params.rb +236 -0
  194. data/lib/ragie_ruby_sdk/models/connection_list.rb +265 -0
  195. data/lib/ragie_ruby_sdk/models/connection_stats.rb +263 -0
  196. data/lib/ragie_ruby_sdk/models/connection_sync_finished_webhook.rb +313 -0
  197. data/lib/ragie_ruby_sdk/models/connection_sync_finished_webhook_payload.rb +317 -0
  198. data/lib/ragie_ruby_sdk/models/connection_sync_progress_webhook.rb +313 -0
  199. data/lib/ragie_ruby_sdk/models/connection_sync_progress_webhook_payload.rb +551 -0
  200. data/lib/ragie_ruby_sdk/models/connection_sync_started_webhook.rb +313 -0
  201. data/lib/ragie_ruby_sdk/models/connection_sync_started_webhook_payload.rb +421 -0
  202. data/lib/ragie_ruby_sdk/models/connector_source.rb +55 -0
  203. data/lib/ragie_ruby_sdk/models/connector_source_type_info.rb +337 -0
  204. data/lib/ragie_ruby_sdk/models/create_authenticator_connection.rb +307 -0
  205. data/lib/ragie_ruby_sdk/models/create_document_from_url_params.rb +306 -0
  206. data/lib/ragie_ruby_sdk/models/create_document_raw_params.rb +279 -0
  207. data/lib/ragie_ruby_sdk/models/create_google_authenticator.rb +360 -0
  208. data/lib/ragie_ruby_sdk/models/create_instruction_params.rb +373 -0
  209. data/lib/ragie_ruby_sdk/models/create_partition_params.rb +537 -0
  210. data/lib/ragie_ruby_sdk/models/data.rb +105 -0
  211. data/lib/ragie_ruby_sdk/models/delete_connection_payload.rb +237 -0
  212. data/lib/ragie_ruby_sdk/models/document.rb +425 -0
  213. data/lib/ragie_ruby_sdk/models/document_chunk.rb +313 -0
  214. data/lib/ragie_ruby_sdk/models/document_chunk_detail.rb +323 -0
  215. data/lib/ragie_ruby_sdk/models/document_chunk_detail_modality_data.rb +55 -0
  216. data/lib/ragie_ruby_sdk/models/document_chunk_list.rb +265 -0
  217. data/lib/ragie_ruby_sdk/models/document_delete.rb +237 -0
  218. data/lib/ragie_ruby_sdk/models/document_delete_webhook.rb +313 -0
  219. data/lib/ragie_ruby_sdk/models/document_delete_webhook_payload.rb +353 -0
  220. data/lib/ragie_ruby_sdk/models/document_file_update.rb +237 -0
  221. data/lib/ragie_ruby_sdk/models/document_get.rb +453 -0
  222. data/lib/ragie_ruby_sdk/models/document_list.rb +265 -0
  223. data/lib/ragie_ruby_sdk/models/document_metadata_update.rb +240 -0
  224. data/lib/ragie_ruby_sdk/models/document_raw_update.rb +237 -0
  225. data/lib/ragie_ruby_sdk/models/document_summary.rb +263 -0
  226. data/lib/ragie_ruby_sdk/models/document_update_webhook.rb +313 -0
  227. data/lib/ragie_ruby_sdk/models/document_update_webhook_payload.rb +391 -0
  228. data/lib/ragie_ruby_sdk/models/document_url_update.rb +237 -0
  229. data/lib/ragie_ruby_sdk/models/document_with_content.rb +451 -0
  230. data/lib/ragie_ruby_sdk/models/entity.rb +381 -0
  231. data/lib/ragie_ruby_sdk/models/entity_extracted_webhook.rb +313 -0
  232. data/lib/ragie_ruby_sdk/models/entity_extracted_webhook_payload.rb +421 -0
  233. data/lib/ragie_ruby_sdk/models/entity_list.rb +265 -0
  234. data/lib/ragie_ruby_sdk/models/error_message.rb +237 -0
  235. data/lib/ragie_ruby_sdk/models/folder_data.rb +263 -0
  236. data/lib/ragie_ruby_sdk/models/freshdesk_credentials.rb +263 -0
  237. data/lib/ragie_ruby_sdk/models/freshdesk_data.rb +263 -0
  238. data/lib/ragie_ruby_sdk/models/gmail_data.rb +221 -0
  239. data/lib/ragie_ruby_sdk/models/google_folder_data.rb +289 -0
  240. data/lib/ragie_ruby_sdk/models/http_validation_error.rb +222 -0
  241. data/lib/ragie_ruby_sdk/models/hubspot_data.rb +393 -0
  242. data/lib/ragie_ruby_sdk/models/instruction.rb +451 -0
  243. data/lib/ragie_ruby_sdk/models/intercom_credentials.rb +290 -0
  244. data/lib/ragie_ruby_sdk/models/intercom_data.rb +367 -0
  245. data/lib/ragie_ruby_sdk/models/link.rb +263 -0
  246. data/lib/ragie_ruby_sdk/models/list_connector_source_type_info.rb +239 -0
  247. data/lib/ragie_ruby_sdk/models/media_mode_param.rb +287 -0
  248. data/lib/ragie_ruby_sdk/models/media_type.rb +104 -0
  249. data/lib/ragie_ruby_sdk/models/metadata_value.rb +106 -0
  250. data/lib/ragie_ruby_sdk/models/metadata_value1.rb +107 -0
  251. data/lib/ragie_ruby_sdk/models/mode.rb +105 -0
  252. data/lib/ragie_ruby_sdk/models/mode1.rb +104 -0
  253. data/lib/ragie_ruby_sdk/models/mode2.rb +106 -0
  254. data/lib/ragie_ruby_sdk/models/mode2_one_of.rb +287 -0
  255. data/lib/ragie_ruby_sdk/models/o_auth_credentials.rb +350 -0
  256. data/lib/ragie_ruby_sdk/models/o_auth_refresh_token_credentials.rb +237 -0
  257. data/lib/ragie_ruby_sdk/models/o_auth_url_create.rb +370 -0
  258. data/lib/ragie_ruby_sdk/models/o_auth_url_response.rb +237 -0
  259. data/lib/ragie_ruby_sdk/models/onedrive_data.rb +289 -0
  260. data/lib/ragie_ruby_sdk/models/pagination.rb +247 -0
  261. data/lib/ragie_ruby_sdk/models/partition.rb +299 -0
  262. data/lib/ragie_ruby_sdk/models/partition_detail.rb +325 -0
  263. data/lib/ragie_ruby_sdk/models/partition_limit_exceeded_webhook.rb +313 -0
  264. data/lib/ragie_ruby_sdk/models/partition_limit_exceeded_webhook_payload.rb +287 -0
  265. data/lib/ragie_ruby_sdk/models/partition_limit_params.rb +511 -0
  266. data/lib/ragie_ruby_sdk/models/partition_limit_reset_webhook.rb +313 -0
  267. data/lib/ragie_ruby_sdk/models/partition_limit_reset_webhook_payload.rb +237 -0
  268. data/lib/ragie_ruby_sdk/models/partition_limits.rb +511 -0
  269. data/lib/ragie_ruby_sdk/models/partition_list.rb +265 -0
  270. data/lib/ragie_ruby_sdk/models/partition_stats.rb +562 -0
  271. data/lib/ragie_ruby_sdk/models/partition_strategy.rb +104 -0
  272. data/lib/ragie_ruby_sdk/models/patch_document_metadata_params.rb +252 -0
  273. data/lib/ragie_ruby_sdk/models/payload.rb +60 -0
  274. data/lib/ragie_ruby_sdk/models/public_backblaze_connection.rb +313 -0
  275. data/lib/ragie_ruby_sdk/models/public_create_connection.rb +307 -0
  276. data/lib/ragie_ruby_sdk/models/public_freshdesk_connection.rb +340 -0
  277. data/lib/ragie_ruby_sdk/models/public_gcs_connection.rb +315 -0
  278. data/lib/ragie_ruby_sdk/models/public_intercom_connection.rb +313 -0
  279. data/lib/ragie_ruby_sdk/models/public_s3_compatible_connection.rb +313 -0
  280. data/lib/ragie_ruby_sdk/models/public_zendesk_connection.rb +313 -0
  281. data/lib/ragie_ruby_sdk/models/response_ok.rb +222 -0
  282. data/lib/ragie_ruby_sdk/models/response_patchdocumentmetadata.rb +104 -0
  283. data/lib/ragie_ruby_sdk/models/retrieval.rb +239 -0
  284. data/lib/ragie_ruby_sdk/models/retrieve_params.rb +305 -0
  285. data/lib/ragie_ruby_sdk/models/s3_compatible_credentials.rb +299 -0
  286. data/lib/ragie_ruby_sdk/models/scored_chunk.rb +434 -0
  287. data/lib/ragie_ruby_sdk/models/set_connection_enabled_payload.rb +281 -0
  288. data/lib/ragie_ruby_sdk/models/sharepoint_data.rb +265 -0
  289. data/lib/ragie_ruby_sdk/models/sharepoint_file_data.rb +313 -0
  290. data/lib/ragie_ruby_sdk/models/sharepoint_site_data.rb +263 -0
  291. data/lib/ragie_ruby_sdk/models/slack_data.rb +263 -0
  292. data/lib/ragie_ruby_sdk/models/source.rb +105 -0
  293. data/lib/ragie_ruby_sdk/models/status.rb +103 -0
  294. data/lib/ragie_ruby_sdk/models/update_document_from_url_params.rb +247 -0
  295. data/lib/ragie_ruby_sdk/models/update_document_raw_params.rb +237 -0
  296. data/lib/ragie_ruby_sdk/models/update_instruction_params.rb +238 -0
  297. data/lib/ragie_ruby_sdk/models/validation_error.rb +291 -0
  298. data/lib/ragie_ruby_sdk/models/validation_error_loc_inner.rb +104 -0
  299. data/lib/ragie_ruby_sdk/models/video_modality_data.rb +267 -0
  300. data/lib/ragie_ruby_sdk/models/word_timestamp.rb +315 -0
  301. data/lib/ragie_ruby_sdk/models/zendesk_credentials.rb +289 -0
  302. data/lib/ragie_ruby_sdk/models/zendesk_data.rb +237 -0
  303. data/lib/ragie_ruby_sdk/version.rb +15 -0
  304. data/lib/ragie_ruby_sdk.rb +185 -0
  305. data/ragie_ruby_sdk.gemspec +39 -0
  306. data/spec/api/authenticators_api_spec.rb +85 -0
  307. data/spec/api/beta_api_spec.rb +97 -0
  308. data/spec/api/connections_api_spec.rb +173 -0
  309. data/spec/api/default_api_spec.rb +47 -0
  310. data/spec/api/documents_api_spec.rb +260 -0
  311. data/spec/api/enterprise_api_spec.rb +97 -0
  312. data/spec/api/entities_api_spec.rb +110 -0
  313. data/spec/api/partitions_api_spec.rb +97 -0
  314. data/spec/api/retrievals_api_spec.rb +46 -0
  315. data/spec/models/access_token_credentials_spec.rb +36 -0
  316. data/spec/models/async_document_metadata_update_spec.rb +36 -0
  317. data/spec/models/audio_modality_data_spec.rb +46 -0
  318. data/spec/models/authenticator_confluence_connection_spec.rb +52 -0
  319. data/spec/models/authenticator_dropbox_connection_spec.rb +58 -0
  320. data/spec/models/authenticator_gmail_connection_spec.rb +58 -0
  321. data/spec/models/authenticator_google_drive_connection_spec.rb +58 -0
  322. data/spec/models/authenticator_hubspot_connection_spec.rb +64 -0
  323. data/spec/models/authenticator_jira_connection_spec.rb +46 -0
  324. data/spec/models/authenticator_list_spec.rb +42 -0
  325. data/spec/models/authenticator_notion_connection_spec.rb +64 -0
  326. data/spec/models/authenticator_onedrive_connection_spec.rb +58 -0
  327. data/spec/models/authenticator_salesforce_connection_spec.rb +58 -0
  328. data/spec/models/authenticator_sharepoint_connection_spec.rb +58 -0
  329. data/spec/models/authenticator_slack_connection_spec.rb +58 -0
  330. data/spec/models/backblaze_credentials_spec.rb +54 -0
  331. data/spec/models/base_get_authenticator_spec.rb +48 -0
  332. data/spec/models/body_create_document_spec.rb +66 -0
  333. data/spec/models/body_spec.rb +21 -0
  334. data/spec/models/body_update_document_file_spec.rb +42 -0
  335. data/spec/models/bucket_data_spec.rb +48 -0
  336. data/spec/models/confluence_data_spec.rb +54 -0
  337. data/spec/models/connection1_spec.rb +44 -0
  338. data/spec/models/connection2_spec.rb +44 -0
  339. data/spec/models/connection_base_spec.rb +48 -0
  340. data/spec/models/connection_limit_exceeded_webhook_payload_spec.rb +58 -0
  341. data/spec/models/connection_limit_exceeded_webhook_spec.rb +52 -0
  342. data/spec/models/connection_limit_params_spec.rb +36 -0
  343. data/spec/models/connection_list_spec.rb +42 -0
  344. data/spec/models/connection_spec.rb +118 -0
  345. data/spec/models/connection_stats_spec.rb +42 -0
  346. data/spec/models/connection_sync_finished_webhook_payload_spec.rb +54 -0
  347. data/spec/models/connection_sync_finished_webhook_spec.rb +52 -0
  348. data/spec/models/connection_sync_progress_webhook_payload_spec.rb +108 -0
  349. data/spec/models/connection_sync_progress_webhook_spec.rb +52 -0
  350. data/spec/models/connection_sync_started_webhook_payload_spec.rb +78 -0
  351. data/spec/models/connection_sync_started_webhook_spec.rb +52 -0
  352. data/spec/models/connector_source_spec.rb +30 -0
  353. data/spec/models/connector_source_type_info_spec.rb +54 -0
  354. data/spec/models/create_authenticator_connection_spec.rb +66 -0
  355. data/spec/models/create_document_from_url_params_spec.rb +66 -0
  356. data/spec/models/create_document_raw_params_spec.rb +60 -0
  357. data/spec/models/create_google_authenticator_spec.rb +70 -0
  358. data/spec/models/create_instruction_params_spec.rb +76 -0
  359. data/spec/models/create_partition_params_spec.rb +108 -0
  360. data/spec/models/data_spec.rb +21 -0
  361. data/spec/models/delete_connection_payload_spec.rb +36 -0
  362. data/spec/models/document_chunk_detail_modality_data_spec.rb +44 -0
  363. data/spec/models/document_chunk_detail_spec.rb +66 -0
  364. data/spec/models/document_chunk_list_spec.rb +42 -0
  365. data/spec/models/document_chunk_spec.rb +60 -0
  366. data/spec/models/document_delete_spec.rb +36 -0
  367. data/spec/models/document_delete_webhook_payload_spec.rb +72 -0
  368. data/spec/models/document_delete_webhook_spec.rb +52 -0
  369. data/spec/models/document_file_update_spec.rb +36 -0
  370. data/spec/models/document_get_spec.rb +96 -0
  371. data/spec/models/document_list_spec.rb +42 -0
  372. data/spec/models/document_metadata_update_spec.rb +36 -0
  373. data/spec/models/document_raw_update_spec.rb +36 -0
  374. data/spec/models/document_spec.rb +90 -0
  375. data/spec/models/document_summary_spec.rb +42 -0
  376. data/spec/models/document_update_webhook_payload_spec.rb +84 -0
  377. data/spec/models/document_update_webhook_spec.rb +52 -0
  378. data/spec/models/document_url_update_spec.rb +36 -0
  379. data/spec/models/document_with_content_spec.rb +96 -0
  380. data/spec/models/entity_extracted_webhook_payload_spec.rb +84 -0
  381. data/spec/models/entity_extracted_webhook_spec.rb +52 -0
  382. data/spec/models/entity_list_spec.rb +42 -0
  383. data/spec/models/entity_spec.rb +72 -0
  384. data/spec/models/error_message_spec.rb +36 -0
  385. data/spec/models/folder_data_spec.rb +42 -0
  386. data/spec/models/freshdesk_credentials_spec.rb +42 -0
  387. data/spec/models/freshdesk_data_spec.rb +42 -0
  388. data/spec/models/gmail_data_spec.rb +36 -0
  389. data/spec/models/google_folder_data_spec.rb +48 -0
  390. data/spec/models/http_validation_error_spec.rb +36 -0
  391. data/spec/models/hubspot_data_spec.rb +72 -0
  392. data/spec/models/instruction_spec.rb +94 -0
  393. data/spec/models/intercom_credentials_spec.rb +48 -0
  394. data/spec/models/intercom_data_spec.rb +66 -0
  395. data/spec/models/link_spec.rb +42 -0
  396. data/spec/models/list_connector_source_type_info_spec.rb +36 -0
  397. data/spec/models/media_mode_param_spec.rb +56 -0
  398. data/spec/models/media_type_spec.rb +21 -0
  399. data/spec/models/metadata_value1_spec.rb +32 -0
  400. data/spec/models/metadata_value_spec.rb +21 -0
  401. data/spec/models/mode1_spec.rb +21 -0
  402. data/spec/models/mode2_one_of_spec.rb +56 -0
  403. data/spec/models/mode2_spec.rb +32 -0
  404. data/spec/models/mode_spec.rb +21 -0
  405. data/spec/models/o_auth_credentials_spec.rb +64 -0
  406. data/spec/models/o_auth_refresh_token_credentials_spec.rb +36 -0
  407. data/spec/models/o_auth_url_create_spec.rb +88 -0
  408. data/spec/models/o_auth_url_response_spec.rb +36 -0
  409. data/spec/models/onedrive_data_spec.rb +48 -0
  410. data/spec/models/pagination_spec.rb +42 -0
  411. data/spec/models/partition_detail_spec.rb +60 -0
  412. data/spec/models/partition_limit_exceeded_webhook_payload_spec.rb +46 -0
  413. data/spec/models/partition_limit_exceeded_webhook_spec.rb +52 -0
  414. data/spec/models/partition_limit_params_spec.rb +102 -0
  415. data/spec/models/partition_limit_reset_webhook_payload_spec.rb +36 -0
  416. data/spec/models/partition_limit_reset_webhook_spec.rb +52 -0
  417. data/spec/models/partition_limits_spec.rb +102 -0
  418. data/spec/models/partition_list_spec.rb +42 -0
  419. data/spec/models/partition_spec.rb +54 -0
  420. data/spec/models/partition_stats_spec.rb +108 -0
  421. data/spec/models/partition_strategy_spec.rb +21 -0
  422. data/spec/models/patch_document_metadata_params_spec.rb +42 -0
  423. data/spec/models/payload_spec.rb +44 -0
  424. data/spec/models/public_backblaze_connection_spec.rb +52 -0
  425. data/spec/models/public_create_connection_spec.rb +66 -0
  426. data/spec/models/public_freshdesk_connection_spec.rb +58 -0
  427. data/spec/models/public_gcs_connection_spec.rb +52 -0
  428. data/spec/models/public_intercom_connection_spec.rb +52 -0
  429. data/spec/models/public_s3_compatible_connection_spec.rb +52 -0
  430. data/spec/models/public_zendesk_connection_spec.rb +52 -0
  431. data/spec/models/response_ok_spec.rb +36 -0
  432. data/spec/models/response_patchdocumentmetadata_spec.rb +21 -0
  433. data/spec/models/retrieval_spec.rb +36 -0
  434. data/spec/models/retrieve_params_spec.rb +72 -0
  435. data/spec/models/s3_compatible_credentials_spec.rb +54 -0
  436. data/spec/models/scored_chunk_spec.rb +84 -0
  437. data/spec/models/set_connection_enabled_payload_spec.rb +46 -0
  438. data/spec/models/sharepoint_data_spec.rb +42 -0
  439. data/spec/models/sharepoint_file_data_spec.rb +52 -0
  440. data/spec/models/sharepoint_site_data_spec.rb +42 -0
  441. data/spec/models/slack_data_spec.rb +42 -0
  442. data/spec/models/source_spec.rb +21 -0
  443. data/spec/models/status_spec.rb +21 -0
  444. data/spec/models/update_document_from_url_params_spec.rb +42 -0
  445. data/spec/models/update_document_raw_params_spec.rb +36 -0
  446. data/spec/models/update_instruction_params_spec.rb +36 -0
  447. data/spec/models/validation_error_loc_inner_spec.rb +21 -0
  448. data/spec/models/validation_error_spec.rb +48 -0
  449. data/spec/models/video_modality_data_spec.rb +46 -0
  450. data/spec/models/word_timestamp_spec.rb +54 -0
  451. data/spec/models/zendesk_credentials_spec.rb +48 -0
  452. data/spec/models/zendesk_data_spec.rb +36 -0
  453. data/spec/spec_helper.rb +111 -0
  454. metadata +680 -0
@@ -0,0 +1,777 @@
1
+ =begin
2
+ #Ragie API
3
+
4
+ #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
5
+
6
+ The version of the OpenAPI document: 1.0.0
7
+
8
+ Generated by: https://openapi-generator.tech
9
+ Generator version: 7.14.0
10
+
11
+ =end
12
+
13
+ require 'cgi'
14
+
15
+ module RagieRubySdk
16
+ class ConnectionsApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+ # Create Connection
23
+ # Create a connection. This is only for non-oauth connections such as S3 compatible connections, Freshdesk, and Zendesk.
24
+ # @param public_create_connection [PublicCreateConnection]
25
+ # @param [Hash] opts the optional parameters
26
+ # @return [Connection]
27
+ def create_connection(public_create_connection, opts = {})
28
+ data, _status_code, _headers = create_connection_with_http_info(public_create_connection, opts)
29
+ data
30
+ end
31
+
32
+ # Create Connection
33
+ # Create a connection. This is only for non-oauth connections such as S3 compatible connections, Freshdesk, and Zendesk.
34
+ # @param public_create_connection [PublicCreateConnection]
35
+ # @param [Hash] opts the optional parameters
36
+ # @return [Array<(Connection, Integer, Hash)>] Connection data, response status code and response headers
37
+ def create_connection_with_http_info(public_create_connection, opts = {})
38
+ if @api_client.config.debugging
39
+ @api_client.config.logger.debug 'Calling API: ConnectionsApi.create_connection ...'
40
+ end
41
+ # verify the required parameter 'public_create_connection' is set
42
+ if @api_client.config.client_side_validation && public_create_connection.nil?
43
+ fail ArgumentError, "Missing the required parameter 'public_create_connection' when calling ConnectionsApi.create_connection"
44
+ end
45
+ # resource path
46
+ local_var_path = '/connection'
47
+
48
+ # query parameters
49
+ query_params = opts[:query_params] || {}
50
+
51
+ # header parameters
52
+ header_params = opts[:header_params] || {}
53
+ # HTTP header 'Accept' (if needed)
54
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
55
+ # HTTP header 'Content-Type'
56
+ content_type = @api_client.select_header_content_type(['application/json'])
57
+ if !content_type.nil?
58
+ header_params['Content-Type'] = content_type
59
+ end
60
+
61
+ # form parameters
62
+ form_params = opts[:form_params] || {}
63
+
64
+ # http body (model)
65
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(public_create_connection)
66
+
67
+ # return_type
68
+ return_type = opts[:debug_return_type] || 'Connection'
69
+
70
+ # auth_names
71
+ auth_names = opts[:debug_auth_names] || ['auth']
72
+
73
+ new_options = opts.merge(
74
+ :operation => :"ConnectionsApi.create_connection",
75
+ :header_params => header_params,
76
+ :query_params => query_params,
77
+ :form_params => form_params,
78
+ :body => post_body,
79
+ :auth_names => auth_names,
80
+ :return_type => return_type
81
+ )
82
+
83
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
84
+ if @api_client.config.debugging
85
+ @api_client.config.logger.debug "API called: ConnectionsApi#create_connection\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
86
+ end
87
+ return data, status_code, headers
88
+ end
89
+
90
+ # Create Oauth Redirect Url
91
+ # Creates a redirect url to redirect the user to when initializing an embedded connector.
92
+ # @param o_auth_url_create [OAuthUrlCreate]
93
+ # @param [Hash] opts the optional parameters
94
+ # @return [OAuthUrlResponse]
95
+ def create_oauth_redirect_url_connections_oauth_post(o_auth_url_create, opts = {})
96
+ data, _status_code, _headers = create_oauth_redirect_url_connections_oauth_post_with_http_info(o_auth_url_create, opts)
97
+ data
98
+ end
99
+
100
+ # Create Oauth Redirect Url
101
+ # Creates a redirect url to redirect the user to when initializing an embedded connector.
102
+ # @param o_auth_url_create [OAuthUrlCreate]
103
+ # @param [Hash] opts the optional parameters
104
+ # @return [Array<(OAuthUrlResponse, Integer, Hash)>] OAuthUrlResponse data, response status code and response headers
105
+ def create_oauth_redirect_url_connections_oauth_post_with_http_info(o_auth_url_create, opts = {})
106
+ if @api_client.config.debugging
107
+ @api_client.config.logger.debug 'Calling API: ConnectionsApi.create_oauth_redirect_url_connections_oauth_post ...'
108
+ end
109
+ # verify the required parameter 'o_auth_url_create' is set
110
+ if @api_client.config.client_side_validation && o_auth_url_create.nil?
111
+ fail ArgumentError, "Missing the required parameter 'o_auth_url_create' when calling ConnectionsApi.create_oauth_redirect_url_connections_oauth_post"
112
+ end
113
+ # resource path
114
+ local_var_path = '/connections/oauth'
115
+
116
+ # query parameters
117
+ query_params = opts[:query_params] || {}
118
+
119
+ # header parameters
120
+ header_params = opts[:header_params] || {}
121
+ # HTTP header 'Accept' (if needed)
122
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
123
+ # HTTP header 'Content-Type'
124
+ content_type = @api_client.select_header_content_type(['application/json'])
125
+ if !content_type.nil?
126
+ header_params['Content-Type'] = content_type
127
+ end
128
+
129
+ # form parameters
130
+ form_params = opts[:form_params] || {}
131
+
132
+ # http body (model)
133
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(o_auth_url_create)
134
+
135
+ # return_type
136
+ return_type = opts[:debug_return_type] || 'OAuthUrlResponse'
137
+
138
+ # auth_names
139
+ auth_names = opts[:debug_auth_names] || ['auth']
140
+
141
+ new_options = opts.merge(
142
+ :operation => :"ConnectionsApi.create_oauth_redirect_url_connections_oauth_post",
143
+ :header_params => header_params,
144
+ :query_params => query_params,
145
+ :form_params => form_params,
146
+ :body => post_body,
147
+ :auth_names => auth_names,
148
+ :return_type => return_type
149
+ )
150
+
151
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
152
+ if @api_client.config.debugging
153
+ @api_client.config.logger.debug "API called: ConnectionsApi#create_oauth_redirect_url_connections_oauth_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
154
+ end
155
+ return data, status_code, headers
156
+ end
157
+
158
+ # Delete Connection
159
+ # Schedules a connection to be deleted. You can choose to keep the files from the connection or delete them all. If you keep the files, they will no longer be associated to the connection. Deleting can take some time, so you will still see files for a bit after this is called.
160
+ # @param connection_id [String]
161
+ # @param delete_connection_payload [DeleteConnectionPayload]
162
+ # @param [Hash] opts the optional parameters
163
+ # @return [Hash<String, String>]
164
+ def delete_connection_connections_connection_id_delete_post(connection_id, delete_connection_payload, opts = {})
165
+ data, _status_code, _headers = delete_connection_connections_connection_id_delete_post_with_http_info(connection_id, delete_connection_payload, opts)
166
+ data
167
+ end
168
+
169
+ # Delete Connection
170
+ # Schedules a connection to be deleted. You can choose to keep the files from the connection or delete them all. If you keep the files, they will no longer be associated to the connection. Deleting can take some time, so you will still see files for a bit after this is called.
171
+ # @param connection_id [String]
172
+ # @param delete_connection_payload [DeleteConnectionPayload]
173
+ # @param [Hash] opts the optional parameters
174
+ # @return [Array<(Hash<String, String>, Integer, Hash)>] Hash<String, String> data, response status code and response headers
175
+ def delete_connection_connections_connection_id_delete_post_with_http_info(connection_id, delete_connection_payload, opts = {})
176
+ if @api_client.config.debugging
177
+ @api_client.config.logger.debug 'Calling API: ConnectionsApi.delete_connection_connections_connection_id_delete_post ...'
178
+ end
179
+ # verify the required parameter 'connection_id' is set
180
+ if @api_client.config.client_side_validation && connection_id.nil?
181
+ fail ArgumentError, "Missing the required parameter 'connection_id' when calling ConnectionsApi.delete_connection_connections_connection_id_delete_post"
182
+ end
183
+ # verify the required parameter 'delete_connection_payload' is set
184
+ if @api_client.config.client_side_validation && delete_connection_payload.nil?
185
+ fail ArgumentError, "Missing the required parameter 'delete_connection_payload' when calling ConnectionsApi.delete_connection_connections_connection_id_delete_post"
186
+ end
187
+ # resource path
188
+ local_var_path = '/connections/{connection_id}/delete'.sub('{' + 'connection_id' + '}', CGI.escape(connection_id.to_s))
189
+
190
+ # query parameters
191
+ query_params = opts[:query_params] || {}
192
+
193
+ # header parameters
194
+ header_params = opts[:header_params] || {}
195
+ # HTTP header 'Accept' (if needed)
196
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
197
+ # HTTP header 'Content-Type'
198
+ content_type = @api_client.select_header_content_type(['application/json'])
199
+ if !content_type.nil?
200
+ header_params['Content-Type'] = content_type
201
+ end
202
+
203
+ # form parameters
204
+ form_params = opts[:form_params] || {}
205
+
206
+ # http body (model)
207
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(delete_connection_payload)
208
+
209
+ # return_type
210
+ return_type = opts[:debug_return_type] || 'Hash<String, String>'
211
+
212
+ # auth_names
213
+ auth_names = opts[:debug_auth_names] || ['auth']
214
+
215
+ new_options = opts.merge(
216
+ :operation => :"ConnectionsApi.delete_connection_connections_connection_id_delete_post",
217
+ :header_params => header_params,
218
+ :query_params => query_params,
219
+ :form_params => form_params,
220
+ :body => post_body,
221
+ :auth_names => auth_names,
222
+ :return_type => return_type
223
+ )
224
+
225
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
226
+ if @api_client.config.debugging
227
+ @api_client.config.logger.debug "API called: ConnectionsApi#delete_connection_connections_connection_id_delete_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
228
+ end
229
+ return data, status_code, headers
230
+ end
231
+
232
+ # Get Connection
233
+ # Get a connection.
234
+ # @param connection_id [String]
235
+ # @param [Hash] opts the optional parameters
236
+ # @return [Connection]
237
+ def get_connection_connections_connection_id_get(connection_id, opts = {})
238
+ data, _status_code, _headers = get_connection_connections_connection_id_get_with_http_info(connection_id, opts)
239
+ data
240
+ end
241
+
242
+ # Get Connection
243
+ # Get a connection.
244
+ # @param connection_id [String]
245
+ # @param [Hash] opts the optional parameters
246
+ # @return [Array<(Connection, Integer, Hash)>] Connection data, response status code and response headers
247
+ def get_connection_connections_connection_id_get_with_http_info(connection_id, opts = {})
248
+ if @api_client.config.debugging
249
+ @api_client.config.logger.debug 'Calling API: ConnectionsApi.get_connection_connections_connection_id_get ...'
250
+ end
251
+ # verify the required parameter 'connection_id' is set
252
+ if @api_client.config.client_side_validation && connection_id.nil?
253
+ fail ArgumentError, "Missing the required parameter 'connection_id' when calling ConnectionsApi.get_connection_connections_connection_id_get"
254
+ end
255
+ # resource path
256
+ local_var_path = '/connections/{connection_id}'.sub('{' + 'connection_id' + '}', CGI.escape(connection_id.to_s))
257
+
258
+ # query parameters
259
+ query_params = opts[:query_params] || {}
260
+
261
+ # header parameters
262
+ header_params = opts[:header_params] || {}
263
+ # HTTP header 'Accept' (if needed)
264
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
265
+
266
+ # form parameters
267
+ form_params = opts[:form_params] || {}
268
+
269
+ # http body (model)
270
+ post_body = opts[:debug_body]
271
+
272
+ # return_type
273
+ return_type = opts[:debug_return_type] || 'Connection'
274
+
275
+ # auth_names
276
+ auth_names = opts[:debug_auth_names] || ['auth']
277
+
278
+ new_options = opts.merge(
279
+ :operation => :"ConnectionsApi.get_connection_connections_connection_id_get",
280
+ :header_params => header_params,
281
+ :query_params => query_params,
282
+ :form_params => form_params,
283
+ :body => post_body,
284
+ :auth_names => auth_names,
285
+ :return_type => return_type
286
+ )
287
+
288
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
289
+ if @api_client.config.debugging
290
+ @api_client.config.logger.debug "API called: ConnectionsApi#get_connection_connections_connection_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
291
+ end
292
+ return data, status_code, headers
293
+ end
294
+
295
+ # Get Connection Stats
296
+ # Lists connection stats: total documents active documents, total active pages.
297
+ # @param connection_id [String]
298
+ # @param [Hash] opts the optional parameters
299
+ # @return [ConnectionStats]
300
+ def get_connection_stats_connections_connection_id_stats_get(connection_id, opts = {})
301
+ data, _status_code, _headers = get_connection_stats_connections_connection_id_stats_get_with_http_info(connection_id, opts)
302
+ data
303
+ end
304
+
305
+ # Get Connection Stats
306
+ # Lists connection stats: total documents active documents, total active pages.
307
+ # @param connection_id [String]
308
+ # @param [Hash] opts the optional parameters
309
+ # @return [Array<(ConnectionStats, Integer, Hash)>] ConnectionStats data, response status code and response headers
310
+ def get_connection_stats_connections_connection_id_stats_get_with_http_info(connection_id, opts = {})
311
+ if @api_client.config.debugging
312
+ @api_client.config.logger.debug 'Calling API: ConnectionsApi.get_connection_stats_connections_connection_id_stats_get ...'
313
+ end
314
+ # verify the required parameter 'connection_id' is set
315
+ if @api_client.config.client_side_validation && connection_id.nil?
316
+ fail ArgumentError, "Missing the required parameter 'connection_id' when calling ConnectionsApi.get_connection_stats_connections_connection_id_stats_get"
317
+ end
318
+ # resource path
319
+ local_var_path = '/connections/{connection_id}/stats'.sub('{' + 'connection_id' + '}', CGI.escape(connection_id.to_s))
320
+
321
+ # query parameters
322
+ query_params = opts[:query_params] || {}
323
+
324
+ # header parameters
325
+ header_params = opts[:header_params] || {}
326
+ # HTTP header 'Accept' (if needed)
327
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
328
+
329
+ # form parameters
330
+ form_params = opts[:form_params] || {}
331
+
332
+ # http body (model)
333
+ post_body = opts[:debug_body]
334
+
335
+ # return_type
336
+ return_type = opts[:debug_return_type] || 'ConnectionStats'
337
+
338
+ # auth_names
339
+ auth_names = opts[:debug_auth_names] || ['auth']
340
+
341
+ new_options = opts.merge(
342
+ :operation => :"ConnectionsApi.get_connection_stats_connections_connection_id_stats_get",
343
+ :header_params => header_params,
344
+ :query_params => query_params,
345
+ :form_params => form_params,
346
+ :body => post_body,
347
+ :auth_names => auth_names,
348
+ :return_type => return_type
349
+ )
350
+
351
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
352
+ if @api_client.config.debugging
353
+ @api_client.config.logger.debug "API called: ConnectionsApi#get_connection_stats_connections_connection_id_stats_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
354
+ end
355
+ return data, status_code, headers
356
+ end
357
+
358
+ # List Connection Source Types
359
+ # List available connection source types like 'google_drive' and 'notion' along with their metadata
360
+ # @param [Hash] opts the optional parameters
361
+ # @return [ListConnectorSourceTypeInfo]
362
+ def list_connection_source_types_connections_source_type_get(opts = {})
363
+ data, _status_code, _headers = list_connection_source_types_connections_source_type_get_with_http_info(opts)
364
+ data
365
+ end
366
+
367
+ # List Connection Source Types
368
+ # List available connection source types like &#39;google_drive&#39; and &#39;notion&#39; along with their metadata
369
+ # @param [Hash] opts the optional parameters
370
+ # @return [Array<(ListConnectorSourceTypeInfo, Integer, Hash)>] ListConnectorSourceTypeInfo data, response status code and response headers
371
+ def list_connection_source_types_connections_source_type_get_with_http_info(opts = {})
372
+ if @api_client.config.debugging
373
+ @api_client.config.logger.debug 'Calling API: ConnectionsApi.list_connection_source_types_connections_source_type_get ...'
374
+ end
375
+ # resource path
376
+ local_var_path = '/connections/source-type'
377
+
378
+ # query parameters
379
+ query_params = opts[:query_params] || {}
380
+
381
+ # header parameters
382
+ header_params = opts[:header_params] || {}
383
+ # HTTP header 'Accept' (if needed)
384
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
385
+
386
+ # form parameters
387
+ form_params = opts[:form_params] || {}
388
+
389
+ # http body (model)
390
+ post_body = opts[:debug_body]
391
+
392
+ # return_type
393
+ return_type = opts[:debug_return_type] || 'ListConnectorSourceTypeInfo'
394
+
395
+ # auth_names
396
+ auth_names = opts[:debug_auth_names] || ['auth']
397
+
398
+ new_options = opts.merge(
399
+ :operation => :"ConnectionsApi.list_connection_source_types_connections_source_type_get",
400
+ :header_params => header_params,
401
+ :query_params => query_params,
402
+ :form_params => form_params,
403
+ :body => post_body,
404
+ :auth_names => auth_names,
405
+ :return_type => return_type
406
+ )
407
+
408
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
409
+ if @api_client.config.debugging
410
+ @api_client.config.logger.debug "API called: ConnectionsApi#list_connection_source_types_connections_source_type_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
411
+ end
412
+ return data, status_code, headers
413
+ end
414
+
415
+ # List Connections
416
+ # List all connections sorted by created_at in descending order. Results are paginated with a max limit of 100. When more documents are available, a `cursor` will be provided. Use the `cursor` parameter to retrieve the subsequent page.
417
+ # @param [Hash] opts the optional parameters
418
+ # @option opts [String] :cursor An opaque cursor for pagination
419
+ # @option opts [Integer] :page_size The number of items per page (must be greater than 0 and less than or equal to 100) (default to 10)
420
+ # @option opts [String] :filter The metadata search filter. Returns only items which match the filter. The following filter operators are supported: $eq - Equal to (number, string, boolean), $ne - Not equal to (number, string, boolean), $gt - Greater than (number), $gte - Greater than or equal to (number), $lt - Less than (number), $lte - Less than or equal to (number), $in - In array (string or number), $nin - Not in array (string or number). The operators can be combined with AND and OR. Read [Metadata &amp; Filters guide](https://docs.ragie.ai/docs/metadata-filters) for more details and examples.
421
+ # @option opts [String] :partition An optional partition to scope the request to. If omitted, the request will be scoped to the default partition.
422
+ # @return [ConnectionList]
423
+ def list_connections_connections_get(opts = {})
424
+ data, _status_code, _headers = list_connections_connections_get_with_http_info(opts)
425
+ data
426
+ end
427
+
428
+ # List Connections
429
+ # List all connections sorted by created_at in descending order. Results are paginated with a max limit of 100. When more documents are available, a &#x60;cursor&#x60; will be provided. Use the &#x60;cursor&#x60; parameter to retrieve the subsequent page.
430
+ # @param [Hash] opts the optional parameters
431
+ # @option opts [String] :cursor An opaque cursor for pagination
432
+ # @option opts [Integer] :page_size The number of items per page (must be greater than 0 and less than or equal to 100) (default to 10)
433
+ # @option opts [String] :filter The metadata search filter. Returns only items which match the filter. The following filter operators are supported: $eq - Equal to (number, string, boolean), $ne - Not equal to (number, string, boolean), $gt - Greater than (number), $gte - Greater than or equal to (number), $lt - Less than (number), $lte - Less than or equal to (number), $in - In array (string or number), $nin - Not in array (string or number). The operators can be combined with AND and OR. Read [Metadata &amp; Filters guide](https://docs.ragie.ai/docs/metadata-filters) for more details and examples.
434
+ # @option opts [String] :partition An optional partition to scope the request to. If omitted, the request will be scoped to the default partition.
435
+ # @return [Array<(ConnectionList, Integer, Hash)>] ConnectionList data, response status code and response headers
436
+ def list_connections_connections_get_with_http_info(opts = {})
437
+ if @api_client.config.debugging
438
+ @api_client.config.logger.debug 'Calling API: ConnectionsApi.list_connections_connections_get ...'
439
+ end
440
+ if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
441
+ fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ConnectionsApi.list_connections_connections_get, must be smaller than or equal to 100.'
442
+ end
443
+
444
+ if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
445
+ fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ConnectionsApi.list_connections_connections_get, must be greater than or equal to 1.'
446
+ end
447
+
448
+ # resource path
449
+ local_var_path = '/connections'
450
+
451
+ # query parameters
452
+ query_params = opts[:query_params] || {}
453
+ query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
454
+ query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
455
+ query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
456
+
457
+ # header parameters
458
+ header_params = opts[:header_params] || {}
459
+ # HTTP header 'Accept' (if needed)
460
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
461
+ header_params[:'partition'] = opts[:'partition'] if !opts[:'partition'].nil?
462
+
463
+ # form parameters
464
+ form_params = opts[:form_params] || {}
465
+
466
+ # http body (model)
467
+ post_body = opts[:debug_body]
468
+
469
+ # return_type
470
+ return_type = opts[:debug_return_type] || 'ConnectionList'
471
+
472
+ # auth_names
473
+ auth_names = opts[:debug_auth_names] || ['auth']
474
+
475
+ new_options = opts.merge(
476
+ :operation => :"ConnectionsApi.list_connections_connections_get",
477
+ :header_params => header_params,
478
+ :query_params => query_params,
479
+ :form_params => form_params,
480
+ :body => post_body,
481
+ :auth_names => auth_names,
482
+ :return_type => return_type
483
+ )
484
+
485
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
486
+ if @api_client.config.debugging
487
+ @api_client.config.logger.debug "API called: ConnectionsApi#list_connections_connections_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
488
+ end
489
+ return data, status_code, headers
490
+ end
491
+
492
+ # Set Connection Enabled
493
+ # Enable or disable the connection. A disabled connection won't sync.
494
+ # @param connection_id [String]
495
+ # @param set_connection_enabled_payload [SetConnectionEnabledPayload]
496
+ # @param [Hash] opts the optional parameters
497
+ # @return [Connection]
498
+ def set_connection_enabled_connections_connection_id_enabled_put(connection_id, set_connection_enabled_payload, opts = {})
499
+ data, _status_code, _headers = set_connection_enabled_connections_connection_id_enabled_put_with_http_info(connection_id, set_connection_enabled_payload, opts)
500
+ data
501
+ end
502
+
503
+ # Set Connection Enabled
504
+ # Enable or disable the connection. A disabled connection won&#39;t sync.
505
+ # @param connection_id [String]
506
+ # @param set_connection_enabled_payload [SetConnectionEnabledPayload]
507
+ # @param [Hash] opts the optional parameters
508
+ # @return [Array<(Connection, Integer, Hash)>] Connection data, response status code and response headers
509
+ def set_connection_enabled_connections_connection_id_enabled_put_with_http_info(connection_id, set_connection_enabled_payload, opts = {})
510
+ if @api_client.config.debugging
511
+ @api_client.config.logger.debug 'Calling API: ConnectionsApi.set_connection_enabled_connections_connection_id_enabled_put ...'
512
+ end
513
+ # verify the required parameter 'connection_id' is set
514
+ if @api_client.config.client_side_validation && connection_id.nil?
515
+ fail ArgumentError, "Missing the required parameter 'connection_id' when calling ConnectionsApi.set_connection_enabled_connections_connection_id_enabled_put"
516
+ end
517
+ # verify the required parameter 'set_connection_enabled_payload' is set
518
+ if @api_client.config.client_side_validation && set_connection_enabled_payload.nil?
519
+ fail ArgumentError, "Missing the required parameter 'set_connection_enabled_payload' when calling ConnectionsApi.set_connection_enabled_connections_connection_id_enabled_put"
520
+ end
521
+ # resource path
522
+ local_var_path = '/connections/{connection_id}/enabled'.sub('{' + 'connection_id' + '}', CGI.escape(connection_id.to_s))
523
+
524
+ # query parameters
525
+ query_params = opts[:query_params] || {}
526
+
527
+ # header parameters
528
+ header_params = opts[:header_params] || {}
529
+ # HTTP header 'Accept' (if needed)
530
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
531
+ # HTTP header 'Content-Type'
532
+ content_type = @api_client.select_header_content_type(['application/json'])
533
+ if !content_type.nil?
534
+ header_params['Content-Type'] = content_type
535
+ end
536
+
537
+ # form parameters
538
+ form_params = opts[:form_params] || {}
539
+
540
+ # http body (model)
541
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(set_connection_enabled_payload)
542
+
543
+ # return_type
544
+ return_type = opts[:debug_return_type] || 'Connection'
545
+
546
+ # auth_names
547
+ auth_names = opts[:debug_auth_names] || ['auth']
548
+
549
+ new_options = opts.merge(
550
+ :operation => :"ConnectionsApi.set_connection_enabled_connections_connection_id_enabled_put",
551
+ :header_params => header_params,
552
+ :query_params => query_params,
553
+ :form_params => form_params,
554
+ :body => post_body,
555
+ :auth_names => auth_names,
556
+ :return_type => return_type
557
+ )
558
+
559
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
560
+ if @api_client.config.debugging
561
+ @api_client.config.logger.debug "API called: ConnectionsApi#set_connection_enabled_connections_connection_id_enabled_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
562
+ end
563
+ return data, status_code, headers
564
+ end
565
+
566
+ # Set Connection Limits
567
+ # Sets limits on a connection. Limits can be set on the total number of pages a connection can sync. When the limit is reached, the connection will be disabled. Limit may be removed by setting it to `null`.
568
+ # @param connection_id [String]
569
+ # @param connection_limit_params [ConnectionLimitParams]
570
+ # @param [Hash] opts the optional parameters
571
+ # @return [Connection]
572
+ def set_connection_limits_connections_connection_id_limit_put(connection_id, connection_limit_params, opts = {})
573
+ data, _status_code, _headers = set_connection_limits_connections_connection_id_limit_put_with_http_info(connection_id, connection_limit_params, opts)
574
+ data
575
+ end
576
+
577
+ # Set Connection Limits
578
+ # Sets limits on a connection. Limits can be set on the total number of pages a connection can sync. When the limit is reached, the connection will be disabled. Limit may be removed by setting it to &#x60;null&#x60;.
579
+ # @param connection_id [String]
580
+ # @param connection_limit_params [ConnectionLimitParams]
581
+ # @param [Hash] opts the optional parameters
582
+ # @return [Array<(Connection, Integer, Hash)>] Connection data, response status code and response headers
583
+ def set_connection_limits_connections_connection_id_limit_put_with_http_info(connection_id, connection_limit_params, opts = {})
584
+ if @api_client.config.debugging
585
+ @api_client.config.logger.debug 'Calling API: ConnectionsApi.set_connection_limits_connections_connection_id_limit_put ...'
586
+ end
587
+ # verify the required parameter 'connection_id' is set
588
+ if @api_client.config.client_side_validation && connection_id.nil?
589
+ fail ArgumentError, "Missing the required parameter 'connection_id' when calling ConnectionsApi.set_connection_limits_connections_connection_id_limit_put"
590
+ end
591
+ # verify the required parameter 'connection_limit_params' is set
592
+ if @api_client.config.client_side_validation && connection_limit_params.nil?
593
+ fail ArgumentError, "Missing the required parameter 'connection_limit_params' when calling ConnectionsApi.set_connection_limits_connections_connection_id_limit_put"
594
+ end
595
+ # resource path
596
+ local_var_path = '/connections/{connection_id}/limit'.sub('{' + 'connection_id' + '}', CGI.escape(connection_id.to_s))
597
+
598
+ # query parameters
599
+ query_params = opts[:query_params] || {}
600
+
601
+ # header parameters
602
+ header_params = opts[:header_params] || {}
603
+ # HTTP header 'Accept' (if needed)
604
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
605
+ # HTTP header 'Content-Type'
606
+ content_type = @api_client.select_header_content_type(['application/json'])
607
+ if !content_type.nil?
608
+ header_params['Content-Type'] = content_type
609
+ end
610
+
611
+ # form parameters
612
+ form_params = opts[:form_params] || {}
613
+
614
+ # http body (model)
615
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(connection_limit_params)
616
+
617
+ # return_type
618
+ return_type = opts[:debug_return_type] || 'Connection'
619
+
620
+ # auth_names
621
+ auth_names = opts[:debug_auth_names] || ['auth']
622
+
623
+ new_options = opts.merge(
624
+ :operation => :"ConnectionsApi.set_connection_limits_connections_connection_id_limit_put",
625
+ :header_params => header_params,
626
+ :query_params => query_params,
627
+ :form_params => form_params,
628
+ :body => post_body,
629
+ :auth_names => auth_names,
630
+ :return_type => return_type
631
+ )
632
+
633
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
634
+ if @api_client.config.debugging
635
+ @api_client.config.logger.debug "API called: ConnectionsApi#set_connection_limits_connections_connection_id_limit_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
636
+ end
637
+ return data, status_code, headers
638
+ end
639
+
640
+ # Sync Connection
641
+ # Schedules a connector to sync as soon as possible.
642
+ # @param connection_id [String]
643
+ # @param [Hash] opts the optional parameters
644
+ # @return [ResponseOK]
645
+ def sync_connection(connection_id, opts = {})
646
+ data, _status_code, _headers = sync_connection_with_http_info(connection_id, opts)
647
+ data
648
+ end
649
+
650
+ # Sync Connection
651
+ # Schedules a connector to sync as soon as possible.
652
+ # @param connection_id [String]
653
+ # @param [Hash] opts the optional parameters
654
+ # @return [Array<(ResponseOK, Integer, Hash)>] ResponseOK data, response status code and response headers
655
+ def sync_connection_with_http_info(connection_id, opts = {})
656
+ if @api_client.config.debugging
657
+ @api_client.config.logger.debug 'Calling API: ConnectionsApi.sync_connection ...'
658
+ end
659
+ # verify the required parameter 'connection_id' is set
660
+ if @api_client.config.client_side_validation && connection_id.nil?
661
+ fail ArgumentError, "Missing the required parameter 'connection_id' when calling ConnectionsApi.sync_connection"
662
+ end
663
+ # resource path
664
+ local_var_path = '/connections/{connection_id}/sync'.sub('{' + 'connection_id' + '}', CGI.escape(connection_id.to_s))
665
+
666
+ # query parameters
667
+ query_params = opts[:query_params] || {}
668
+
669
+ # header parameters
670
+ header_params = opts[:header_params] || {}
671
+ # HTTP header 'Accept' (if needed)
672
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
673
+
674
+ # form parameters
675
+ form_params = opts[:form_params] || {}
676
+
677
+ # http body (model)
678
+ post_body = opts[:debug_body]
679
+
680
+ # return_type
681
+ return_type = opts[:debug_return_type] || 'ResponseOK'
682
+
683
+ # auth_names
684
+ auth_names = opts[:debug_auth_names] || ['auth']
685
+
686
+ new_options = opts.merge(
687
+ :operation => :"ConnectionsApi.sync_connection",
688
+ :header_params => header_params,
689
+ :query_params => query_params,
690
+ :form_params => form_params,
691
+ :body => post_body,
692
+ :auth_names => auth_names,
693
+ :return_type => return_type
694
+ )
695
+
696
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
697
+ if @api_client.config.debugging
698
+ @api_client.config.logger.debug "API called: ConnectionsApi#sync_connection\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
699
+ end
700
+ return data, status_code, headers
701
+ end
702
+
703
+ # Update Connection
704
+ # Updates a connections metadata or mode. These changes will be seen after the next sync.
705
+ # @param connection_id [String]
706
+ # @param connection_base [ConnectionBase]
707
+ # @param [Hash] opts the optional parameters
708
+ # @return [Connection]
709
+ def update_connection_connections_connection_id_put(connection_id, connection_base, opts = {})
710
+ data, _status_code, _headers = update_connection_connections_connection_id_put_with_http_info(connection_id, connection_base, opts)
711
+ data
712
+ end
713
+
714
+ # Update Connection
715
+ # Updates a connections metadata or mode. These changes will be seen after the next sync.
716
+ # @param connection_id [String]
717
+ # @param connection_base [ConnectionBase]
718
+ # @param [Hash] opts the optional parameters
719
+ # @return [Array<(Connection, Integer, Hash)>] Connection data, response status code and response headers
720
+ def update_connection_connections_connection_id_put_with_http_info(connection_id, connection_base, opts = {})
721
+ if @api_client.config.debugging
722
+ @api_client.config.logger.debug 'Calling API: ConnectionsApi.update_connection_connections_connection_id_put ...'
723
+ end
724
+ # verify the required parameter 'connection_id' is set
725
+ if @api_client.config.client_side_validation && connection_id.nil?
726
+ fail ArgumentError, "Missing the required parameter 'connection_id' when calling ConnectionsApi.update_connection_connections_connection_id_put"
727
+ end
728
+ # verify the required parameter 'connection_base' is set
729
+ if @api_client.config.client_side_validation && connection_base.nil?
730
+ fail ArgumentError, "Missing the required parameter 'connection_base' when calling ConnectionsApi.update_connection_connections_connection_id_put"
731
+ end
732
+ # resource path
733
+ local_var_path = '/connections/{connection_id}'.sub('{' + 'connection_id' + '}', CGI.escape(connection_id.to_s))
734
+
735
+ # query parameters
736
+ query_params = opts[:query_params] || {}
737
+
738
+ # header parameters
739
+ header_params = opts[:header_params] || {}
740
+ # HTTP header 'Accept' (if needed)
741
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
742
+ # HTTP header 'Content-Type'
743
+ content_type = @api_client.select_header_content_type(['application/json'])
744
+ if !content_type.nil?
745
+ header_params['Content-Type'] = content_type
746
+ end
747
+
748
+ # form parameters
749
+ form_params = opts[:form_params] || {}
750
+
751
+ # http body (model)
752
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(connection_base)
753
+
754
+ # return_type
755
+ return_type = opts[:debug_return_type] || 'Connection'
756
+
757
+ # auth_names
758
+ auth_names = opts[:debug_auth_names] || ['auth']
759
+
760
+ new_options = opts.merge(
761
+ :operation => :"ConnectionsApi.update_connection_connections_connection_id_put",
762
+ :header_params => header_params,
763
+ :query_params => query_params,
764
+ :form_params => form_params,
765
+ :body => post_body,
766
+ :auth_names => auth_names,
767
+ :return_type => return_type
768
+ )
769
+
770
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
771
+ if @api_client.config.debugging
772
+ @api_client.config.logger.debug "API called: ConnectionsApi#update_connection_connections_connection_id_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
773
+ end
774
+ return data, status_code, headers
775
+ end
776
+ end
777
+ end