falaai-api 1.21.49 → 1.21.51

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 (87) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +36 -38
  3. data/docs/RiskAuditRequest.md +1 -1
  4. data/docs/WhatsappApi.md +93 -0
  5. data/docs/WhatsappConversation.md +32 -0
  6. data/docs/WhatsappConversationsResponse.md +28 -0
  7. data/docs/WhatsappMeta.md +48 -0
  8. data/docs/WhatsappSpeaker.md +20 -0
  9. data/docs/WhatsappUsage.md +24 -0
  10. data/docs/index.html +32 -29
  11. data/docs/llms.txt +18 -0
  12. data/docs/robots.txt +4 -0
  13. data/docs/sitemap.xml +8 -0
  14. data/lib/falaai-api/api/analysis_api.rb +1 -1
  15. data/lib/falaai-api/api/email_alerts_api.rb +1 -1
  16. data/lib/falaai-api/api/health_api.rb +1 -1
  17. data/lib/falaai-api/api/speech_api.rb +1 -1
  18. data/lib/falaai-api/api/usage_api.rb +1 -1
  19. data/lib/falaai-api/api/version_api.rb +1 -1
  20. data/lib/falaai-api/api/webhooks_api.rb +1 -1
  21. data/lib/falaai-api/api/whatsapp_api.rb +129 -0
  22. data/lib/falaai-api/api_client.rb +1 -1
  23. data/lib/falaai-api/api_error.rb +1 -1
  24. data/lib/falaai-api/api_model_base.rb +1 -1
  25. data/lib/falaai-api/configuration.rb +1 -1
  26. data/lib/falaai-api/models/audio_event.rb +1 -1
  27. data/lib/falaai-api/models/audio_input_meta.rb +1 -1
  28. data/lib/falaai-api/models/create_email_alert_request.rb +1 -1
  29. data/lib/falaai-api/models/create_webhook_request.rb +1 -1
  30. data/lib/falaai-api/models/diagnostic_analysis_map.rb +1 -1
  31. data/lib/falaai-api/models/diagnostic_audio_event.rb +1 -1
  32. data/lib/falaai-api/models/diagnostic_categorical_analysis.rb +1 -1
  33. data/lib/falaai-api/models/diagnostic_participant.rb +1 -1
  34. data/lib/falaai-api/models/diagnostic_request.rb +1 -1
  35. data/lib/falaai-api/models/diagnostic_response.rb +1 -1
  36. data/lib/falaai-api/models/diagnostic_text_analysis.rb +1 -1
  37. data/lib/falaai-api/models/diagnostic_usage.rb +1 -1
  38. data/lib/falaai-api/models/email_alert_item.rb +1 -1
  39. data/lib/falaai-api/models/email_alert_list_response.rb +1 -1
  40. data/lib/falaai-api/models/email_alert_message_response.rb +1 -1
  41. data/lib/falaai-api/models/email_event.rb +1 -1
  42. data/lib/falaai-api/models/health_response.rb +1 -1
  43. data/lib/falaai-api/models/http_validation_error.rb +1 -1
  44. data/lib/falaai-api/models/location_inner.rb +1 -1
  45. data/lib/falaai-api/models/message_response.rb +1 -1
  46. data/lib/falaai-api/models/participant.rb +1 -1
  47. data/lib/falaai-api/models/participant_diagnostic.rb +1 -1
  48. data/lib/falaai-api/models/risk_audit_analysis_v2.rb +1 -1
  49. data/lib/falaai-api/models/risk_audit_applied_action_v2.rb +1 -1
  50. data/lib/falaai-api/models/risk_audit_audio_event_model_v2.rb +1 -1
  51. data/lib/falaai-api/models/risk_audit_audit_decisions_v2.rb +1 -1
  52. data/lib/falaai-api/models/risk_audit_conversation_scores_v2.rb +1 -1
  53. data/lib/falaai-api/models/risk_audit_detection_item_v2.rb +1 -1
  54. data/lib/falaai-api/models/risk_audit_detections_v2.rb +1 -1
  55. data/lib/falaai-api/models/risk_audit_indexer_v2.rb +1 -1
  56. data/lib/falaai-api/models/risk_audit_meta_v2.rb +1 -1
  57. data/lib/falaai-api/models/risk_audit_participant_v2.rb +1 -1
  58. data/lib/falaai-api/models/risk_audit_participants_v2.rb +1 -1
  59. data/lib/falaai-api/models/risk_audit_request.rb +9 -18
  60. data/lib/falaai-api/models/risk_audit_scores_v2.rb +1 -1
  61. data/lib/falaai-api/models/risk_audit_scoring_explanation_v2.rb +1 -1
  62. data/lib/falaai-api/models/risk_audit_summary_v2.rb +1 -1
  63. data/lib/falaai-api/models/risk_audit_timeline_v2.rb +1 -1
  64. data/lib/falaai-api/models/risk_audit_usage_v2.rb +1 -1
  65. data/lib/falaai-api/models/risk_audit_v2.rb +1 -1
  66. data/lib/falaai-api/models/risk_audit_v2_response.rb +1 -1
  67. data/lib/falaai-api/models/risk_audit_verdict_v2.rb +1 -1
  68. data/lib/falaai-api/models/transcription_response.rb +1 -1
  69. data/lib/falaai-api/models/transcription_usage.rb +1 -1
  70. data/lib/falaai-api/models/update_email_alert_request.rb +1 -1
  71. data/lib/falaai-api/models/update_webhook_request.rb +1 -1
  72. data/lib/falaai-api/models/usage_by_key_item.rb +1 -1
  73. data/lib/falaai-api/models/usage_log_item.rb +1 -1
  74. data/lib/falaai-api/models/usage_log_response.rb +1 -1
  75. data/lib/falaai-api/models/validation_error.rb +1 -1
  76. data/lib/falaai-api/models/version_response.rb +1 -1
  77. data/lib/falaai-api/models/webhook_event.rb +1 -1
  78. data/lib/falaai-api/models/webhook_item.rb +1 -1
  79. data/lib/falaai-api/models/webhook_list_response.rb +1 -1
  80. data/lib/falaai-api/models/whatsapp_conversation.rb +356 -0
  81. data/lib/falaai-api/models/whatsapp_conversations_response.rb +285 -0
  82. data/lib/falaai-api/models/whatsapp_meta.rb +570 -0
  83. data/lib/falaai-api/models/whatsapp_speaker.rb +192 -0
  84. data/lib/falaai-api/models/whatsapp_usage.rb +246 -0
  85. data/lib/falaai-api/version.rb +2 -2
  86. data/lib/falaai-api.rb +7 -1
  87. metadata +17 -2
