Class: UltracartClient::ConversationPbxCallSearchRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/ultracart_api/models/conversation_pbx_call_search_request.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ConversationPbxCallSearchRequest

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/ultracart_api/models/conversation_pbx_call_search_request.rb', line 123

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `UltracartClient::ConversationPbxCallSearchRequest` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `UltracartClient::ConversationPbxCallSearchRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'agent_ids')
    if (value = attributes[:'agent_ids']).is_a?(Array)
      self.agent_ids = value
    end
  end

  if attributes.key?(:'customer_name')
    self.customer_name = attributes[:'customer_name']
  end

  if attributes.key?(:'direction')
    self.direction = attributes[:'direction']
  end

  if attributes.key?(:'disposition')
    self.disposition = attributes[:'disposition']
  end

  if attributes.key?(:'end_date')
    self.end_date = attributes[:'end_date']
  end

  if attributes.key?(:'has_ai_engagement')
    self.has_ai_engagement = attributes[:'has_ai_engagement']
  end

  if attributes.key?(:'has_recording')
    self.has_recording = attributes[:'has_recording']
  end

  if attributes.key?(:'has_transcript')
    self.has_transcript = attributes[:'has_transcript']
  end

  if attributes.key?(:'max_duration_seconds')
    self.max_duration_seconds = attributes[:'max_duration_seconds']
  end

  if attributes.key?(:'min_duration_seconds')
    self.min_duration_seconds = attributes[:'min_duration_seconds']
  end

  if attributes.key?(:'phone_number')
    self.phone_number = attributes[:'phone_number']
  end

  if attributes.key?(:'queue_uuids')
    if (value = attributes[:'queue_uuids']).is_a?(Array)
      self.queue_uuids = value
    end
  end

  if attributes.key?(:'search_term')
    self.search_term = attributes[:'search_term']
  end

  if attributes.key?(:'start_date')
    self.start_date = attributes[:'start_date']
  end

  if attributes.key?(:'statuses')
    if (value = attributes[:'statuses']).is_a?(Array)
      self.statuses = value
    end
  end

  if attributes.key?(:'transcript_search')
    self.transcript_search = attributes[:'transcript_search']
  end
end

Instance Attribute Details

#agent_ids ⇒ Object

Filter by agent IDs



19
20
21
 
# File 'lib/ultracart_api/models/conversation_pbx_call_search_request.rb', line 19

def agent_ids
  @agent_ids
end

#customer_name ⇒ Object

Filter by customer name



22
23
24
 
# File 'lib/ultracart_api/models/conversation_pbx_call_search_request.rb', line 22

def customer_name
  @customer_name
end

#direction ⇒ Object

Filter by call direction (inbound/outbound)



25
26
27
 
# File 'lib/ultracart_api/models/conversation_pbx_call_search_request.rb', line 25

def direction
  @direction
end

#disposition ⇒ Object

Filter by call disposition



28
29
30
 
# File 'lib/ultracart_api/models/conversation_pbx_call_search_request.rb', line 28

def disposition
  @disposition
end

#end_date ⇒ Object

Filter calls created on or before this date (ISO 8601)



31
32
33
 
# File 'lib/ultracart_api/models/conversation_pbx_call_search_request.rb', line 31

def end_date
  @end_date
end

#has_ai_engagement ⇒ Object

Filter to calls with AI agent engagement



34
35
36
 
# File 'lib/ultracart_api/models/conversation_pbx_call_search_request.rb', line 34

def has_ai_engagement
  @has_ai_engagement
end

#has_recording ⇒ Object

Filter to calls that have a recording



37
38
39
 
# File 'lib/ultracart_api/models/conversation_pbx_call_search_request.rb', line 37

def has_recording
  @has_recording
end

#has_transcript ⇒ Object

Filter to calls that have a transcript



40
41
42
 
# File 'lib/ultracart_api/models/conversation_pbx_call_search_request.rb', line 40

def has_transcript
  @has_transcript
end

#max_duration_seconds ⇒ Object

Filter by maximum call duration in seconds



43
44
45
 
# File 'lib/ultracart_api/models/conversation_pbx_call_search_request.rb', line 43

def max_duration_seconds
  @max_duration_seconds
end

#min_duration_seconds ⇒ Object

Filter by minimum call duration in seconds



46
47
48
 
# File 'lib/ultracart_api/models/conversation_pbx_call_search_request.rb', line 46

def min_duration_seconds
  @min_duration_seconds
end

#phone_number ⇒ Object

Filter by phone number (partial match supported)



49
50
51
 
# File 'lib/ultracart_api/models/conversation_pbx_call_search_request.rb', line 49

def phone_number
  @phone_number
end

#queue_uuids ⇒ Object

Filter by queue UUIDs



52
53
54
 
# File 'lib/ultracart_api/models/conversation_pbx_call_search_request.rb', line 52

def queue_uuids
  @queue_uuids
end

#search_term ⇒ Object

Free text search term - smart-routed based on content (phone, email, UUID, or general text)



55
56
57
 
# File 'lib/ultracart_api/models/conversation_pbx_call_search_request.rb', line 55

def search_term
  @search_term
end

#start_date ⇒ Object

Filter calls created on or after this date (ISO 8601)



58
59
60
 
# File 'lib/ultracart_api/models/conversation_pbx_call_search_request.rb', line 58

def start_date
  @start_date
end

#statuses ⇒ Object

Filter by call statuses



61
62
63
 
# File 'lib/ultracart_api/models/conversation_pbx_call_search_request.rb', line 61

def statuses
  @statuses
end

#transcript_search ⇒ Object

Search within transcript text



64
65
66
 
# File 'lib/ultracart_api/models/conversation_pbx_call_search_request.rb', line 64

def transcript_search
  @transcript_search
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



89
90
91
 
# File 'lib/ultracart_api/models/conversation_pbx_call_search_request.rb', line 89

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/ultracart_api/models/conversation_pbx_call_search_request.rb', line 67

def self.attribute_map
  {
    :'agent_ids' => :'agent_ids',
    :'customer_name' => :'customer_name',
    :'direction' => :'direction',
    :'disposition' => :'disposition',
    :'end_date' => :'end_date',
    :'has_ai_engagement' => :'has_ai_engagement',
    :'has_recording' => :'has_recording',
    :'has_transcript' => :'has_transcript',
    :'max_duration_seconds' => :'max_duration_seconds',
    :'min_duration_seconds' => :'min_duration_seconds',
    :'phone_number' => :'phone_number',
    :'queue_uuids' => :'queue_uuids',
    :'search_term' => :'search_term',
    :'start_date' => :'start_date',
    :'statuses' => :'statuses',
    :'transcript_search' => :'transcript_search'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



258
259
260
 
# File 'lib/ultracart_api/models/conversation_pbx_call_search_request.rb', line 258

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



116
117
118
119
 
# File 'lib/ultracart_api/models/conversation_pbx_call_search_request.rb', line 116

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/ultracart_api/models/conversation_pbx_call_search_request.rb', line 94

def self.openapi_types
  {
    :'agent_ids' => :'Array<String>',
    :'customer_name' => :'String',
    :'direction' => :'String',
    :'disposition' => :'String',
    :'end_date' => :'String',
    :'has_ai_engagement' => :'Boolean',
    :'has_recording' => :'Boolean',
    :'has_transcript' => :'Boolean',
    :'max_duration_seconds' => :'Integer',
    :'min_duration_seconds' => :'Integer',
    :'phone_number' => :'String',
    :'queue_uuids' => :'Array<String>',
    :'search_term' => :'String',
    :'start_date' => :'String',
    :'statuses' => :'Array<String>',
    :'transcript_search' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/ultracart_api/models/conversation_pbx_call_search_request.rb', line 222

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      agent_ids == o.agent_ids &&
      customer_name == o.customer_name &&
      direction == o.direction &&
      disposition == o.disposition &&
      end_date == o.end_date &&
      has_ai_engagement == o.has_ai_engagement &&
      has_recording == o.has_recording &&
      has_transcript == o.has_transcript &&
      max_duration_seconds == o.max_duration_seconds &&
      min_duration_seconds == o.min_duration_seconds &&
      phone_number == o.phone_number &&
      queue_uuids == o.queue_uuids &&
      search_term == o.search_term &&
      start_date == o.start_date &&
      statuses == o.statuses &&
      transcript_search == o.transcript_search
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/ultracart_api/models/conversation_pbx_call_search_request.rb', line 289

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = UltracartClient.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



360
361
362
363
364
365
366
367
368
369
370
371
372
 
# File 'lib/ultracart_api/models/conversation_pbx_call_search_request.rb', line 360

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/ultracart_api/models/conversation_pbx_call_search_request.rb', line 265

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


245
246
247
 
# File 'lib/ultracart_api/models/conversation_pbx_call_search_request.rb', line 245

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



251
252
253
 
# File 'lib/ultracart_api/models/conversation_pbx_call_search_request.rb', line 251

def hash
  [agent_ids, customer_name, direction, disposition, end_date, has_ai_engagement, has_recording, has_transcript, max_duration_seconds, min_duration_seconds, phone_number, queue_uuids, search_term, start_date, statuses, transcript_search].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



209
210
211
212
 
# File 'lib/ultracart_api/models/conversation_pbx_call_search_request.rb', line 209

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



336
337
338
 
# File 'lib/ultracart_api/models/conversation_pbx_call_search_request.rb', line 336

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/ultracart_api/models/conversation_pbx_call_search_request.rb', line 342

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



330
331
332
 
# File 'lib/ultracart_api/models/conversation_pbx_call_search_request.rb', line 330

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



216
217
218
 
# File 'lib/ultracart_api/models/conversation_pbx_call_search_request.rb', line 216

def valid?
  true
end