ultracart_api 3.11.56 → 3.11.57
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 +4 -4
- data/README.md +16 -4
- data/docs/ConversationAgentAuth.md +1 -0
- data/docs/ConversationApi.md +309 -0
- data/docs/ConversationPbxAgent.md +1 -0
- data/docs/ConversationPbxCallRecording.md +1 -0
- data/docs/ConversationPbxClassOfService.md +16 -0
- data/docs/ConversationPbxClassOfServiceResponse.md +12 -0
- data/docs/ConversationPbxClassOfServicesResponse.md +12 -0
- data/docs/ConversationPbxCosAuditLog.md +17 -0
- data/docs/ConversationPbxCosAuditLogsResponse.md +12 -0
- data/docs/Twilio.md +1 -0
- data/lib/ultracart_api/api/conversation_api.rb +333 -0
- data/lib/ultracart_api/models/conversation_agent_auth.rb +11 -1
- data/lib/ultracart_api/models/conversation_pbx_agent.rb +18 -6
- data/lib/ultracart_api/models/conversation_pbx_call_recording.rb +11 -1
- data/lib/ultracart_api/models/conversation_pbx_class_of_service.rb +312 -0
- data/lib/ultracart_api/models/conversation_pbx_class_of_service_response.rb +221 -0
- data/lib/ultracart_api/models/conversation_pbx_class_of_services_response.rb +224 -0
- data/lib/ultracart_api/models/conversation_pbx_cos_audit_log.rb +336 -0
- data/lib/ultracart_api/models/conversation_pbx_cos_audit_logs_response.rb +224 -0
- data/lib/ultracart_api/models/conversation_pbx_queue.rb +14 -10
- data/lib/ultracart_api/models/twilio.rb +10 -1
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +5 -0
- metadata +12 -2
|
@@ -0,0 +1,224 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#UltraCart Rest API V2
|
|
3
|
+
|
|
4
|
+
#UltraCart REST API Version 2
|
|
5
|
+
|
|
6
|
+
OpenAPI spec version: 2.0.0
|
|
7
|
+
Contact: support@ultracart.com
|
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
9
|
+
Swagger Codegen version: 2.4.15-SNAPSHOT
|
|
10
|
+
|
|
11
|
+
=end
|
|
12
|
+
|
|
13
|
+
require 'date'
|
|
14
|
+
|
|
15
|
+
module UltracartClient
|
|
16
|
+
class ConversationPbxCosAuditLogsResponse
|
|
17
|
+
# Array of audit log entries
|
|
18
|
+
attr_accessor :audit_logs
|
|
19
|
+
|
|
20
|
+
attr_accessor :error
|
|
21
|
+
|
|
22
|
+
attr_accessor :metadata
|
|
23
|
+
|
|
24
|
+
# Indicates if API call was successful
|
|
25
|
+
attr_accessor :success
|
|
26
|
+
|
|
27
|
+
attr_accessor :warning
|
|
28
|
+
|
|
29
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
|
30
|
+
def self.attribute_map
|
|
31
|
+
{
|
|
32
|
+
:'audit_logs' => :'audit_logs',
|
|
33
|
+
:'error' => :'error',
|
|
34
|
+
:'metadata' => :'metadata',
|
|
35
|
+
:'success' => :'success',
|
|
36
|
+
:'warning' => :'warning'
|
|
37
|
+
}
|
|
38
|
+
end
|
|
39
|
+
|
|
40
|
+
# Attribute type mapping.
|
|
41
|
+
def self.swagger_types
|
|
42
|
+
{
|
|
43
|
+
:'audit_logs' => :'Array<ConversationPbxCosAuditLog>',
|
|
44
|
+
:'error' => :'Error',
|
|
45
|
+
:'metadata' => :'ResponseMetadata',
|
|
46
|
+
:'success' => :'BOOLEAN',
|
|
47
|
+
:'warning' => :'Warning'
|
|
48
|
+
}
|
|
49
|
+
end
|
|
50
|
+
|
|
51
|
+
# Initializes the object
|
|
52
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
53
|
+
def initialize(attributes = {})
|
|
54
|
+
return unless attributes.is_a?(Hash)
|
|
55
|
+
|
|
56
|
+
# convert string to symbol for hash key
|
|
57
|
+
attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
|
|
58
|
+
|
|
59
|
+
if attributes.has_key?(:'audit_logs')
|
|
60
|
+
if (value = attributes[:'audit_logs']).is_a?(Array)
|
|
61
|
+
self.audit_logs = value
|
|
62
|
+
end
|
|
63
|
+
end
|
|
64
|
+
|
|
65
|
+
if attributes.has_key?(:'error')
|
|
66
|
+
self.error = attributes[:'error']
|
|
67
|
+
end
|
|
68
|
+
|
|
69
|
+
if attributes.has_key?(:'metadata')
|
|
70
|
+
self.metadata = attributes[:'metadata']
|
|
71
|
+
end
|
|
72
|
+
|
|
73
|
+
if attributes.has_key?(:'success')
|
|
74
|
+
self.success = attributes[:'success']
|
|
75
|
+
end
|
|
76
|
+
|
|
77
|
+
if attributes.has_key?(:'warning')
|
|
78
|
+
self.warning = attributes[:'warning']
|
|
79
|
+
end
|
|
80
|
+
end
|
|
81
|
+
|
|
82
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
|
83
|
+
# @return Array for valid properties with the reasons
|
|
84
|
+
def list_invalid_properties
|
|
85
|
+
invalid_properties = Array.new
|
|
86
|
+
invalid_properties
|
|
87
|
+
end
|
|
88
|
+
|
|
89
|
+
# Check to see if the all the properties in the model are valid
|
|
90
|
+
# @return true if the model is valid
|
|
91
|
+
def valid?
|
|
92
|
+
true
|
|
93
|
+
end
|
|
94
|
+
|
|
95
|
+
# Checks equality by comparing each attribute.
|
|
96
|
+
# @param [Object] Object to be compared
|
|
97
|
+
def ==(o)
|
|
98
|
+
return true if self.equal?(o)
|
|
99
|
+
self.class == o.class &&
|
|
100
|
+
audit_logs == o.audit_logs &&
|
|
101
|
+
error == o.error &&
|
|
102
|
+
metadata == o.metadata &&
|
|
103
|
+
success == o.success &&
|
|
104
|
+
warning == o.warning
|
|
105
|
+
end
|
|
106
|
+
|
|
107
|
+
# @see the `==` method
|
|
108
|
+
# @param [Object] Object to be compared
|
|
109
|
+
def eql?(o)
|
|
110
|
+
self == o
|
|
111
|
+
end
|
|
112
|
+
|
|
113
|
+
# Calculates hash code according to all attributes.
|
|
114
|
+
# @return [Fixnum] Hash code
|
|
115
|
+
def hash
|
|
116
|
+
[audit_logs, error, metadata, success, warning].hash
|
|
117
|
+
end
|
|
118
|
+
|
|
119
|
+
# Builds the object from hash
|
|
120
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
121
|
+
# @return [Object] Returns the model itself
|
|
122
|
+
def build_from_hash(attributes)
|
|
123
|
+
return nil unless attributes.is_a?(Hash)
|
|
124
|
+
self.class.swagger_types.each_pair do |key, type|
|
|
125
|
+
if type =~ /\AArray<(.*)>/i
|
|
126
|
+
# check to ensure the input is an array given that the attribute
|
|
127
|
+
# is documented as an array but the input is not
|
|
128
|
+
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
|
129
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
|
|
130
|
+
end
|
|
131
|
+
elsif !attributes[self.class.attribute_map[key]].nil?
|
|
132
|
+
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
|
133
|
+
end # or else data not found in attributes(hash), not an issue as the data can be optional
|
|
134
|
+
end
|
|
135
|
+
|
|
136
|
+
self
|
|
137
|
+
end
|
|
138
|
+
|
|
139
|
+
# Deserializes the data based on type
|
|
140
|
+
# @param string type Data type
|
|
141
|
+
# @param string value Value to be deserialized
|
|
142
|
+
# @return [Object] Deserialized data
|
|
143
|
+
def _deserialize(type, value)
|
|
144
|
+
case type.to_sym
|
|
145
|
+
when :DateTime
|
|
146
|
+
DateTime.parse(value)
|
|
147
|
+
when :Date
|
|
148
|
+
Date.parse(value)
|
|
149
|
+
when :String
|
|
150
|
+
value.to_s
|
|
151
|
+
when :Integer
|
|
152
|
+
value.to_i
|
|
153
|
+
when :Float
|
|
154
|
+
value.to_f
|
|
155
|
+
when :BOOLEAN
|
|
156
|
+
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
|
157
|
+
true
|
|
158
|
+
else
|
|
159
|
+
false
|
|
160
|
+
end
|
|
161
|
+
when :Object
|
|
162
|
+
# generic object (usually a Hash), return directly
|
|
163
|
+
value
|
|
164
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
|
165
|
+
inner_type = Regexp.last_match[:inner_type]
|
|
166
|
+
value.map { |v| _deserialize(inner_type, v) }
|
|
167
|
+
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
|
168
|
+
k_type = Regexp.last_match[:k_type]
|
|
169
|
+
v_type = Regexp.last_match[:v_type]
|
|
170
|
+
{}.tap do |hash|
|
|
171
|
+
value.each do |k, v|
|
|
172
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
|
173
|
+
end
|
|
174
|
+
end
|
|
175
|
+
else # model
|
|
176
|
+
temp_model = UltracartClient.const_get(type).new
|
|
177
|
+
temp_model.build_from_hash(value)
|
|
178
|
+
end
|
|
179
|
+
end
|
|
180
|
+
|
|
181
|
+
# Returns the string representation of the object
|
|
182
|
+
# @return [String] String presentation of the object
|
|
183
|
+
def to_s
|
|
184
|
+
to_hash.to_s
|
|
185
|
+
end
|
|
186
|
+
|
|
187
|
+
# to_body is an alias to to_hash (backward compatibility)
|
|
188
|
+
# @return [Hash] Returns the object in the form of hash
|
|
189
|
+
def to_body
|
|
190
|
+
to_hash
|
|
191
|
+
end
|
|
192
|
+
|
|
193
|
+
# Returns the object in the form of hash
|
|
194
|
+
# @return [Hash] Returns the object in the form of hash
|
|
195
|
+
def to_hash
|
|
196
|
+
hash = {}
|
|
197
|
+
self.class.attribute_map.each_pair do |attr, param|
|
|
198
|
+
value = self.send(attr)
|
|
199
|
+
next if value.nil?
|
|
200
|
+
hash[param] = _to_hash(value)
|
|
201
|
+
end
|
|
202
|
+
hash
|
|
203
|
+
end
|
|
204
|
+
|
|
205
|
+
# Outputs non-array value in the form of hash
|
|
206
|
+
# For object, use to_hash. Otherwise, just return the value
|
|
207
|
+
# @param [Object] value Any valid value
|
|
208
|
+
# @return [Hash] Returns the value in the form of hash
|
|
209
|
+
def _to_hash(value)
|
|
210
|
+
if value.is_a?(Array)
|
|
211
|
+
value.compact.map { |v| _to_hash(v) }
|
|
212
|
+
elsif value.is_a?(Hash)
|
|
213
|
+
{}.tap do |hash|
|
|
214
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
|
215
|
+
end
|
|
216
|
+
elsif value.respond_to? :to_hash
|
|
217
|
+
value.to_hash
|
|
218
|
+
else
|
|
219
|
+
value
|
|
220
|
+
end
|
|
221
|
+
end
|
|
222
|
+
|
|
223
|
+
end
|
|
224
|
+
end
|
|
@@ -329,8 +329,12 @@ module UltracartClient
|
|
|
329
329
|
return false if !@merchant_id.nil? && @merchant_id.to_s.length > 5
|
|
330
330
|
return false if !@name.nil? && @name.to_s.length > 50
|
|
331
331
|
return false if !@no_agent_available_play_audio_uuid.nil? && @no_agent_available_play_audio_uuid.to_s.length > 50
|
|
332
|
+
no_agent_available_say_voice_validator = EnumAttributeValidator.new('String', ['man', 'woman'])
|
|
333
|
+
return false unless no_agent_available_say_voice_validator.valid?(@no_agent_available_say_voice)
|
|
332
334
|
return false if !@no_agent_available_say_voice.nil? && @no_agent_available_say_voice.to_s.length > 50
|
|
333
335
|
return false if !@play_audio_uuid.nil? && @play_audio_uuid.to_s.length > 50
|
|
336
|
+
say_voice_validator = EnumAttributeValidator.new('String', ['man', 'woman'])
|
|
337
|
+
return false unless say_voice_validator.valid?(@say_voice)
|
|
334
338
|
return false if !@say_voice.nil? && @say_voice.to_s.length > 50
|
|
335
339
|
return false if !@twilio_taskrouter_workflow_sid.nil? && @twilio_taskrouter_workflow_sid.to_s.length > 100
|
|
336
340
|
return false if !@twilio_workspace_queue_sid.nil? && @twilio_workspace_queue_sid.to_s.length > 50
|
|
@@ -397,13 +401,13 @@ module UltracartClient
|
|
|
397
401
|
@no_agent_available_play_audio_uuid = no_agent_available_play_audio_uuid
|
|
398
402
|
end
|
|
399
403
|
|
|
400
|
-
# Custom attribute writer method
|
|
401
|
-
# @param [Object] no_agent_available_say_voice
|
|
404
|
+
# Custom attribute writer method checking allowed values (enum).
|
|
405
|
+
# @param [Object] no_agent_available_say_voice Object to be assigned
|
|
402
406
|
def no_agent_available_say_voice=(no_agent_available_say_voice)
|
|
403
|
-
|
|
404
|
-
|
|
407
|
+
validator = EnumAttributeValidator.new('String', ['man', 'woman'])
|
|
408
|
+
unless validator.valid?(no_agent_available_say_voice)
|
|
409
|
+
fail ArgumentError, 'invalid value for "no_agent_available_say_voice", must be one of #{validator.allowable_values}.'
|
|
405
410
|
end
|
|
406
|
-
|
|
407
411
|
@no_agent_available_say_voice = no_agent_available_say_voice
|
|
408
412
|
end
|
|
409
413
|
|
|
@@ -417,13 +421,13 @@ module UltracartClient
|
|
|
417
421
|
@play_audio_uuid = play_audio_uuid
|
|
418
422
|
end
|
|
419
423
|
|
|
420
|
-
# Custom attribute writer method
|
|
421
|
-
# @param [Object] say_voice
|
|
424
|
+
# Custom attribute writer method checking allowed values (enum).
|
|
425
|
+
# @param [Object] say_voice Object to be assigned
|
|
422
426
|
def say_voice=(say_voice)
|
|
423
|
-
|
|
424
|
-
|
|
427
|
+
validator = EnumAttributeValidator.new('String', ['man', 'woman'])
|
|
428
|
+
unless validator.valid?(say_voice)
|
|
429
|
+
fail ArgumentError, 'invalid value for "say_voice", must be one of #{validator.allowable_values}.'
|
|
425
430
|
end
|
|
426
|
-
|
|
427
431
|
@say_voice = say_voice
|
|
428
432
|
end
|
|
429
433
|
|
|
@@ -16,6 +16,8 @@ module UltracartClient
|
|
|
16
16
|
class Twilio
|
|
17
17
|
attr_accessor :account_sid
|
|
18
18
|
|
|
19
|
+
attr_accessor :ai_twiml_app_sid
|
|
20
|
+
|
|
19
21
|
attr_accessor :api_key_id
|
|
20
22
|
|
|
21
23
|
attr_accessor :api_key_name
|
|
@@ -36,6 +38,7 @@ module UltracartClient
|
|
|
36
38
|
def self.attribute_map
|
|
37
39
|
{
|
|
38
40
|
:'account_sid' => :'account_sid',
|
|
41
|
+
:'ai_twiml_app_sid' => :'ai_twiml_app_sid',
|
|
39
42
|
:'api_key_id' => :'api_key_id',
|
|
40
43
|
:'api_key_name' => :'api_key_name',
|
|
41
44
|
:'auth_token' => :'auth_token',
|
|
@@ -51,6 +54,7 @@ module UltracartClient
|
|
|
51
54
|
def self.swagger_types
|
|
52
55
|
{
|
|
53
56
|
:'account_sid' => :'String',
|
|
57
|
+
:'ai_twiml_app_sid' => :'String',
|
|
54
58
|
:'api_key_id' => :'String',
|
|
55
59
|
:'api_key_name' => :'String',
|
|
56
60
|
:'auth_token' => :'String',
|
|
@@ -74,6 +78,10 @@ module UltracartClient
|
|
|
74
78
|
self.account_sid = attributes[:'account_sid']
|
|
75
79
|
end
|
|
76
80
|
|
|
81
|
+
if attributes.has_key?(:'ai_twiml_app_sid')
|
|
82
|
+
self.ai_twiml_app_sid = attributes[:'ai_twiml_app_sid']
|
|
83
|
+
end
|
|
84
|
+
|
|
77
85
|
if attributes.has_key?(:'api_key_id')
|
|
78
86
|
self.api_key_id = attributes[:'api_key_id']
|
|
79
87
|
end
|
|
@@ -128,6 +136,7 @@ module UltracartClient
|
|
|
128
136
|
return true if self.equal?(o)
|
|
129
137
|
self.class == o.class &&
|
|
130
138
|
account_sid == o.account_sid &&
|
|
139
|
+
ai_twiml_app_sid == o.ai_twiml_app_sid &&
|
|
131
140
|
api_key_id == o.api_key_id &&
|
|
132
141
|
api_key_name == o.api_key_name &&
|
|
133
142
|
auth_token == o.auth_token &&
|
|
@@ -147,7 +156,7 @@ module UltracartClient
|
|
|
147
156
|
# Calculates hash code according to all attributes.
|
|
148
157
|
# @return [Fixnum] Hash code
|
|
149
158
|
def hash
|
|
150
|
-
[account_sid, api_key_id, api_key_name, auth_token, esp_twilio_uuid, inbound_twiml_app_sid, outbound_twiml_app_sid, phone_numbers, twilio_workspace_sid].hash
|
|
159
|
+
[account_sid, ai_twiml_app_sid, api_key_id, api_key_name, auth_token, esp_twilio_uuid, inbound_twiml_app_sid, outbound_twiml_app_sid, phone_numbers, twilio_workspace_sid].hash
|
|
151
160
|
end
|
|
152
161
|
|
|
153
162
|
# Builds the object from hash
|
data/lib/ultracart_api.rb
CHANGED
|
@@ -232,6 +232,11 @@ require 'ultracart_api/models/conversation_pbx_call_timeline'
|
|
|
232
232
|
require 'ultracart_api/models/conversation_pbx_call_transcript'
|
|
233
233
|
require 'ultracart_api/models/conversation_pbx_call_transcript_segment'
|
|
234
234
|
require 'ultracart_api/models/conversation_pbx_call_transfer'
|
|
235
|
+
require 'ultracart_api/models/conversation_pbx_class_of_service'
|
|
236
|
+
require 'ultracart_api/models/conversation_pbx_class_of_service_response'
|
|
237
|
+
require 'ultracart_api/models/conversation_pbx_class_of_services_response'
|
|
238
|
+
require 'ultracart_api/models/conversation_pbx_cos_audit_log'
|
|
239
|
+
require 'ultracart_api/models/conversation_pbx_cos_audit_logs_response'
|
|
235
240
|
require 'ultracart_api/models/conversation_pbx_customer_snapshot_request'
|
|
236
241
|
require 'ultracart_api/models/conversation_pbx_customer_snapshot_response'
|
|
237
242
|
require 'ultracart_api/models/conversation_pbx_hardware_phone'
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: ultracart_api
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 3.11.
|
|
4
|
+
version: 3.11.57
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- UltraCart
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2026-02-
|
|
11
|
+
date: 2026-02-03 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: typhoeus
|
|
@@ -441,6 +441,11 @@ files:
|
|
|
441
441
|
- docs/ConversationPbxCallTranscript.md
|
|
442
442
|
- docs/ConversationPbxCallTranscriptSegment.md
|
|
443
443
|
- docs/ConversationPbxCallTransfer.md
|
|
444
|
+
- docs/ConversationPbxClassOfService.md
|
|
445
|
+
- docs/ConversationPbxClassOfServiceResponse.md
|
|
446
|
+
- docs/ConversationPbxClassOfServicesResponse.md
|
|
447
|
+
- docs/ConversationPbxCosAuditLog.md
|
|
448
|
+
- docs/ConversationPbxCosAuditLogsResponse.md
|
|
444
449
|
- docs/ConversationPbxCustomerSnapshotRequest.md
|
|
445
450
|
- docs/ConversationPbxCustomerSnapshotResponse.md
|
|
446
451
|
- docs/ConversationPbxHardwarePhone.md
|
|
@@ -1420,6 +1425,11 @@ files:
|
|
|
1420
1425
|
- lib/ultracart_api/models/conversation_pbx_call_transcript.rb
|
|
1421
1426
|
- lib/ultracart_api/models/conversation_pbx_call_transcript_segment.rb
|
|
1422
1427
|
- lib/ultracart_api/models/conversation_pbx_call_transfer.rb
|
|
1428
|
+
- lib/ultracart_api/models/conversation_pbx_class_of_service.rb
|
|
1429
|
+
- lib/ultracart_api/models/conversation_pbx_class_of_service_response.rb
|
|
1430
|
+
- lib/ultracart_api/models/conversation_pbx_class_of_services_response.rb
|
|
1431
|
+
- lib/ultracart_api/models/conversation_pbx_cos_audit_log.rb
|
|
1432
|
+
- lib/ultracart_api/models/conversation_pbx_cos_audit_logs_response.rb
|
|
1423
1433
|
- lib/ultracart_api/models/conversation_pbx_customer_snapshot_request.rb
|
|
1424
1434
|
- lib/ultracart_api/models/conversation_pbx_customer_snapshot_response.rb
|
|
1425
1435
|
- lib/ultracart_api/models/conversation_pbx_hardware_phone.rb
|