falaai-api 1.21.47
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.
- checksums.yaml +7 -0
- data/LICENSE +21 -0
- data/README.md +205 -0
- data/docs/AnalysisApi.md +147 -0
- data/docs/AudioEvent.md +26 -0
- data/docs/AudioInputMeta.md +26 -0
- data/docs/AuditoriaRiscoAnalysisV2.md +22 -0
- data/docs/AuditoriaRiscoAppliedActionV2.md +32 -0
- data/docs/AuditoriaRiscoAudioEventModelV2.md +22 -0
- data/docs/AuditoriaRiscoAuditDecisionsV2.md +22 -0
- data/docs/AuditoriaRiscoConversationScoresV2.md +38 -0
- data/docs/AuditoriaRiscoDetectionItemV2.md +110 -0
- data/docs/AuditoriaRiscoDetectionsV2.md +26 -0
- data/docs/AuditoriaRiscoIndexerV2.md +18 -0
- data/docs/AuditoriaRiscoMetaV2.md +28 -0
- data/docs/AuditoriaRiscoParticipantV2.md +22 -0
- data/docs/AuditoriaRiscoParticipantsV2.md +26 -0
- data/docs/AuditoriaRiscoRequest.md +38 -0
- data/docs/AuditoriaRiscoScoresV2.md +20 -0
- data/docs/AuditoriaRiscoScoringExplanationV2.md +20 -0
- data/docs/AuditoriaRiscoSummaryV2.md +48 -0
- data/docs/AuditoriaRiscoTimelineV2.md +22 -0
- data/docs/AuditoriaRiscoUsageV2.md +22 -0
- data/docs/AuditoriaRiscoV2.md +46 -0
- data/docs/AuditoriaRiscoV2Response.md +18 -0
- data/docs/AuditoriaRiscoVerdictV2.md +30 -0
- data/docs/CreateEmailAlertRequest.md +22 -0
- data/docs/CreateWebhookRequest.md +24 -0
- data/docs/DiagnosticAnalysisMap.md +28 -0
- data/docs/DiagnosticAudioEvent.md +26 -0
- data/docs/DiagnosticCategoricalAnalysis.md +22 -0
- data/docs/DiagnosticRequest.md +30 -0
- data/docs/DiagnosticResponse.md +28 -0
- data/docs/DiagnosticTextAnalysis.md +18 -0
- data/docs/DiagnosticUsage.md +22 -0
- data/docs/EmailAlertItem.md +32 -0
- data/docs/EmailAlertListResponse.md +22 -0
- data/docs/EmailAlertMessageResponse.md +18 -0
- data/docs/EmailAlertsApi.md +285 -0
- data/docs/EmailEvent.md +15 -0
- data/docs/HTTPValidationError.md +18 -0
- data/docs/HealthApi.md +137 -0
- data/docs/HealthResponse.md +28 -0
- data/docs/LocationInner.md +15 -0
- data/docs/MessageResponse.md +18 -0
- data/docs/Participant.md +22 -0
- data/docs/ParticipantDiagnostic.md +26 -0
- data/docs/SpeechApi.md +85 -0
- data/docs/TranscriptionResponse.md +49 -0
- data/docs/TranscriptionUsage.md +22 -0
- data/docs/UpdateEmailAlertRequest.md +24 -0
- data/docs/UpdateWebhookRequest.md +26 -0
- data/docs/UsageApi.md +151 -0
- data/docs/UsageByKeyItem.md +26 -0
- data/docs/UsageLogItem.md +28 -0
- data/docs/UsageLogResponse.md +22 -0
- data/docs/ValidationError.md +26 -0
- data/docs/VersionApi.md +72 -0
- data/docs/VersionResponse.md +22 -0
- data/docs/WebhookEvent.md +15 -0
- data/docs/WebhookItem.md +42 -0
- data/docs/WebhookListResponse.md +22 -0
- data/docs/WebhooksApi.md +293 -0
- data/lib/falaai-api/api/analysis_api.rb +158 -0
- data/lib/falaai-api/api/email_alerts_api.rb +294 -0
- data/lib/falaai-api/api/health_api.rb +132 -0
- data/lib/falaai-api/api/speech_api.rb +100 -0
- data/lib/falaai-api/api/usage_api.rb +156 -0
- data/lib/falaai-api/api/version_api.rb +77 -0
- data/lib/falaai-api/api/webhooks_api.rb +302 -0
- data/lib/falaai-api/api_client.rb +397 -0
- data/lib/falaai-api/api_error.rb +58 -0
- data/lib/falaai-api/api_model_base.rb +88 -0
- data/lib/falaai-api/configuration.rb +309 -0
- data/lib/falaai-api/models/audio_event.rb +273 -0
- data/lib/falaai-api/models/audio_input_meta.rb +273 -0
- data/lib/falaai-api/models/auditoria_risco_analysis_v2.rb +174 -0
- data/lib/falaai-api/models/auditoria_risco_applied_action_v2.rb +292 -0
- data/lib/falaai-api/models/auditoria_risco_audio_event_model_v2.rb +174 -0
- data/lib/falaai-api/models/auditoria_risco_audit_decisions_v2.rb +170 -0
- data/lib/falaai-api/models/auditoria_risco_conversation_scores_v2.rb +251 -0
- data/lib/falaai-api/models/auditoria_risco_detection_item_v2.rb +651 -0
- data/lib/falaai-api/models/auditoria_risco_detections_v2.rb +198 -0
- data/lib/falaai-api/models/auditoria_risco_indexer_v2.rb +150 -0
- data/lib/falaai-api/models/auditoria_risco_meta_v2.rb +234 -0
- data/lib/falaai-api/models/auditoria_risco_participant_v2.rb +168 -0
- data/lib/falaai-api/models/auditoria_risco_participants_v2.rb +196 -0
- data/lib/falaai-api/models/auditoria_risco_request.rb +451 -0
- data/lib/falaai-api/models/auditoria_risco_scores_v2.rb +177 -0
- data/lib/falaai-api/models/auditoria_risco_scoring_explanation_v2.rb +160 -0
- data/lib/falaai-api/models/auditoria_risco_summary_v2.rb +300 -0
- data/lib/falaai-api/models/auditoria_risco_timeline_v2.rb +174 -0
- data/lib/falaai-api/models/auditoria_risco_usage_v2.rb +219 -0
- data/lib/falaai-api/models/auditoria_risco_v2.rb +548 -0
- data/lib/falaai-api/models/auditoria_risco_v2_response.rb +165 -0
- data/lib/falaai-api/models/auditoria_risco_verdict_v2.rb +213 -0
- data/lib/falaai-api/models/create_email_alert_request.rb +221 -0
- data/lib/falaai-api/models/create_webhook_request.rb +233 -0
- data/lib/falaai-api/models/diagnostic_analysis_map.rb +285 -0
- data/lib/falaai-api/models/diagnostic_audio_event.rb +205 -0
- data/lib/falaai-api/models/diagnostic_categorical_analysis.rb +170 -0
- data/lib/falaai-api/models/diagnostic_request.rb +316 -0
- data/lib/falaai-api/models/diagnostic_response.rb +283 -0
- data/lib/falaai-api/models/diagnostic_text_analysis.rb +148 -0
- data/lib/falaai-api/models/diagnostic_usage.rb +219 -0
- data/lib/falaai-api/models/email_alert_item.rb +356 -0
- data/lib/falaai-api/models/email_alert_list_response.rb +218 -0
- data/lib/falaai-api/models/email_alert_message_response.rb +165 -0
- data/lib/falaai-api/models/email_event.rb +47 -0
- data/lib/falaai-api/models/health_response.rb +300 -0
- data/lib/falaai-api/models/http_validation_error.rb +149 -0
- data/lib/falaai-api/models/location_inner.rb +103 -0
- data/lib/falaai-api/models/message_response.rb +165 -0
- data/lib/falaai-api/models/participant.rb +226 -0
- data/lib/falaai-api/models/participant_diagnostic.rb +222 -0
- data/lib/falaai-api/models/transcription_response.rb +540 -0
- data/lib/falaai-api/models/transcription_usage.rb +219 -0
- data/lib/falaai-api/models/update_email_alert_request.rb +176 -0
- data/lib/falaai-api/models/update_webhook_request.rb +190 -0
- data/lib/falaai-api/models/usage_by_key_item.rb +256 -0
- data/lib/falaai-api/models/usage_log_item.rb +300 -0
- data/lib/falaai-api/models/usage_log_response.rb +218 -0
- data/lib/falaai-api/models/validation_error.rb +237 -0
- data/lib/falaai-api/models/version_response.rb +219 -0
- data/lib/falaai-api/models/webhook_event.rb +48 -0
- data/lib/falaai-api/models/webhook_item.rb +442 -0
- data/lib/falaai-api/models/webhook_list_response.rb +218 -0
- data/lib/falaai-api/version.rb +15 -0
- data/lib/falaai-api.rb +100 -0
- metadata +229 -0
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# FalaAI::DiagnosticResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | Unique analysis identifier. Prefix 'di-' + UUID | |
|
|
8
|
+
| **response_language** | **String** | Language used in the response. E.g.: 'pt-BR', 'en-US', 'es-ES' | |
|
|
9
|
+
| **object** | **String** | Object type. Always 'analysis' | |
|
|
10
|
+
| **analysis** | [**DiagnosticAnalysisMap**](DiagnosticAnalysisMap.md) | The 6 conversation analyses (5 + participants) | |
|
|
11
|
+
| **usage** | [**DiagnosticUsage**](DiagnosticUsage.md) | Usage and processing information | |
|
|
12
|
+
| **client_reference_id** | **String** | Client-supplied ID echoed verbatim (if provided in request) | [optional] |
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```ruby
|
|
17
|
+
require 'falaai-api'
|
|
18
|
+
|
|
19
|
+
instance = FalaAI::DiagnosticResponse.new(
|
|
20
|
+
id: di-550e8400-e29b-41d4-a716-446655440000,
|
|
21
|
+
response_language: pt-BR,
|
|
22
|
+
object: analysis,
|
|
23
|
+
analysis: null,
|
|
24
|
+
usage: null,
|
|
25
|
+
client_reference_id: call-2026-08-30-001
|
|
26
|
+
)
|
|
27
|
+
```
|
|
28
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# FalaAI::DiagnosticTextAnalysis
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **explanation** | **String** | Explanatory text (used in summary and reason) | [optional] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'falaai-api'
|
|
13
|
+
|
|
14
|
+
instance = FalaAI::DiagnosticTextAnalysis.new(
|
|
15
|
+
explanation: Speaker 1 provided guidance on documentation...
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# FalaAI::DiagnosticUsage
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **characters** | **Integer** | Total characters analyzed | |
|
|
8
|
+
| **credits_consumed** | **Integer** | Credits consumed: max(ceil(chars/500)*3, 3) * 5 | |
|
|
9
|
+
| **processing_ms** | **Integer** | Total processing time in milliseconds | |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'falaai-api'
|
|
15
|
+
|
|
16
|
+
instance = FalaAI::DiagnosticUsage.new(
|
|
17
|
+
characters: 3946,
|
|
18
|
+
credits_consumed: 15,
|
|
19
|
+
processing_ms: 6800
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# FalaAI::EmailAlertItem
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | Email alert id | |
|
|
8
|
+
| **user_id** | **String** | Owner user id | |
|
|
9
|
+
| **name** | **String** | Email alert name | |
|
|
10
|
+
| **email** | **String** | Destination email | |
|
|
11
|
+
| **events** | **Array<String>** | Subscribed events | |
|
|
12
|
+
| **active** | **Boolean** | Is active | |
|
|
13
|
+
| **created_at** | **String** | ISO 8601 created | |
|
|
14
|
+
| **updated_at** | **String** | ISO 8601 updated | |
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```ruby
|
|
19
|
+
require 'falaai-api'
|
|
20
|
+
|
|
21
|
+
instance = FalaAI::EmailAlertItem.new(
|
|
22
|
+
id: null,
|
|
23
|
+
user_id: null,
|
|
24
|
+
name: null,
|
|
25
|
+
email: null,
|
|
26
|
+
events: null,
|
|
27
|
+
active: null,
|
|
28
|
+
created_at: null,
|
|
29
|
+
updated_at: null
|
|
30
|
+
)
|
|
31
|
+
```
|
|
32
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# FalaAI::EmailAlertListResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **data** | [**Array<EmailAlertItem>**](EmailAlertItem.md) | | |
|
|
8
|
+
| **page** | **Integer** | | |
|
|
9
|
+
| **limit** | **Integer** | | |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'falaai-api'
|
|
15
|
+
|
|
16
|
+
instance = FalaAI::EmailAlertListResponse.new(
|
|
17
|
+
data: null,
|
|
18
|
+
page: null,
|
|
19
|
+
limit: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# FalaAI::EmailAlertMessageResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **message** | **String** | Operation result message | |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'falaai-api'
|
|
13
|
+
|
|
14
|
+
instance = FalaAI::EmailAlertMessageResponse.new(
|
|
15
|
+
message: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,285 @@
|
|
|
1
|
+
# FalaAI::EmailAlertsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *http://localhost*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**create_email_alert_v1_email_alerts_post**](EmailAlertsApi.md#create_email_alert_v1_email_alerts_post) | **POST** /v1/email-alerts | Criar email de alerta |
|
|
8
|
+
| [**delete_email_alert_v1_email_alerts_alert_id_delete**](EmailAlertsApi.md#delete_email_alert_v1_email_alerts_alert_id_delete) | **DELETE** /v1/email-alerts/{alert_id} | Remover email de alerta |
|
|
9
|
+
| [**list_email_alerts_v1_email_alerts_get**](EmailAlertsApi.md#list_email_alerts_v1_email_alerts_get) | **GET** /v1/email-alerts | Listar emails de alerta |
|
|
10
|
+
| [**update_email_alert_v1_email_alerts_alert_id_put**](EmailAlertsApi.md#update_email_alert_v1_email_alerts_alert_id_put) | **PUT** /v1/email-alerts/{alert_id} | Atualizar email de alerta |
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
## create_email_alert_v1_email_alerts_post
|
|
14
|
+
|
|
15
|
+
> <EmailAlertItem> create_email_alert_v1_email_alerts_post(create_email_alert_request)
|
|
16
|
+
|
|
17
|
+
Criar email de alerta
|
|
18
|
+
|
|
19
|
+
### Examples
|
|
20
|
+
|
|
21
|
+
```ruby
|
|
22
|
+
require 'time'
|
|
23
|
+
require 'falaai-api'
|
|
24
|
+
# setup authorization
|
|
25
|
+
FalaAI.configure do |config|
|
|
26
|
+
# Configure Bearer authorization (fai_xxx): ApiKeyAuth
|
|
27
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
28
|
+
end
|
|
29
|
+
|
|
30
|
+
api_instance = FalaAI::EmailAlertsApi.new
|
|
31
|
+
create_email_alert_request = FalaAI::CreateEmailAlertRequest.new({name: 'Financeiro', email: 'finance@empresa.com', events: [payment.failed, subscription.renewed]}) # CreateEmailAlertRequest |
|
|
32
|
+
|
|
33
|
+
begin
|
|
34
|
+
# Criar email de alerta
|
|
35
|
+
result = api_instance.create_email_alert_v1_email_alerts_post(create_email_alert_request)
|
|
36
|
+
p result
|
|
37
|
+
rescue FalaAI::ApiError => e
|
|
38
|
+
puts "Error when calling EmailAlertsApi->create_email_alert_v1_email_alerts_post: #{e}"
|
|
39
|
+
end
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
#### Using the create_email_alert_v1_email_alerts_post_with_http_info variant
|
|
43
|
+
|
|
44
|
+
This returns an Array which contains the response data, status code and headers.
|
|
45
|
+
|
|
46
|
+
> <Array(<EmailAlertItem>, Integer, Hash)> create_email_alert_v1_email_alerts_post_with_http_info(create_email_alert_request)
|
|
47
|
+
|
|
48
|
+
```ruby
|
|
49
|
+
begin
|
|
50
|
+
# Criar email de alerta
|
|
51
|
+
data, status_code, headers = api_instance.create_email_alert_v1_email_alerts_post_with_http_info(create_email_alert_request)
|
|
52
|
+
p status_code # => 2xx
|
|
53
|
+
p headers # => { ... }
|
|
54
|
+
p data # => <EmailAlertItem>
|
|
55
|
+
rescue FalaAI::ApiError => e
|
|
56
|
+
puts "Error when calling EmailAlertsApi->create_email_alert_v1_email_alerts_post_with_http_info: #{e}"
|
|
57
|
+
end
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
### Parameters
|
|
61
|
+
|
|
62
|
+
| Name | Type | Description | Notes |
|
|
63
|
+
| ---- | ---- | ----------- | ----- |
|
|
64
|
+
| **create_email_alert_request** | [**CreateEmailAlertRequest**](CreateEmailAlertRequest.md) | | |
|
|
65
|
+
|
|
66
|
+
### Return type
|
|
67
|
+
|
|
68
|
+
[**EmailAlertItem**](EmailAlertItem.md)
|
|
69
|
+
|
|
70
|
+
### Authorization
|
|
71
|
+
|
|
72
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
73
|
+
|
|
74
|
+
### HTTP request headers
|
|
75
|
+
|
|
76
|
+
- **Content-Type**: application/json
|
|
77
|
+
- **Accept**: application/json
|
|
78
|
+
|
|
79
|
+
|
|
80
|
+
## delete_email_alert_v1_email_alerts_alert_id_delete
|
|
81
|
+
|
|
82
|
+
> <EmailAlertMessageResponse> delete_email_alert_v1_email_alerts_alert_id_delete(alert_id)
|
|
83
|
+
|
|
84
|
+
Remover email de alerta
|
|
85
|
+
|
|
86
|
+
### Examples
|
|
87
|
+
|
|
88
|
+
```ruby
|
|
89
|
+
require 'time'
|
|
90
|
+
require 'falaai-api'
|
|
91
|
+
# setup authorization
|
|
92
|
+
FalaAI.configure do |config|
|
|
93
|
+
# Configure Bearer authorization (fai_xxx): ApiKeyAuth
|
|
94
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
95
|
+
end
|
|
96
|
+
|
|
97
|
+
api_instance = FalaAI::EmailAlertsApi.new
|
|
98
|
+
alert_id = 'alert_id_example' # String |
|
|
99
|
+
|
|
100
|
+
begin
|
|
101
|
+
# Remover email de alerta
|
|
102
|
+
result = api_instance.delete_email_alert_v1_email_alerts_alert_id_delete(alert_id)
|
|
103
|
+
p result
|
|
104
|
+
rescue FalaAI::ApiError => e
|
|
105
|
+
puts "Error when calling EmailAlertsApi->delete_email_alert_v1_email_alerts_alert_id_delete: #{e}"
|
|
106
|
+
end
|
|
107
|
+
```
|
|
108
|
+
|
|
109
|
+
#### Using the delete_email_alert_v1_email_alerts_alert_id_delete_with_http_info variant
|
|
110
|
+
|
|
111
|
+
This returns an Array which contains the response data, status code and headers.
|
|
112
|
+
|
|
113
|
+
> <Array(<EmailAlertMessageResponse>, Integer, Hash)> delete_email_alert_v1_email_alerts_alert_id_delete_with_http_info(alert_id)
|
|
114
|
+
|
|
115
|
+
```ruby
|
|
116
|
+
begin
|
|
117
|
+
# Remover email de alerta
|
|
118
|
+
data, status_code, headers = api_instance.delete_email_alert_v1_email_alerts_alert_id_delete_with_http_info(alert_id)
|
|
119
|
+
p status_code # => 2xx
|
|
120
|
+
p headers # => { ... }
|
|
121
|
+
p data # => <EmailAlertMessageResponse>
|
|
122
|
+
rescue FalaAI::ApiError => e
|
|
123
|
+
puts "Error when calling EmailAlertsApi->delete_email_alert_v1_email_alerts_alert_id_delete_with_http_info: #{e}"
|
|
124
|
+
end
|
|
125
|
+
```
|
|
126
|
+
|
|
127
|
+
### Parameters
|
|
128
|
+
|
|
129
|
+
| Name | Type | Description | Notes |
|
|
130
|
+
| ---- | ---- | ----------- | ----- |
|
|
131
|
+
| **alert_id** | **String** | | |
|
|
132
|
+
|
|
133
|
+
### Return type
|
|
134
|
+
|
|
135
|
+
[**EmailAlertMessageResponse**](EmailAlertMessageResponse.md)
|
|
136
|
+
|
|
137
|
+
### Authorization
|
|
138
|
+
|
|
139
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
140
|
+
|
|
141
|
+
### HTTP request headers
|
|
142
|
+
|
|
143
|
+
- **Content-Type**: Not defined
|
|
144
|
+
- **Accept**: application/json
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
## list_email_alerts_v1_email_alerts_get
|
|
148
|
+
|
|
149
|
+
> <EmailAlertListResponse> list_email_alerts_v1_email_alerts_get(opts)
|
|
150
|
+
|
|
151
|
+
Listar emails de alerta
|
|
152
|
+
|
|
153
|
+
### Examples
|
|
154
|
+
|
|
155
|
+
```ruby
|
|
156
|
+
require 'time'
|
|
157
|
+
require 'falaai-api'
|
|
158
|
+
# setup authorization
|
|
159
|
+
FalaAI.configure do |config|
|
|
160
|
+
# Configure Bearer authorization (fai_xxx): ApiKeyAuth
|
|
161
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
162
|
+
end
|
|
163
|
+
|
|
164
|
+
api_instance = FalaAI::EmailAlertsApi.new
|
|
165
|
+
opts = {
|
|
166
|
+
page: 56, # Integer |
|
|
167
|
+
limit: 56 # Integer |
|
|
168
|
+
}
|
|
169
|
+
|
|
170
|
+
begin
|
|
171
|
+
# Listar emails de alerta
|
|
172
|
+
result = api_instance.list_email_alerts_v1_email_alerts_get(opts)
|
|
173
|
+
p result
|
|
174
|
+
rescue FalaAI::ApiError => e
|
|
175
|
+
puts "Error when calling EmailAlertsApi->list_email_alerts_v1_email_alerts_get: #{e}"
|
|
176
|
+
end
|
|
177
|
+
```
|
|
178
|
+
|
|
179
|
+
#### Using the list_email_alerts_v1_email_alerts_get_with_http_info variant
|
|
180
|
+
|
|
181
|
+
This returns an Array which contains the response data, status code and headers.
|
|
182
|
+
|
|
183
|
+
> <Array(<EmailAlertListResponse>, Integer, Hash)> list_email_alerts_v1_email_alerts_get_with_http_info(opts)
|
|
184
|
+
|
|
185
|
+
```ruby
|
|
186
|
+
begin
|
|
187
|
+
# Listar emails de alerta
|
|
188
|
+
data, status_code, headers = api_instance.list_email_alerts_v1_email_alerts_get_with_http_info(opts)
|
|
189
|
+
p status_code # => 2xx
|
|
190
|
+
p headers # => { ... }
|
|
191
|
+
p data # => <EmailAlertListResponse>
|
|
192
|
+
rescue FalaAI::ApiError => e
|
|
193
|
+
puts "Error when calling EmailAlertsApi->list_email_alerts_v1_email_alerts_get_with_http_info: #{e}"
|
|
194
|
+
end
|
|
195
|
+
```
|
|
196
|
+
|
|
197
|
+
### Parameters
|
|
198
|
+
|
|
199
|
+
| Name | Type | Description | Notes |
|
|
200
|
+
| ---- | ---- | ----------- | ----- |
|
|
201
|
+
| **page** | **Integer** | | [optional][default to 1] |
|
|
202
|
+
| **limit** | **Integer** | | [optional][default to 20] |
|
|
203
|
+
|
|
204
|
+
### Return type
|
|
205
|
+
|
|
206
|
+
[**EmailAlertListResponse**](EmailAlertListResponse.md)
|
|
207
|
+
|
|
208
|
+
### Authorization
|
|
209
|
+
|
|
210
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
211
|
+
|
|
212
|
+
### HTTP request headers
|
|
213
|
+
|
|
214
|
+
- **Content-Type**: Not defined
|
|
215
|
+
- **Accept**: application/json
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
## update_email_alert_v1_email_alerts_alert_id_put
|
|
219
|
+
|
|
220
|
+
> <EmailAlertMessageResponse> update_email_alert_v1_email_alerts_alert_id_put(alert_id, update_email_alert_request)
|
|
221
|
+
|
|
222
|
+
Atualizar email de alerta
|
|
223
|
+
|
|
224
|
+
### Examples
|
|
225
|
+
|
|
226
|
+
```ruby
|
|
227
|
+
require 'time'
|
|
228
|
+
require 'falaai-api'
|
|
229
|
+
# setup authorization
|
|
230
|
+
FalaAI.configure do |config|
|
|
231
|
+
# Configure Bearer authorization (fai_xxx): ApiKeyAuth
|
|
232
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
233
|
+
end
|
|
234
|
+
|
|
235
|
+
api_instance = FalaAI::EmailAlertsApi.new
|
|
236
|
+
alert_id = 'alert_id_example' # String |
|
|
237
|
+
update_email_alert_request = FalaAI::UpdateEmailAlertRequest.new # UpdateEmailAlertRequest |
|
|
238
|
+
|
|
239
|
+
begin
|
|
240
|
+
# Atualizar email de alerta
|
|
241
|
+
result = api_instance.update_email_alert_v1_email_alerts_alert_id_put(alert_id, update_email_alert_request)
|
|
242
|
+
p result
|
|
243
|
+
rescue FalaAI::ApiError => e
|
|
244
|
+
puts "Error when calling EmailAlertsApi->update_email_alert_v1_email_alerts_alert_id_put: #{e}"
|
|
245
|
+
end
|
|
246
|
+
```
|
|
247
|
+
|
|
248
|
+
#### Using the update_email_alert_v1_email_alerts_alert_id_put_with_http_info variant
|
|
249
|
+
|
|
250
|
+
This returns an Array which contains the response data, status code and headers.
|
|
251
|
+
|
|
252
|
+
> <Array(<EmailAlertMessageResponse>, Integer, Hash)> update_email_alert_v1_email_alerts_alert_id_put_with_http_info(alert_id, update_email_alert_request)
|
|
253
|
+
|
|
254
|
+
```ruby
|
|
255
|
+
begin
|
|
256
|
+
# Atualizar email de alerta
|
|
257
|
+
data, status_code, headers = api_instance.update_email_alert_v1_email_alerts_alert_id_put_with_http_info(alert_id, update_email_alert_request)
|
|
258
|
+
p status_code # => 2xx
|
|
259
|
+
p headers # => { ... }
|
|
260
|
+
p data # => <EmailAlertMessageResponse>
|
|
261
|
+
rescue FalaAI::ApiError => e
|
|
262
|
+
puts "Error when calling EmailAlertsApi->update_email_alert_v1_email_alerts_alert_id_put_with_http_info: #{e}"
|
|
263
|
+
end
|
|
264
|
+
```
|
|
265
|
+
|
|
266
|
+
### Parameters
|
|
267
|
+
|
|
268
|
+
| Name | Type | Description | Notes |
|
|
269
|
+
| ---- | ---- | ----------- | ----- |
|
|
270
|
+
| **alert_id** | **String** | | |
|
|
271
|
+
| **update_email_alert_request** | [**UpdateEmailAlertRequest**](UpdateEmailAlertRequest.md) | | |
|
|
272
|
+
|
|
273
|
+
### Return type
|
|
274
|
+
|
|
275
|
+
[**EmailAlertMessageResponse**](EmailAlertMessageResponse.md)
|
|
276
|
+
|
|
277
|
+
### Authorization
|
|
278
|
+
|
|
279
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
280
|
+
|
|
281
|
+
### HTTP request headers
|
|
282
|
+
|
|
283
|
+
- **Content-Type**: application/json
|
|
284
|
+
- **Accept**: application/json
|
|
285
|
+
|
data/docs/EmailEvent.md
ADDED
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# FalaAI::HTTPValidationError
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **detail** | [**Array<ValidationError>**](ValidationError.md) | | [optional] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'falaai-api'
|
|
13
|
+
|
|
14
|
+
instance = FalaAI::HTTPValidationError.new(
|
|
15
|
+
detail: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
data/docs/HealthApi.md
ADDED
|
@@ -0,0 +1,137 @@
|
|
|
1
|
+
# FalaAI::HealthApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *http://localhost*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**health_check**](HealthApi.md#health_check) | **GET** /v1/health | Health Check |
|
|
8
|
+
| [**health_check_head**](HealthApi.md#health_check_head) | **HEAD** /v1/health | Health Check |
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
## health_check
|
|
12
|
+
|
|
13
|
+
> <HealthResponse> health_check
|
|
14
|
+
|
|
15
|
+
Health Check
|
|
16
|
+
|
|
17
|
+
### Examples
|
|
18
|
+
|
|
19
|
+
```ruby
|
|
20
|
+
require 'time'
|
|
21
|
+
require 'falaai-api'
|
|
22
|
+
# setup authorization
|
|
23
|
+
FalaAI.configure do |config|
|
|
24
|
+
# Configure Bearer authorization (fai_xxx): ApiKeyAuth
|
|
25
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
26
|
+
end
|
|
27
|
+
|
|
28
|
+
api_instance = FalaAI::HealthApi.new
|
|
29
|
+
|
|
30
|
+
begin
|
|
31
|
+
# Health Check
|
|
32
|
+
result = api_instance.health_check
|
|
33
|
+
p result
|
|
34
|
+
rescue FalaAI::ApiError => e
|
|
35
|
+
puts "Error when calling HealthApi->health_check: #{e}"
|
|
36
|
+
end
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
#### Using the health_check_with_http_info variant
|
|
40
|
+
|
|
41
|
+
This returns an Array which contains the response data, status code and headers.
|
|
42
|
+
|
|
43
|
+
> <Array(<HealthResponse>, Integer, Hash)> health_check_with_http_info
|
|
44
|
+
|
|
45
|
+
```ruby
|
|
46
|
+
begin
|
|
47
|
+
# Health Check
|
|
48
|
+
data, status_code, headers = api_instance.health_check_with_http_info
|
|
49
|
+
p status_code # => 2xx
|
|
50
|
+
p headers # => { ... }
|
|
51
|
+
p data # => <HealthResponse>
|
|
52
|
+
rescue FalaAI::ApiError => e
|
|
53
|
+
puts "Error when calling HealthApi->health_check_with_http_info: #{e}"
|
|
54
|
+
end
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
### Parameters
|
|
58
|
+
|
|
59
|
+
This endpoint does not need any parameter.
|
|
60
|
+
|
|
61
|
+
### Return type
|
|
62
|
+
|
|
63
|
+
[**HealthResponse**](HealthResponse.md)
|
|
64
|
+
|
|
65
|
+
### Authorization
|
|
66
|
+
|
|
67
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
68
|
+
|
|
69
|
+
### HTTP request headers
|
|
70
|
+
|
|
71
|
+
- **Content-Type**: Not defined
|
|
72
|
+
- **Accept**: application/json
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
## health_check_head
|
|
76
|
+
|
|
77
|
+
> <HealthResponse> health_check_head
|
|
78
|
+
|
|
79
|
+
Health Check
|
|
80
|
+
|
|
81
|
+
### Examples
|
|
82
|
+
|
|
83
|
+
```ruby
|
|
84
|
+
require 'time'
|
|
85
|
+
require 'falaai-api'
|
|
86
|
+
# setup authorization
|
|
87
|
+
FalaAI.configure do |config|
|
|
88
|
+
# Configure Bearer authorization (fai_xxx): ApiKeyAuth
|
|
89
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
90
|
+
end
|
|
91
|
+
|
|
92
|
+
api_instance = FalaAI::HealthApi.new
|
|
93
|
+
|
|
94
|
+
begin
|
|
95
|
+
# Health Check
|
|
96
|
+
result = api_instance.health_check_head
|
|
97
|
+
p result
|
|
98
|
+
rescue FalaAI::ApiError => e
|
|
99
|
+
puts "Error when calling HealthApi->health_check_head: #{e}"
|
|
100
|
+
end
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
#### Using the health_check_head_with_http_info variant
|
|
104
|
+
|
|
105
|
+
This returns an Array which contains the response data, status code and headers.
|
|
106
|
+
|
|
107
|
+
> <Array(<HealthResponse>, Integer, Hash)> health_check_head_with_http_info
|
|
108
|
+
|
|
109
|
+
```ruby
|
|
110
|
+
begin
|
|
111
|
+
# Health Check
|
|
112
|
+
data, status_code, headers = api_instance.health_check_head_with_http_info
|
|
113
|
+
p status_code # => 2xx
|
|
114
|
+
p headers # => { ... }
|
|
115
|
+
p data # => <HealthResponse>
|
|
116
|
+
rescue FalaAI::ApiError => e
|
|
117
|
+
puts "Error when calling HealthApi->health_check_head_with_http_info: #{e}"
|
|
118
|
+
end
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
### Parameters
|
|
122
|
+
|
|
123
|
+
This endpoint does not need any parameter.
|
|
124
|
+
|
|
125
|
+
### Return type
|
|
126
|
+
|
|
127
|
+
[**HealthResponse**](HealthResponse.md)
|
|
128
|
+
|
|
129
|
+
### Authorization
|
|
130
|
+
|
|
131
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
132
|
+
|
|
133
|
+
### HTTP request headers
|
|
134
|
+
|
|
135
|
+
- **Content-Type**: Not defined
|
|
136
|
+
- **Accept**: application/json
|
|
137
|
+
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# FalaAI::HealthResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **status** | **String** | Overall API status | |
|
|
8
|
+
| **version** | **String** | Current API version | |
|
|
9
|
+
| **uptime_seconds** | **Integer** | Uptime in seconds | |
|
|
10
|
+
| **database** | **Boolean** | Database connection status | |
|
|
11
|
+
| **phase** | **String** | Development phase | |
|
|
12
|
+
| **launch_date** | **String** | Expected public launch date | |
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```ruby
|
|
17
|
+
require 'falaai-api'
|
|
18
|
+
|
|
19
|
+
instance = FalaAI::HealthResponse.new(
|
|
20
|
+
status: ok,
|
|
21
|
+
version: api_v1.5.2,
|
|
22
|
+
uptime_seconds: 3600,
|
|
23
|
+
database: true,
|
|
24
|
+
phase: development,
|
|
25
|
+
launch_date: 2026-08-01
|
|
26
|
+
)
|
|
27
|
+
```
|
|
28
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# FalaAI::MessageResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **message** | **String** | Operation result message | |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'falaai-api'
|
|
13
|
+
|
|
14
|
+
instance = FalaAI::MessageResponse.new(
|
|
15
|
+
message: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
data/docs/Participant.md
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# FalaAI::Participant
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **interlocutor** | **String** | Exact identifier as used in dialog (e.g. 'Interlocutor 1', 'Antonio') | |
|
|
8
|
+
| **name** | **String** | Participant name (humanizes report, does not affect logic) | [optional] |
|
|
9
|
+
| **role** | **String** | Role: agent (human operator), client (customer), bot (IVR/AI) | |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'falaai-api'
|
|
15
|
+
|
|
16
|
+
instance = FalaAI::Participant.new(
|
|
17
|
+
interlocutor: Interlocutor 1,
|
|
18
|
+
name: Maria,
|
|
19
|
+
role: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|