falaai-api 1.21.54 → 1.21.67

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 (108) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +11 -5
  3. data/docs/AnalysisApi.md +4 -0
  4. data/docs/DiagnosticUsage.md +1 -1
  5. data/docs/ResponseExtractConversationsV1WhatsappExtractconversationsPost.md +42 -0
  6. data/docs/RiskAuditAppliedActionV2.md +0 -4
  7. data/docs/RiskAuditAuditDecisionsV2.md +1 -3
  8. data/docs/RiskAuditConversationScoresV2.md +0 -2
  9. data/docs/RiskAuditDetectionItemV2.md +5 -75
  10. data/docs/RiskAuditSummaryV2.md +0 -4
  11. data/docs/RiskAuditUsageV2.md +1 -1
  12. data/docs/RiskAuditVerdictV2.md +1 -7
  13. data/docs/SpeechApi.md +2 -0
  14. data/docs/TranscriptionUsage.md +1 -1
  15. data/docs/WhatsappApi.md +16 -10
  16. data/docs/WhatsappConversation.md +1 -1
  17. data/docs/WhatsappMeta.md +3 -1
  18. data/docs/WhatsappPreviewItem.md +32 -0
  19. data/docs/WhatsappPreviewItemBreakdown.md +26 -0
  20. data/docs/WhatsappPreviewItemCredits.md +20 -0
  21. data/docs/WhatsappPreviewItemMedia.md +30 -0
  22. data/docs/WhatsappPreviewParams.md +32 -0
  23. data/docs/WhatsappPreviewResponse.md +32 -0
  24. data/docs/WhatsappPreviewWindow.md +22 -0
  25. data/docs/WhatsappUsage.md +11 -5
  26. data/docs/index.html +35 -7
  27. data/lib/falaai-api/api/analysis_api.rb +5 -1
  28. data/lib/falaai-api/api/email_alerts_api.rb +1 -1
  29. data/lib/falaai-api/api/health_api.rb +1 -1
  30. data/lib/falaai-api/api/speech_api.rb +3 -1
  31. data/lib/falaai-api/api/usage_api.rb +1 -1
  32. data/lib/falaai-api/api/version_api.rb +1 -1
  33. data/lib/falaai-api/api/webhooks_api.rb +1 -1
  34. data/lib/falaai-api/api/whatsapp_api.rb +21 -21
  35. data/lib/falaai-api/api_client.rb +1 -1
  36. data/lib/falaai-api/api_error.rb +1 -1
  37. data/lib/falaai-api/api_model_base.rb +1 -1
  38. data/lib/falaai-api/configuration.rb +1 -1
  39. data/lib/falaai-api/models/audio_event.rb +1 -1
  40. data/lib/falaai-api/models/audio_input_meta.rb +1 -1
  41. data/lib/falaai-api/models/create_email_alert_request.rb +1 -1
  42. data/lib/falaai-api/models/create_webhook_request.rb +1 -1
  43. data/lib/falaai-api/models/diagnostic_analysis_map.rb +1 -1
  44. data/lib/falaai-api/models/diagnostic_audio_event.rb +1 -1
  45. data/lib/falaai-api/models/diagnostic_categorical_analysis.rb +1 -1
  46. data/lib/falaai-api/models/diagnostic_participant.rb +1 -1
  47. data/lib/falaai-api/models/diagnostic_request.rb +1 -1
  48. data/lib/falaai-api/models/diagnostic_response.rb +1 -1
  49. data/lib/falaai-api/models/diagnostic_text_analysis.rb +1 -1
  50. data/lib/falaai-api/models/diagnostic_usage.rb +3 -3
  51. data/lib/falaai-api/models/email_alert_item.rb +1 -1
  52. data/lib/falaai-api/models/email_alert_list_response.rb +1 -1
  53. data/lib/falaai-api/models/email_alert_message_response.rb +1 -1
  54. data/lib/falaai-api/models/email_event.rb +1 -1
  55. data/lib/falaai-api/models/health_response.rb +1 -1
  56. data/lib/falaai-api/models/http_validation_error.rb +1 -1
  57. data/lib/falaai-api/models/location_inner.rb +1 -1
  58. data/lib/falaai-api/models/message_response.rb +1 -1
  59. data/lib/falaai-api/models/participant.rb +1 -1
  60. data/lib/falaai-api/models/participant_diagnostic.rb +1 -1
  61. data/lib/falaai-api/models/response_extract_conversations_v1_whatsapp_extractconversations_post.rb +103 -0
  62. data/lib/falaai-api/models/risk_audit_analysis_v2.rb +1 -1
  63. data/lib/falaai-api/models/risk_audit_applied_action_v2.rb +2 -26
  64. data/lib/falaai-api/models/risk_audit_audio_event_model_v2.rb +1 -1
  65. data/lib/falaai-api/models/risk_audit_audit_decisions_v2.rb +5 -17
  66. data/lib/falaai-api/models/risk_audit_conversation_scores_v2.rb +2 -12
  67. data/lib/falaai-api/models/risk_audit_detection_item_v2.rb +19 -393
  68. data/lib/falaai-api/models/risk_audit_detections_v2.rb +1 -1
  69. data/lib/falaai-api/models/risk_audit_indexer_v2.rb +1 -1
  70. data/lib/falaai-api/models/risk_audit_meta_v2.rb +1 -1
  71. data/lib/falaai-api/models/risk_audit_participant_v2.rb +1 -1
  72. data/lib/falaai-api/models/risk_audit_participants_v2.rb +1 -1
  73. data/lib/falaai-api/models/risk_audit_request.rb +1 -1
  74. data/lib/falaai-api/models/risk_audit_scores_v2.rb +1 -1
  75. data/lib/falaai-api/models/risk_audit_scoring_explanation_v2.rb +1 -1
  76. data/lib/falaai-api/models/risk_audit_summary_v2.rb +2 -24
  77. data/lib/falaai-api/models/risk_audit_timeline_v2.rb +1 -1
  78. data/lib/falaai-api/models/risk_audit_usage_v2.rb +2 -2
  79. data/lib/falaai-api/models/risk_audit_v2.rb +1 -1
  80. data/lib/falaai-api/models/risk_audit_v2_response.rb +1 -1
  81. data/lib/falaai-api/models/risk_audit_verdict_v2.rb +5 -36
  82. data/lib/falaai-api/models/transcription_response.rb +1 -1
  83. data/lib/falaai-api/models/transcription_usage.rb +2 -2
  84. data/lib/falaai-api/models/update_email_alert_request.rb +1 -1
  85. data/lib/falaai-api/models/update_webhook_request.rb +1 -1
  86. data/lib/falaai-api/models/usage_by_key_item.rb +1 -1
  87. data/lib/falaai-api/models/usage_log_item.rb +1 -1
  88. data/lib/falaai-api/models/usage_log_response.rb +1 -1
  89. data/lib/falaai-api/models/validation_error.rb +1 -1
  90. data/lib/falaai-api/models/version_response.rb +1 -1
  91. data/lib/falaai-api/models/webhook_event.rb +1 -1
  92. data/lib/falaai-api/models/webhook_item.rb +1 -1
  93. data/lib/falaai-api/models/webhook_list_response.rb +1 -1
  94. data/lib/falaai-api/models/whatsapp_conversation.rb +2 -2
  95. data/lib/falaai-api/models/whatsapp_conversations_response.rb +30 -6
  96. data/lib/falaai-api/models/whatsapp_meta.rb +32 -5
  97. data/lib/falaai-api/models/whatsapp_preview_item.rb +354 -0
  98. data/lib/falaai-api/models/whatsapp_preview_item_breakdown.rb +273 -0
  99. data/lib/falaai-api/models/whatsapp_preview_item_credits.rb +192 -0
  100. data/lib/falaai-api/models/whatsapp_preview_item_media.rb +329 -0
  101. data/lib/falaai-api/models/whatsapp_preview_params.rb +354 -0
  102. data/lib/falaai-api/models/whatsapp_preview_response.rb +384 -0
  103. data/lib/falaai-api/models/whatsapp_preview_window.rb +219 -0
  104. data/lib/falaai-api/models/whatsapp_speaker.rb +1 -1
  105. data/lib/falaai-api/models/whatsapp_usage.rb +90 -9
  106. data/lib/falaai-api/version.rb +15 -15
  107. data/lib/falaai-api.rb +9 -1
  108. metadata +18 -2