@@ -0,0 +1,285 @@
1
+ =begin
2
+ #FalaAI 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.21.51
7
+
8
+ Generated by: https://openapi-generator.tech
9
+ Generator version: 7.25.0
10
+
11
+ =end
12
+
13
+ require 'date'
14
+ require 'time'
15
+
16
+ module FalaAI
17
+ class WhatsappConversationsResponse < ApiModelBase
18
+ # Unique identifier. Prefix 'wc-' + UUID
19
+ attr_accessor :id
20
+
21
+ # Object type. Always 'conversations'
22
+ attr_accessor :object
23
+
24
+ # Usage and processing information
25
+ attr_accessor :usage
26
+
27
+ # Segmented conversations
28
+ attr_accessor :conversations
29
+
30
+ # Client-supplied ID echoed verbatim (if provided)
31
+ attr_accessor :client_reference_id
32
+
33
+ # Segmentation parameters and counts
34
+ attr_accessor :meta
35
+
36
+ # Attribute mapping from ruby-style variable name to JSON key.
37
+ def self.attribute_map
38
+ {
39
+ :'id' => :'id',
40
+ :'object' => :'object',
41
+ :'usage' => :'usage',
42
+ :'conversations' => :'conversations',
43
+ :'client_reference_id' => :'client_reference_id',
44
+ :'meta' => :'meta'
45
+ }
46
+ end
47
+
48
+ # Returns attribute mapping this model knows about
49
+ def self.acceptable_attribute_map
50
+ attribute_map
51
+ end
52
+
53
+ # Returns all the JSON keys this model knows about
54
+ def self.acceptable_attributes
55
+ acceptable_attribute_map.values
56
+ end
57
+
58
+ # Attribute type mapping.
59
+ def self.openapi_types
60
+ {
61
+ :'id' => :'String',
62
+ :'object' => :'String',
63
+ :'usage' => :'WhatsappUsage',
64
+ :'conversations' => :'Array<WhatsappConversation>',
65
+ :'client_reference_id' => :'String',
66
+ :'meta' => :'WhatsappMeta'
67
+ }
68
+ end
69
+
70
+ # List of attributes with nullable: true
71
+ def self.openapi_nullable
72
+ Set.new([
73
+ ])
74
+ end
75
+
76
+ # Initializes the object
77
+ # @param [Hash] attributes Model attributes in the form of hash
78
+ def initialize(attributes = {})
79
+ if (!attributes.is_a?(Hash))
80
+ fail ArgumentError, "The input argument (attributes) must be a hash in `FalaAI::WhatsappConversationsResponse` initialize method"
81
+ end
82
+
83
+ # check to see if the attribute exists and convert string to symbol for hash key
84
+ acceptable_attribute_map = self.class.acceptable_attribute_map
85
+ attributes = attributes.each_with_object({}) { |(k, v), h|
86
+ if (!acceptable_attribute_map.key?(k.to_sym))
87
+ fail ArgumentError, "`#{k}` is not a valid attribute in `FalaAI::WhatsappConversationsResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
88
+ end
89
+ h[k.to_sym] = v
90
+ }
91
+
92
+ if attributes.key?(:'id')
93
+ self.id = attributes[:'id']
94
+ else
95
+ self.id = nil
96
+ end
97
+
98
+ if attributes.key?(:'object')
99
+ self.object = attributes[:'object']
100
+ else
101
+ self.object = nil
102
+ end
103
+
104
+ if attributes.key?(:'usage')
105
+ self.usage = attributes[:'usage']
106
+ else
107
+ self.usage = nil
108
+ end
109
+
110
+ if attributes.key?(:'conversations')
111
+ if (value = attributes[:'conversations']).is_a?(Array)
112
+ self.conversations = value
113
+ end
114
+ else
115
+ self.conversations = nil
116
+ end
117
+
118
+ if attributes.key?(:'client_reference_id')
119
+ self.client_reference_id = attributes[:'client_reference_id']
120
+ end
121
+
122
+ if attributes.key?(:'meta')
123
+ self.meta = attributes[:'meta']
124
+ else
125
+ self.meta = nil
126
+ end
127
+ end
128
+
129
+ # Show invalid properties with the reasons. Usually used together with valid?
130
+ # @return Array for valid properties with the reasons
131
+ def list_invalid_properties
132
+ warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
133
+ invalid_properties = Array.new
134
+ if @id.nil?
135
+ invalid_properties.push('invalid value for "id", id cannot be nil.')
136
+ end
137
+
138
+ if @object.nil?
139
+ invalid_properties.push('invalid value for "object", object cannot be nil.')
140
+ end
141
+
142
+ if @usage.nil?
143
+ invalid_properties.push('invalid value for "usage", usage cannot be nil.')
144
+ end
145
+
146
+ if @conversations.nil?
147
+ invalid_properties.push('invalid value for "conversations", conversations cannot be nil.')
148
+ end
149
+
150
+ if @meta.nil?
151
+ invalid_properties.push('invalid value for "meta", meta cannot be nil.')
152
+ end
153
+
154
+ invalid_properties
155
+ end
156
+
157
+ # Check to see if the all the properties in the model are valid
158
+ # @return true if the model is valid
159
+ def valid?
160
+ warn '[DEPRECATED] the `valid?` method is obsolete'
161
+ return false if @id.nil?
162
+ return false if @object.nil?
163
+ return false if @usage.nil?
164
+ return false if @conversations.nil?
165
+ return false if @meta.nil?
166
+ true
167
+ end
168
+
169
+ # Custom attribute writer method with validation
170
+ # @param [Object] id Value to be assigned
171
+ def id=(id)
172
+ if id.nil?
173
+ fail ArgumentError, 'id cannot be nil'
174
+ end
175
+
176
+ @id = id
177
+ end
178
+
179
+ # Custom attribute writer method with validation
180
+ # @param [Object] object Value to be assigned
181
+ def object=(object)
182
+ if object.nil?
183
+ fail ArgumentError, 'object cannot be nil'
184
+ end
185
+
186
+ @object = object
187
+ end
188
+
189
+ # Custom attribute writer method with validation
190
+ # @param [Object] usage Value to be assigned
191
+ def usage=(usage)
192
+ if usage.nil?
193
+ fail ArgumentError, 'usage cannot be nil'
194
+ end
195
+
196
+ @usage = usage
197
+ end
198
+
199
+ # Custom attribute writer method with validation
200
+ # @param [Object] conversations Value to be assigned
201
+ def conversations=(conversations)
202
+ if conversations.nil?
203
+ fail ArgumentError, 'conversations cannot be nil'
204
+ end
205
+
206
+ @conversations = conversations
207
+ end
208
+
209
+ # Custom attribute writer method with validation
210
+ # @param [Object] meta Value to be assigned
211
+ def meta=(meta)
212
+ if meta.nil?
213
+ fail ArgumentError, 'meta cannot be nil'
214
+ end
215
+
216
+ @meta = meta
217
+ end
218
+
219
+ # Checks equality by comparing each attribute.
220
+ # @param [Object] Object to be compared
221
+ def ==(o)
222
+ return true if self.equal?(o)
223
+ self.class == o.class &&
224
+ id == o.id &&
225
+ object == o.object &&
226
+ usage == o.usage &&
227
+ conversations == o.conversations &&
228
+ client_reference_id == o.client_reference_id &&
229
+ meta == o.meta
230
+ end
231
+
232
+ # @see the `==` method
233
+ # @param [Object] Object to be compared
234
+ def eql?(o)
235
+ self == o
236
+ end
237
+
238
+ # Calculates hash code according to all attributes.
239
+ # @return [Integer] Hash code
240
+ def hash
241
+ [id, object, usage, conversations, client_reference_id, meta].hash
242
+ end
243
+
244
+ # Builds the object from hash
245
+ # @param [Hash] attributes Model attributes in the form of hash
246
+ # @return [Object] Returns the model itself
247
+ def self.build_from_hash(attributes)
248
+ return nil unless attributes.is_a?(Hash)
249
+ attributes = attributes.transform_keys(&:to_sym)
250
+ transformed_hash = {}
251
+ openapi_types.each_pair do |key, type|
252
+ if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
253
+ transformed_hash["#{key}"] = nil
254
+ elsif type =~ /\AArray<(.*)>/i
255
+ # check to ensure the input is an array given that the attribute
256
+ # is documented as an array but the input is not
257
+ if attributes[attribute_map[key]].is_a?(Array)
258
+ transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
259
+ end
260
+ elsif !attributes[attribute_map[key]].nil?
261
+ transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
262
+ end
263
+ end
264
+ new(transformed_hash)
265
+ end
266
+
267
+ # Returns the object in the form of hash
268
+ # @return [Hash] Returns the object in the form of hash
269
+ def to_hash
270
+ hash = {}
271
+ self.class.attribute_map.each_pair do |attr, param|
272
+ value = self.send(attr)
273
+ if value.nil?
274
+ is_nullable = self.class.openapi_nullable.include?(attr)
275
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
276
+ end
277
+
278
+ hash[param] = _to_hash(value)
279
+ end
280
+ hash
281
+ end
282
+
283
+ end
284
+
285
+ end