data/docs/WhatsappPreviewParams.md ADDED
@@ -0,0 +1,32 @@
1
+ # FalaAI::WhatsappPreviewParams
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **start** | **String** | Window start actually used (file period when start/end are omitted in dry_run) | |
8
+ | **_end** | **String** | Window end actually used (file period when start/end are omitted in dry_run) | |
9
+ | **timezone** | **String** | Timezone informed | |
10
+ | **date_format** | **String** | Date order used | |
11
+ | **gap_minutes** | **Float** | Gap used to split conversations | |
12
+ | **min_messages** | **Integer** | Minimum messages per conversation | |
13
+ | **voice_note** | **Boolean** | Voice/video medias would be transcribed (charge flag) | |
14
+ | **expression** | **Boolean** | Visual expressions would be described (charge flag) | |
15
+
16
+ ## Example
17
+
18
+ ```ruby
19
+ require 'falaai-api'
20
+
21
+ instance = FalaAI::WhatsappPreviewParams.new(
22
+ start: null,
23
+ _end: null,
24
+ timezone: null,
25
+ date_format: null,
26
+ gap_minutes: null,
27
+ min_messages: null,
28
+ voice_note: null,
29
+ expression: null
30
+ )
31
+ ```
32
+
data/docs/WhatsappPreviewResponse.md ADDED
@@ -0,0 +1,32 @@
1
+ # FalaAI::WhatsappPreviewResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **object** | **String** | Object type. Always 'whatsapp_preview' | |
8
+ | **dry_run** | **Boolean** | Always true (preview: no AI call, no charge) | |
9
+ | **credits_charged** | **Integer** | Always 0 in preview | |
10
+ | **credits_total** | **Float** | TOTAL credits = exact SUM of the selected conversations (2 decimals, NO rounding up) | |
11
+ | **params** | [**WhatsappPreviewParams**](WhatsappPreviewParams.md) | Filter parameters actually used (reuse them in the extraction) | |
12
+ | **windows** | [**Array<WhatsappPreviewWindow>**](WhatsappPreviewWindow.md) | Explicit windows used (empty when a single start/end range was used) | |
13
+ | **items** | [**Array<WhatsappPreviewItem>**](WhatsappPreviewItem.md) | Per-conversation detail (send back as `windows` to extract only what you want) | |
14
+ | **warnings** | **Array<String>** | Human-readable notices about what would be ignored | |
15
+
16
+ ## Example
17
+
18
+ ```ruby
19
+ require 'falaai-api'
20
+
21
+ instance = FalaAI::WhatsappPreviewResponse.new(
22
+ object: null,
23
+ dry_run: null,
24
+ credits_charged: null,
25
+ credits_total: null,
26
+ params: null,
27
+ windows: null,
28
+ items: null,
29
+ warnings: null
30
+ )
31
+ ```
32
+
data/docs/WhatsappPreviewWindow.md ADDED
@@ -0,0 +1,22 @@
1
+ # FalaAI::WhatsappPreviewWindow
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **start** | **String** | Window start used | |
8
+ | **_end** | **String** | Window end used | |
9
+ | **selected** | **Integer** | Conversations matched by THIS window (before the union dedupe) | |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'falaai-api'
15
+
16
+ instance = FalaAI::WhatsappPreviewWindow.new(
17
+ start: null,
18
+ _end: null,
19
+ selected: null
20
+ )
21
+ ```
22
+
data/docs/WhatsappUsage.md CHANGED
@@ -6,12 +6,15 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **conversations** | **Integer** | Number of conversations returned | |
8
8
  | **characters** | **Integer** | Total characters across conversations | |
9
- | **expressions** | **Integer** | Expression tokens across conversations (sticker/emoji/gif) | |
9
+ | **expressions** | **Integer** | Chargeable expression occurrences (figurinha+GIF+emoji); 0 quando expression=false | |
10
+ | **expressions_figurinha** | **Integer** | Figurinha occurrences (cobra 0,15 cada quando expression=true) | |
11
+ | **expressions_gif** | **Integer** | GIF occurrences (cobra 0,18 cada quando expression=true) | |
12
+ | **expressions_emoji** | **Integer** | Emoji occurrences (cobra 0,1 cada quando expression=true) | |
10
13
  | **voice_notes** | **Integer** | Voice notes (PTT) resolved to text | |
11
- | **conversation_credits** | **Integer** | Credits for conversations (2 each) | |
12
- | **expression_credits** | **Float** | Credits for expressions (0.2 each) | |
13
- | **audio_credits** | **Float** | Credits for audio duration (0.2 per second) | |
14
- | **credits_consumed** | **Integer** | Total credits = ceil(conversation_credits + expression_credits + audio_credits) | |
14
+ | **conversation_credits** | **Float** | Credits for conversations (0,15 each) | |
15
+ | **expression_credits** | **Float** | Credits for expressions (figurinha 0,15 / GIF 0,18 / emoji 0,1) | |
16
+ | **audio_credits** | **Float** | Credits for transcribed voice seconds (0,19 per second; 0 quando voice_note=false) | |
17
+ | **credits_consumed** | **Float** | Total credits = round(conversation_credits + expression_credits + audio_credits, 2) | |
15
18
  | **processing_ms** | **Integer** | Total processing time in milliseconds | |
16
19
 
17
20
  ## Example
@@ -23,6 +26,9 @@ instance = FalaAI::WhatsappUsage.new(
23
26
  conversations: null,
24
27
  characters: null,
25
28
  expressions: null,
29
+ expressions_figurinha: null,
30
+ expressions_gif: null,
31
+ expressions_emoji: null,
26
32
  voice_notes: null,
27
33
  conversation_credits: null,
28
34
  expression_credits: null,